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

Last change on this file since 579 was 579, checked in by Kris Deugau, 12 years ago

/trunk

Pull back a little on making the VRF a key field; it's not yet
clear how the UI should present the restriction:

-> make VRF a layer above the master blocks?
-> present the VRF as a part of the master?
-> only use VRF as a key on private-net blocks? (pretty sane,

public IP space may lie in different VRFs but actually
allocating the same public IP in more than one VRF makes no
sense I can see)

-> ???
  • Property svn:keywords set to Date Rev Author
File size: 51.3 KB
RevLine 
[8]1# ipdb/cgi-bin/IPDB.pm
[66]2# Contains functions for IPDB - database access, subnet mangling, block allocation, etc
[8]3###
4# SVN revision info
5# $Date: 2012-12-28 21:52:45 +0000 (Fri, 28 Dec 2012) $
6# SVN revision $Rev: 579 $
7# Last update by $Author: kdeugau $
8###
[417]9# Copyright (C) 2004-2010 - Kris Deugau
[8]10
[4]11package IPDB;
12
13use strict;
14use warnings;
15use Exporter;
[77]16use DBI;
[66]17use Net::SMTP;
[573]18use NetAddr::IP qw(:lower Compact );
[68]19use POSIX;
[4]20use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
21
[417]22$VERSION = 2; ##VERSION##
[4]23@ISA = qw(Exporter);
[106]24@EXPORT_OK = qw(
[541]25 %disp_alloctypes %list_alloctypes %def_custids @citylist @poplist
26 %IPDBacl %aclmsg
[523]27 &initIPDBGlobals &connectDB &finish &checkDBSanity
[547]28 &addMaster &touchMaster
[561]29 &listSummary &listSubs &listFree &listPool
[541]30 &getMasterList &getTypeList &getPoolSelect &findAllocateFrom
[536]31 &ipParent &subParent &blockParent &getRoutedCity
[531]32 &allocateBlock &updateBlock &deleteBlock &getBlockData
[530]33 &getNodeList &getNodeName &getNodeInfo
[519]34 &mailNotify
[106]35 );
[4]36
37@EXPORT = (); # Export nothing by default.
[106]38%EXPORT_TAGS = ( ALL => [qw(
[167]39 %disp_alloctypes %list_alloctypes %def_custids @citylist @poplist
[541]40 %IPDBacl %aclmsg
[523]41 &initIPDBGlobals &connectDB &finish &checkDBSanity
[547]42 &addMaster &touchMaster
[561]43 &listSummary &listSubs &listFree &listPool
[541]44 &getMasterList &getTypeList &getPoolSelect &findAllocateFrom
[536]45 &ipParent &subParent &blockParent &getRoutedCity
[531]46 &allocateBlock &updateBlock &deleteBlock &getBlockData
[530]47 &getNodeList &getNodeName &getNodeInfo
[519]48 &mailNotify
[106]49 )]
50 );
[4]51
[77]52##
53## Global variables
54##
55our %disp_alloctypes;
56our %list_alloctypes;
[167]57our %def_custids;
[96]58our @citylist;
59our @poplist;
[233]60our %IPDBacl;
[66]61
[517]62# mapping table for functional-area => error message
63our %aclmsg = (
64 addmaster => 'add a master block',
65 addblock => 'add an allocation',
66 updateblock => 'update a block',
67 delblock => 'delete an allocation',
68 );
69
[417]70our $org_name = 'Example Corp';
[416]71our $smtphost = 'smtp.example.com';
72our $domain = 'example.com';
[417]73our $defcustid = '5554242';
74# mostly for rwhois
75##fixme: leave these blank by default?
[420]76our $rwhoisDataPath = '/usr/local/rwhoisd/etc/rwhoisd'; # to match ./configure defaults from rwhoisd-1.5.9.6
[417]77our $org_street = '123 4th Street';
78our $org_city = 'Anytown';
79our $org_prov_state = 'ON';
80our $org_pocode = 'H0H 0H0';
81our $org_country = 'CA';
82our $org_phone = '000-555-1234';
83our $org_techhandle = 'ISP-ARIN-HANDLE';
[434]84our $org_email = 'noc@example.com';
[437]85our $hostmaster = 'dns@example.com';
[416]86
[417]87our $syslog_facility = 'local2';
88
[77]89# Let's initialize the globals.
90## IPDB::initIPDBGlobals()
91# Initialize all globals. Takes a database handle, returns a success or error code
92sub initIPDBGlobals {
93 my $dbh = $_[0];
94 my $sth;
95
[106]96 # Initialize alloctypes hashes
[167]97 $sth = $dbh->prepare("select type,listname,dispname,listorder,def_custid from alloctypes order by listorder");
[77]98 $sth->execute;
99 while (my @data = $sth->fetchrow_array) {
[106]100 $disp_alloctypes{$data[0]} = $data[2];
[167]101 $def_custids{$data[0]} = $data[4];
[106]102 if ($data[3] < 900) {
103 $list_alloctypes{$data[0]} = $data[1];
104 }
[77]105 }
[96]106
107 # City and POP listings
[157]108 $sth = $dbh->prepare("select city,routing from cities order by city");
[96]109 $sth->execute;
110 return (undef,$sth->errstr) if $sth->err;
111 while (my @data = $sth->fetchrow_array) {
[106]112 push @citylist, $data[0];
[96]113 if ($data[1] eq 'y') {
[106]114 push @poplist, $data[0];
[96]115 }
116 }
117
[233]118 # Load ACL data. Specific username checks are done at a different level.
119 $sth = $dbh->prepare("select username,acl from users");
120 $sth->execute;
[106]121 return (undef,$sth->errstr) if $sth->err;
[233]122 while (my @data = $sth->fetchrow_array) {
123 $IPDBacl{$data[0]} = $data[1];
124 }
[106]125
[517]126##fixme: initialize HTML::Template env var for template path
127# something like $self->path().'/templates' ?
128# $ENV{HTML_TEMPLATE_ROOT} = 'foo/bar';
129
[77]130 return (1,"OK");
131} # end initIPDBGlobals
132
133
134## IPDB::connectDB()
[4]135# Creates connection to IPDB.
[77]136# Requires the database name, username, and password.
[4]137# Returns a handle to the db.
[77]138# Set up for a PostgreSQL db; could be any transactional DBMS with the
139# right changes.
[4]140sub connectDB {
[432]141 my $dbname = shift;
142 my $user = shift;
143 my $pass = shift;
144 my $dbhost = shift;
145
[4]146 my $dbh;
[432]147 my $DSN = "DBI:Pg:".($dbhost ? "host=$dbhost;" : '')."dbname=$dbname";
[4]148
149# Note that we want to autocommit by default, and we will turn it off locally as necessary.
[77]150# We may not want to print gobbledygook errors; YMMV. Have to ponder that further.
151 $dbh = DBI->connect($DSN, $user, $pass, {
152 AutoCommit => 1,
153 PrintError => 0
154 })
155 or return (undef, $DBI::errstr) if(!$dbh);
[4]156
[77]157# Return here if we can't select. Note that this indicates a
158# problem executing the select.
[183]159 my $sth = $dbh->prepare("select type from alloctypes");
[77]160 $sth->execute();
161 return (undef,$DBI::errstr) if ($sth->err);
162
163# See if the select returned anything (or null data). This should
164# succeed if the select executed, but...
165 $sth->fetchrow();
166 return (undef,$DBI::errstr) if ($sth->err);
167
168# If we get here, we should be OK.
169 return ($dbh,"DB connection OK");
[4]170} # end connectDB
171
[77]172
173## IPDB::finish()
174# Cleans up after database handles and so on.
175# Requires a database handle
176sub finish {
177 my $dbh = $_[0];
[517]178 $dbh->disconnect if $dbh;
[77]179} # end finish
180
181
[106]182## IPDB::checkDBSanity()
[4]183# Quick check to see if the db is responding. A full integrity
184# check will have to be a separate tool to walk the IP allocation trees.
185sub checkDBSanity {
[106]186 my ($dbh) = $_[0];
[4]187
188 if (!$dbh) {
[106]189 print "No database handle, or connection has been closed.";
190 return -1;
[4]191 } else {
192 # it connects, try a stmt.
[184]193 my $sth = $dbh->prepare("select type from alloctypes");
[4]194 my $err = $sth->execute();
195
196 if ($sth->fetchrow()) {
197 # all is well.
198 return 1;
199 } else {
[16]200 print "Connected to the database, but could not execute test statement. ".$sth->errstr();
[106]201 return -1;
[4]202 }
203 }
204 # Clean up after ourselves.
[106]205# $dbh->disconnect;
[4]206} # end checkDBSanity
207
[66]208
[371]209## IPDB::addMaster()
210# Does all the magic necessary to sucessfully add a master block
211# Requires database handle, block to add
212# Returns failure code and error message or success code and "message"
213sub addMaster {
214 my $dbh = shift;
215 my $cidr = new NetAddr::IP shift;
216
217 # Allow transactions, and raise an exception on errors so we can catch it later.
218 # Use local to make sure these get "reset" properly on exiting this block
219 local $dbh->{AutoCommit} = 0;
220 local $dbh->{RaiseError} = 1;
221
222 # Wrap all the SQL in a transaction
223 eval {
[518]224 my ($mexist) = $dbh->selectrow_array("SELECT cidr FROM masterblocks WHERE cidr <<= ?", undef, ($cidr) );
[371]225
[518]226 if (!$mexist) {
[371]227 # First case - master is brand-spanking-new.
228##fixme: rwhois should be globally-flagable somewhere, much like a number of other things
229## maybe a db table called "config"?
[518]230 $dbh->do("INSERT INTO masterblocks (cidr,rwhois) VALUES (?,?)", undef, ($cidr,'y') );
[371]231
232# Unrouted blocks aren't associated with a city (yet). We don't rely on this
233# elsewhere though; legacy data may have traps and pitfalls in it to break this.
234# Thus the "routed" flag.
[556]235 $dbh->do("INSERT INTO freeblocks (cidr,maskbits,city,routed,parent,rdepth) VALUES (?,?,?,?,?,?)", undef,
236 ($cidr, $cidr->masklen, '<NULL>', 'm', $cidr, 1) );
[371]237
238 # If we get here, everything is happy. Commit changes.
239 $dbh->commit;
240
[518]241 } # done new master does not contain existing master(s)
[371]242 else {
243
244 # collect the master(s) we're going to absorb, and snag the longest netmask while we're at it.
245 my $smallmask = $cidr->masklen;
[518]246 my $sth = $dbh->prepare("SELECT cidr FROM masterblocks WHERE cidr <<= ?");
247 $sth->execute($cidr);
[371]248 my @cmasters;
249 while (my @data = $sth->fetchrow_array) {
250 my $master = new NetAddr::IP $data[0];
251 push @cmasters, $master;
252 $smallmask = $master->masklen if $master->masklen > $smallmask;
253 }
254
255 # split the new master, and keep only those blocks not part of an existing master
256 my @blocklist;
257 foreach my $seg ($cidr->split($smallmask)) {
258 my $contained = 0;
259 foreach my $master (@cmasters) {
260 $contained = 1 if $master->contains($seg);
261 }
262 push @blocklist, $seg if !$contained;
263 }
264
265 # collect the unrouted free blocks within the new master
[556]266 $sth = $dbh->prepare("SELECT cidr FROM freeblocks WHERE masklen(cidr) <= ? AND cidr <<= ? AND routed = 'm'");
[518]267 $sth->execute($smallmask, $cidr);
[371]268 while (my @data = $sth->fetchrow_array) {
269 my $freeblock = new NetAddr::IP $data[0];
270 push @blocklist, $freeblock;
271 }
272
273 # combine the set of free blocks we should have now.
274 @blocklist = Compact(@blocklist);
275
276 # and now insert the new data. Make sure to delete old masters too.
277
278 # freeblocks
[518]279 $sth = $dbh->prepare("DELETE FROM freeblocks WHERE cidr <<= ?");
[556]280 my $sth2 = $dbh->prepare("INSERT INTO freeblocks (cidr,maskbits,city,routed,parent,rdepth)".
281 " VALUES (?,?,'<NULL>','m',?,1)");
[371]282 foreach my $newblock (@blocklist) {
[518]283 $sth->execute($newblock);
[556]284 $sth2->execute($newblock, $newblock->masklen, $cidr);
[371]285 }
286
[556]287 # update parent relations at rdepth=1
288 $dbh->do("UPDATE allocations SET parent = ? WHERE parent << ? AND rdepth=1", undef, ($cidr, $cidr) );
289 $dbh->do("UPDATE freeblocks SET parent = ? WHERE parent << ? AND rdepth=1", undef, ($cidr, $cidr) );
290
[371]291 # master
[518]292 $dbh->do("DELETE FROM masterblocks WHERE cidr <<= ?", undef, ($cidr) );
293 $dbh->do("INSERT INTO masterblocks (cidr,rwhois) VALUES (?,?)", undef, ($cidr, 'y') );
[371]294
295 # *whew* If we got here, we likely suceeded.
296 $dbh->commit;
297 } # new master contained existing master(s)
298 }; # end eval
299
300 if ($@) {
301 my $msg = $@;
302 eval { $dbh->rollback; };
303 return ('FAIL',$msg);
304 } else {
305 return ('OK','OK');
306 }
307} # end addMaster
308
309
[547]310## IPDB::touchMaster()
311# Update last-changed timestamp on a master block.
312sub touchMaster {
313 my $dbh = shift;
314 my $master = shift;
315
316 local $dbh->{AutoCommit} = 0;
317 local $dbh->{RaiseError} = 1;
318
319 eval {
320 $dbh->do("UPDATE masterblocks SET mtime=now() WHERE cidr = ?", undef, ($master));
321 $dbh->commit;
322 };
323
324 if ($@) {
325 my $msg = $@;
326 eval { $dbh->rollback; };
327 return ('FAIL',$msg);
328 }
329 return ('OK','OK');
330} # end touchMaster()
331
332
[523]333## IPDB::listSummary()
334# Get summary list of all master blocks
335# Returns an arrayref to a list of hashrefs containing the master block, routed count,
336# allocated count, free count, and largest free block masklength
337sub listSummary {
338 my $dbh = shift;
339
340 my $mlist = $dbh->selectall_arrayref("SELECT cidr AS master FROM masterblocks ORDER BY cidr", { Slice => {} });
341
342 foreach (@{$mlist}) {
[560]343 my ($rcnt) = $dbh->selectrow_array("SELECT count(*) FROM allocations WHERE cidr <<= ? AND type='rm'",
344 undef, ($$_{master}));
[523]345 $$_{routed} = $rcnt;
[560]346 my ($acnt) = $dbh->selectrow_array("SELECT count(*) FROM allocations WHERE cidr <<= ? AND NOT type='rm'",
347 undef, ($$_{master}));
[523]348 $$_{allocated} = $acnt;
[560]349 my ($fcnt) = $dbh->selectrow_array("SELECT count(*) FROM freeblocks WHERE cidr <<= ?",
350 undef, ($$_{master}));
[523]351 $$_{free} = $fcnt;
[560]352 my ($bigfree) = $dbh->selectrow_array("SELECT masklen(cidr) AS maskbits FROM freeblocks WHERE cidr <<= ?".
353 " AND parent = ? ORDER BY masklen(cidr) LIMIT 1", undef, ($$_{master}, $$_{master}));
[523]354##fixme: should find a way to do this without having to HTMLize the <>
355 $bigfree = "/$bigfree" if $bigfree;
[525]356 $bigfree = '<NONE>' if !$bigfree;
[523]357 $$_{bigfree} = $bigfree;
358 }
359 return $mlist;
360} # end listSummary()
361
362
[561]363## IPDB::listSubs()
364# Get list of subnets within a specified CIDR block, on a specified VRF.
365# Returns an arrayref to a list of hashrefs containing the CIDR block, customer location or
366# city it's routed to, block type, SWIP status, and description
367sub listSubs {
368 my $dbh = shift;
369 my %args = @_;
370
371 # Just In Case
372 $args{vrf} = '' if !$args{vrf};
373 $args{rdepth} = 1 if !$args{rdepth};
374
375 # Snag the allocations for this block
376 my $sth = $dbh->prepare("SELECT cidr,city,type,custid,swip,description".
377 " FROM allocations WHERE parent = ? AND rdepth = ? ORDER BY cidr");
378 $sth->execute($args{block},$args{rdepth});
379
380 # hack hack hack
381 # set up to flag swip=y records if they don't actually have supporting data in the customers table
382 my $custsth = $dbh->prepare("SELECT count(*) FROM customers WHERE custid = ?");
383
384 my @blocklist;
385 while (my ($cidr,$city,$type,$custid,$swip,$desc) = $sth->fetchrow_array()) {
386 $custsth->execute($custid);
387 my ($ncust) = $custsth->fetchrow_array();
388 my %row = (
389 block => $cidr,
390 city => $city,
391 type => $disp_alloctypes{$type},
392 custid => $custid,
393 swip => ($swip eq 'y' ? 'Yes' : 'No'),
394 partswip => ($swip eq 'y' && $ncust == 0 ? 1 : 0),
395 desc => $desc,
396 hassubs => ($type eq 'rm' || $type =~ /.c/ ? 1 : 0),
397 );
398# $row{subblock} = ($type =~ /^.r$/); # hmf. wonder why these won't work in the hash declaration...
399 $row{listpool} = ($type =~ /^.[pd]$/);
400 push (@blocklist, \%row);
401 }
402 return \@blocklist;
403} # end listSubs()
404
405
[524]406## IPDB::listMaster()
407# Get list of routed blocks in the requested master
408# Returns an arrayref to a list of hashrefs containing the routed block, POP/city the block is routed to,
409# allocated count, free count, and largest free block masklength
410sub listMaster {
411 my $dbh = shift;
412 my $master = shift;
[523]413
[524]414 my $rlist = $dbh->selectall_arrayref("SELECT cidr AS block,city FROM routed WHERE cidr <<= ? ORDER BY cidr",
415 { Slice => {} }, ($master) );
[523]416
[524]417 foreach (@{$rlist}) {
418 my ($acnt) = $dbh->selectrow_array("SELECT count(*) FROM allocations WHERE cidr <<= ?", undef, ($$_{block}));
419 $$_{nsubs} = $acnt;
420 my ($fcnt) = $dbh->selectrow_array("SELECT count(*) FROM freeblocks WHERE cidr <<= ?".
421 " AND (routed='y' OR routed='n')", undef, ($$_{block}));
422 $$_{nfree} = $fcnt;
423 my ($bigfree) = $dbh->selectrow_array("SELECT maskbits FROM freeblocks WHERE cidr <<= ?".
424 " AND (routed='y' OR routed='n') ORDER BY maskbits LIMIT 1", undef, ($$_{block}));
425##fixme: should find a way to do this without having to HTMLize the <>
426 $bigfree = "/$bigfree" if $bigfree;
[525]427 $bigfree = '<NONE>' if !$bigfree;
[524]428 $$_{lfree} = $bigfree;
429 }
430 return $rlist;
431} # end listMaster()
432
433
[527]434## IPDB::listRBlock()
435# Gets a list of free blocks in the requested parent/master in both CIDR and range notation
436# Takes a parent/master and an optional flag to look at routed or unrouted blocks, depending
437# on whether the master is a direct master or a routed block
438# Returns an arrayref to a list of hashrefs containing the CIDR and range-notation blocks
439sub listRBlock {
440 my $dbh = shift;
441 my $routed = shift;
[524]442
[527]443 # Snag the allocations for this block
444 my $sth = $dbh->prepare("SELECT cidr,city,type,custid,swip,description".
445 " FROM allocations WHERE cidr <<= ? ORDER BY cidr");
446 $sth->execute($routed);
[524]447
[527]448 # hack hack hack
449 # set up to flag swip=y records if they don't actually have supporting data in the customers table
450 my $custsth = $dbh->prepare("SELECT count(*) FROM customers WHERE custid = ?");
451
452 my @blocklist;
453 while (my ($cidr,$city,$type,$custid,$swip,$desc) = $sth->fetchrow_array()) {
454 $custsth->execute($custid);
455 my ($ncust) = $custsth->fetchrow_array();
456 my %row = (
457 block => $cidr,
458 city => $city,
459 type => $disp_alloctypes{$type},
460 custid => $custid,
461 swip => ($swip eq 'y' ? 'Yes' : 'No'),
462 partswip => ($swip eq 'y' && $ncust == 0 ? 1 : 0),
463 desc => $desc
464 );
465 $row{subblock} = ($type =~ /^.r$/); # hmf. wonder why these won't work in the hash declaration...
466 $row{listpool} = ($type =~ /^.[pd]$/);
467 push (@blocklist, \%row);
468 }
469 return \@blocklist;
470} # end listRBlock()
471
472
[524]473## IPDB::listFree()
[562]474# Gets a list of free blocks in the requested parent/master and VRF instance in both CIDR and range notation
475# Takes a parent/master and an optional VRF specifier that defaults to empty.
[524]476# Returns an arrayref to a list of hashrefs containing the CIDR and range-notation blocks
[527]477# Returns some extra flags in the hashrefs for routed blocks, since those can have several subtypes
[524]478sub listFree {
479 my $dbh = shift;
480
[562]481 my %args = @_;
482 # Just In Case
483 $args{vrf} = '' if !$args{vrf};
484 $args{rdepth} = 1 if !$args{rdepth};
485
[524]486 # do it this way so we can waste a little less time iterating
[579]487# my $sth = $dbh->prepare("SELECT cidr FROM freeblocks WHERE parent = ? AND rdepth = ? AND vrf = ? ".
488 my $sth = $dbh->prepare("SELECT cidr FROM freeblocks WHERE parent = ? AND rdepth = ? ".
[562]489 "ORDER BY cidr");
[579]490# $sth->execute($args{master}, $args{rdepth}, $args{vrf});
491 $sth->execute($args{master}, $args{rdepth});
[524]492 my @flist;
[562]493 while (my ($cidr) = $sth->fetchrow_array()) {
[524]494 $cidr = new NetAddr::IP $cidr;
[527]495 my %row = (
496 fblock => "$cidr",
497 frange => $cidr->range,
498 );
[524]499 push @flist, \%row;
500 }
501 return \@flist;
[527]502} # end listFree()
[524]503
504
[528]505## IPDB::listPool()
506#
507sub listPool {
508 my $dbh = shift;
509 my $pool = shift;
510
[563]511 my $sth = $dbh->prepare("SELECT ip,custid,available,description,type,rdepth".
[528]512 " FROM poolips WHERE pool = ? ORDER BY ip");
513 $sth->execute($pool);
514 my @poolips;
[563]515 while (my ($ip,$custid,$available,$desc,$type,$rdepth) = $sth->fetchrow_array) {
[528]516 my %row = (
517 ip => $ip,
518 custid => $custid,
519 available => $available,
520 desc => $desc,
[563]521 delme => $available eq 'n',
522 ipdepth => $rdepth,
[528]523 );
524 push @poolips, \%row;
525 }
526 return \@poolips;
527} # end listPool()
528
529
[541]530## IPDB::getMasterList()
531# Get a list of master blocks, optionally including last-modified timestamps
532# Takes an optional flag to indicate whether to include timestamps;
533# 'm' includes ctime, all others (suggest 'c') do not.
534# Returns an arrayref to a list of hashrefs
535sub getMasterList {
536 my $dbh = shift;
537 my $stampme = shift || 'm'; # optional but should be set by caller for clarity
538
539 my $mlist = $dbh->selectall_arrayref("SELECT cidr AS master".($stampme eq 'm' ? ',mtime' : '').
540 " FROM masterblocks ORDER BY cidr", { Slice => {} });
541 return $mlist;
542} # end getMasterList()
543
544
[529]545## IPDB::getTypeList()
546# Get an alloctype/description pair list suitable for dropdowns
547# Takes a flag to determine which general groups of types are returned
548# Returns an reference to an array of hashrefs
549sub getTypeList {
550 my $dbh = shift;
551 my $tgroup = shift || 'a'; # technically optional, like this, but should
552 # really be specified in the call for clarity
553 my $tlist;
[564]554 if ($tgroup eq 'n') {
555 # grouping 'p' - all netblock types. These include routed blocks, containers (_c)
556 # and contained (_r) types, dynamic-allocation ranges (_e), static IP pools (_d and _p),
557 # and the "miscellaneous" cn, in, and en types.
558 $tlist = $dbh->selectall_arrayref("SELECT type,listname FROM alloctypes WHERE listorder <= 500 ".
559 "AND type NOT LIKE '_i' ORDER BY listorder", { Slice => {} });
560 } elsif ($tgroup eq 'p') {
561 # grouping 'p' - primary allocation types. As with 'n' above but without the _r contained types.
562 $tlist = $dbh->selectall_arrayref("SELECT type,listname FROM alloctypes WHERE listorder <= 500 ".
[529]563 "AND type NOT LIKE '_i' AND type NOT LIKE '_r' ORDER BY listorder", { Slice => {} });
564 } elsif ($tgroup eq 'c') {
565 # grouping 'c' - contained types. These include all static IPs and all _r types.
566 $tlist = $dbh->selectall_arrayref("SELECT type,listname FROM alloctypes WHERE listorder <= 500 ".
567 " AND (type LIKE '_i' OR type LIKE '_r') ORDER BY listorder", { Slice => {} });
568 } else {
569 # grouping 'a' - all standard allocation types. This includes everything
570 # but mm (present only as a formality). Make this the default.
571 $tlist = $dbh->selectall_arrayref("SELECT type,listname FROM alloctypes WHERE listorder <= 500 ".
572 " ORDER BY listorder", { Slice => {} });
573 }
574 return $tlist;
575}
576
577
[532]578## IPDB::getPoolSelect()
579# Get a list of pools matching the passed city and type that have 1 or more free IPs
[533]580# Returns an arrayref to a list of hashrefs
[532]581sub getPoolSelect {
582 my $dbh = shift;
583 my $iptype = shift;
584 my $pcity = shift;
585
586 my ($ptype) = ($iptype =~ /^(.)i$/);
587 return if !$ptype;
588 $ptype .= '_';
589
590 my $plist = $dbh->selectall_arrayref(
[572]591 "SELECT count(*) AS poolfree,p.pool AS poolblock, a.city AS poolcit, a.rdepth AS poolrdepth ".
592 "FROM poolips p ".
593 "JOIN allocations a ON p.pool=a.cidr ".
594 "WHERE p.available='y' AND a.city = ? AND p.type LIKE ? ".
595 "GROUP BY p.pool,a.city,a.rdepth",
596 { Slice => {} }, ($pcity, $ptype) );
[532]597 return $plist;
598} # end getPoolSelect()
599
600
[533]601## IPDB::findAllocateFrom()
602# Find free block to add a new allocation from. (CIDR block version of pool select above, more or less)
603# Takes
604# - mask length
605# - allocation type
606# - POP city "parent"
607# - optional master-block restriction
608# - optional flag to allow automatic pick-from-private-network-ranges
609# Returns a string with the first CIDR block matching the criteria, if any
610sub findAllocateFrom {
611 my $dbh = shift;
612 my $maskbits = shift;
613 my $type = shift;
614 my $city = shift;
615 my $pop = shift;
616 my %optargs = @_;
617
618 my $failmsg = "No suitable free block found\n";
619
620## Set up the SQL to find out what freeblock we can (probably) use for an allocation.
621## Very large systems will require development of a reserve system (possibly an extension
622## of the reserve-for-expansion concept in https://secure.deepnet.cx/trac/ipdb/ticket/24?)
623## Also populate a value list for the DBI call.
624
[572]625 my @vallist = ($maskbits);
626 my $sql = "SELECT cidr,rdepth FROM freeblocks WHERE masklen(cidr) <= ?";
[533]627
[572]628# cases, strict rules
629# .c -> container type
630# requires a routing container, fbtype r
631# .d -> DHCP/"normal-routing" static pool
632# requires a routing container, fbtype r
633# .e -> Dynamic-assignment connectivity
634# requires a routing container, fbtype r
635# .i -> error, can't allocate static IPs this way?
636# mm -> error, master block
637# rm -> routed block
638# requires master block, fbtype m
639# .n -> Miscellaneous usage
640# requires a routing container, fbtype r
641# .p -> PPP(oE) static pool
642# requires a routing container, fbtype r
643# .r -> contained type
644# requires a matching container, fbtype $1
645##fixme: strict-or-not flag
646
647 if ($type =~ /^(.)r$/) {
648 push @vallist, $1;
649 $sql .= " AND routed = ?";
650 } elsif ($type eq 'rm') {
651 $sql .= " AND routed = 'm'";
652 } else {
653 $sql .= " AND routed = 'r'";
654 }
655
[533]656 # for PPP(oE) and container types, the POP city is the one attached to the pool.
657 # individual allocations get listed with the customer city site.
658 ##fixme: chain cities to align roughly with a full layer-2 node graph
659 $city = $pop if $type !~ /^.[pc]$/;
[544]660 if ($type ne 'rm' && $city) {
[533]661 $sql .= " AND city = ?";
662 push @vallist, $city;
663 }
[544]664 # Allow specifying an arbitrary full block, instead of a master
665 if ($optargs{gimme}) {
666 $sql .= " AND cidr >>= ?";
667 push @vallist, $optargs{gimme};
668 }
[533]669 # if a specific master was requested, allow the requestor to self->shoot(foot)
670 if ($optargs{master} && $optargs{master} ne '-') {
671 $sql .= " AND cidr <<= ?" if $optargs{master} ne '-';
672 push @vallist, $optargs{master};
673 } else {
674 # if a specific master was NOT requested, filter out the RFC 1918 private networks
675 if (!$optargs{allowpriv}) {
676 $sql .= " AND NOT (cidr <<= '192.168.0.0/16' OR cidr <<= '10.0.0.0/8' OR cidr <<= '172.16.0.0/12')";
677 }
678 }
679 # Sorting and limiting, since we don't (currently) care to provide a selection of
680 # blocks to carve up. This preserves something resembling optimal usage of the IP
681 # space by forcing contiguous allocations and free blocks as much as possible.
682 $sql .= " ORDER BY maskbits DESC,cidr LIMIT 1";
683
[572]684 my ($fbfound,$fbdepth) = $dbh->selectrow_array($sql, undef, @vallist);
685 return $fbfound,$fbdepth;
[533]686} # end findAllocateFrom()
687
688
[536]689## IPDB::ipParent()
690# Get an IP's parent pool's details
691# Takes a database handle and IP
692# Returns a hashref to the parent pool block, if any
693sub ipParent {
694 my $dbh = shift;
695 my $block = shift;
696
697 my $pinfo = $dbh->selectrow_hashref("SELECT cidr,custid,type,city,description FROM allocations".
[565]698 " WHERE cidr >>= ? AND (type LIKE '_p' OR type LIKE '_d')", undef, ($block) );
[536]699 return $pinfo;
700} # end ipParent()
701
702
703## IPDB::subParent()
[529]704# Get a block's parent's details
705# Takes a database handle and CIDR block
[536]706# Returns a hashref to the parent container block, if any
707sub subParent {
[529]708 my $dbh = shift;
709 my $block = shift;
710
711 my $pinfo = $dbh->selectrow_hashref("SELECT cidr,custid,type,city,description FROM allocations".
712 " WHERE cidr >>= ?", undef, ($block) );
713 return $pinfo;
[536]714} # end subParent()
[529]715
716
[536]717## IPDB::blockParent()
718# Get a block's parent's details
719# Takes a database handle and CIDR block
720# Returns a hashref to the parent container block, if any
721sub blockParent {
722 my $dbh = shift;
723 my $block = shift;
724
725 my $pinfo = $dbh->selectrow_hashref("SELECT cidr,city FROM routed".
726 " WHERE cidr >>= ?", undef, ($block) );
727 return $pinfo;
728} # end blockParent()
729
730
[527]731## IPDB::getRoutedCity()
732# Get the city for a routed block.
733sub getRoutedCity {
734 my $dbh = shift;
735 my $block = shift;
736
737 my ($rcity) = $dbh->selectrow_array("SELECT city FROM routed WHERE cidr = ?", undef, ($block) );
738 return $rcity;
739} # end getRoutedCity()
740
741
[77]742## IPDB::allocateBlock()
[66]743# Does all of the magic of actually allocating a netblock
[554]744# Requires a database handle, and a hash containing the block to allocate, routing depth, custid,
745# type, city, block to allocate from, and optionally a description, notes, circuit ID,
746# and private data
[77]747# Returns a success code and optional error message.
748sub allocateBlock {
[554]749 my $dbh = shift;
[284]750
[554]751 my %args = @_;
752
753 $args{cidr} = new NetAddr::IP $args{cidr};
754 $args{alloc_from} = new NetAddr::IP $args{alloc_from};
755
756 $args{desc} = '' if !$args{desc};
757 $args{notes} = '' if !$args{notes};
758 $args{circid} = '' if !$args{circid};
759 $args{privdata} = '' if !$args{privdata};
760 $args{vrf} = '' if !$args{vrf};
761
[77]762 my $sth;
[66]763
[349]764 # Snag the "type" of the freeblock (alloc_from) "just in case"
[554]765 $sth = $dbh->prepare("select routed from freeblocks where cidr='$args{alloc_from}'");
[349]766 $sth->execute;
767 my ($alloc_from_type) = $sth->fetchrow_array;
768
[79]769 # To contain the error message, if any.
[554]770 my $msg = "Unknown error allocating $args{cidr} as '$disp_alloctypes{$args{type}}'";
[79]771
[77]772 # Enable transactions and error handling
773 local $dbh->{AutoCommit} = 0; # These need to be local so we don't
774 local $dbh->{RaiseError} = 1; # step on our toes by accident.
[66]775
[554]776 if ($args{type} =~ /^.i$/) {
777 $msg = "Unable to assign static IP $args{cidr} to $args{custid}";
[77]778 eval {
[554]779 if ($args{cidr}) { # IP specified
780 my ($isavail) = $dbh->selectrow_array("SELECT available FROM poolips WHERE ip=?", undef, ($args{cidr}) );
781 die "IP is not in an IP pool.\n"
782 if !$isavail;
783 die "IP already allocated. Deallocate and reallocate, or update the entry\n"
784 if $isavail eq 'n';
785 } else { # IP not specified, take first available
786 ($args{cidr}) = $dbh->selectrow_array("SELECT ip FROM poolips WHERE pool=? AND available='y' ORDER BY ip",
787 undef, ($args{alloc_from}) );
[545]788 }
[554]789 $dbh->do("UPDATE poolips SET custid=?,city=?,available='n',description=?,notes=?,circuitid=?,privdata=?,vrf=? ".
790 "WHERE ip=?", undef, ($args{custid}, $args{city}, $args{desc}, $args{notes}, $args{circid},
791 $args{privdata}, $args{vrf}, $args{cidr}) );
[157]792
[397]793# node hack
[554]794 if ($args{nodeid} && $args{nodeid} ne '') {
795 $dbh->do("INSERT INTO noderef (block,node_id) VALUES (?,?)", undef, ($args{cidr}, $args{nodeid}) );
[397]796 }
797# end node hack
[545]798
[79]799 $dbh->commit;
[77]800 };
801 if ($@) {
[545]802 $msg .= ": $@";
[78]803 eval { $dbh->rollback; };
[578]804 return ('FAIL', $msg);
[77]805 } else {
[578]806 return ('OK', $args{cidr});
[77]807 }
808
809 } else { # end IP-from-pool allocation
810
[554]811 if ($args{cidr} == $args{alloc_from}) {
[77]812 # Easiest case- insert in one table, delete in the other, and go home. More or less.
813 # insert into allocations values (cidr,custid,type,city,desc) and
814 # delete from freeblocks where cidr='cidr'
815 # For data safety on non-transaction DBs, we delete first.
816
817 eval {
[554]818 $msg = "Unable to allocate $args{cidr} as '$disp_alloctypes{$args{type}}'";
819
[555]820 # Get old freeblocks parent/depth/routed for new entries... before we delete it.
821 my ($fparent) = $dbh->selectrow_array("SELECT parent FROM freeblocks WHERE cidr=? AND rdepth=?",
822 undef, ($args{alloc_from}, $args{rdepth}) );
823
[554]824 # Munge freeblocks
825 if ($args{type} =~ /^(.)[mc]$/) {
826 # special case - block is a routed or container/"reserve" block
827 my $rtype = $1;
828 $dbh->do("UPDATE freeblocks SET routed=?,rdepth=rdepth+1,city=?,parent=? WHERE cidr=? AND rdepth=?",
[578]829 undef, ($rtype, $args{city}, $args{cidr}, $args{cidr}, $args{rdepth}) );
[77]830 } else {
[554]831 # "normal" case
832 $dbh->do("DELETE FROM freeblocks WHERE cidr=? AND rdepth=?", undef, ($args{cidr}, $args{rdepth}));
833 }
[77]834
[554]835 # Insert the allocations entry
836 $dbh->do("INSERT INTO allocations ".
837 "(cidr,parent,vrf,rdepth,custid,type,city,description,notes,circuitid,privdata)".
838 " VALUES (?,?,?,?,?,?,?,?,?,?,?)", undef,
839 ($args{cidr}, $fparent, $args{vrf}, $args{rdepth}, $args{custid}, $args{type}, $args{city},
840 $args{desc}, $args{notes}, $args{circid}, $args{privdata}) );
[79]841
[554]842 # And initialize the pool, if necessary
843 # PPPoE pools (currently dialup, DSL, and WiFi) get all IPs made available
844 # "DHCP" or "real-subnet" pools have the net, gw, and bcast IPs removed.
845 if ($args{type} =~ /^.p$/) {
846 $msg = "Could not initialize IPs in new $disp_alloctypes{$args{type}} $args{cidr}";
[574]847 my ($code,$rmsg) = initPool($dbh, $args{cidr}, $args{type}, $args{city}, "all", $args{rdepth}+1);
[554]848 die $rmsg if $code eq 'FAIL';
849 } elsif ($args{type} =~ /^.d$/) {
850 $msg = "Could not initialize IPs in new $disp_alloctypes{$args{type}} $args{cidr}";
[574]851 my ($code,$rmsg) = initPool($dbh, $args{cidr}, $args{type}, $args{city}, "normal", $args{rdepth}+1);
[554]852 die $rmsg if $code eq 'FAIL';
853 }
[79]854
[397]855# node hack
[554]856 if ($args{nodeid} && $args{nodeid} ne '') {
857 $dbh->do("INSERT INTO noderef (block,node_id) VALUES (?,?)", undef, ($args{cidr}, $args{nodeid}) );
[397]858 }
859# end node hack
[574]860
[77]861 $dbh->commit;
[78]862 }; # end of eval
[77]863 if ($@) {
[157]864 $msg .= ": ".$@;
[77]865 eval { $dbh->rollback; };
[157]866 return ('FAIL',$msg);
[77]867 } else {
[78]868 return ('OK',"OK");
869 }
[77]870
871 } else { # cidr != alloc_from
872
873 # Hard case. Allocation is smaller than free block.
[554]874 my $wantmaskbits = $args{cidr}->masklen;
875 my $maskbits = $args{alloc_from}->masklen;
[77]876
877 my @newfreeblocks; # Holds free blocks generated from splitting the source freeblock.
878
879 # This determines which blocks will be left "free" after allocation. We take the
880 # block we're allocating from, and split it in half. We see which half the wanted
881 # block is in, and repeat until the wanted block is equal to one of the halves.
882 my $i=0;
[554]883 my $tmp_from = $args{alloc_from}; # So we don't munge $args{alloc_from}
[77]884 while ($maskbits++ < $wantmaskbits) {
885 my @subblocks = $tmp_from->split($maskbits);
[554]886 $newfreeblocks[$i++] = (($args{cidr}->within($subblocks[0])) ? $subblocks[1] : $subblocks[0]);
887 $tmp_from = ( ($args{cidr}->within($subblocks[0])) ? $subblocks[0] : $subblocks[1] );
[77]888 } # while
889
890 # Begin SQL transaction block
891 eval {
[554]892 $msg = "Unable to allocate $args{cidr} as '$disp_alloctypes{$args{type}}'";
[79]893
[554]894 # Get old freeblocks parent/depth/routed for new entries
895 my ($fparent,$fcity,$wasrouted) = $dbh->selectrow_array("SELECT parent,city,routed FROM freeblocks".
896 " WHERE cidr=? AND rdepth=?", undef, ($args{alloc_from}, $args{rdepth}) );
897
[77]898 # Delete old freeblocks entry
[554]899 $dbh->do("DELETE FROM freeblocks WHERE cidr=? AND rdepth=?", undef, ($args{alloc_from}, $args{rdepth}) );
[77]900
[554]901 # Insert new list of smaller free blocks left over
902 $sth = $dbh->prepare("INSERT INTO freeblocks (cidr,city,routed,vrf,parent,rdepth) VALUES (?,?,?,?,?,?)");
903 foreach my $block (@newfreeblocks) {
904 $sth->execute($block, $fcity, $wasrouted, $args{vrf}, $fparent, $args{rdepth});
905 }
[79]906
[554]907 # For routed/container types, add a freeblock within the allocated block so we can subdivide it further
908 if ($args{type} =~ /(.)[mc]/) { # rm and .c types - containers
909 my $rtype = $1;
910 $sth->execute($args{cidr}, $args{city}, $rtype, $args{vrf}, $args{cidr}, $args{rdepth}+1);
911 }
[79]912
[554]913 # Insert the allocations entry
914 $dbh->do("INSERT INTO allocations ".
915 "(cidr,parent,vrf,rdepth,custid,type,city,description,notes,circuitid,privdata)".
916 " VALUES (?,?,?,?,?,?,?,?,?,?,?)", undef,
917 ($args{cidr}, $fparent, $args{vrf}, $args{rdepth}, $args{custid}, $args{type}, $args{city},
918 $args{desc}, $args{notes}, $args{circid}, $args{privdata}) );
[77]919
[554]920 # And initialize the pool, if necessary
921 # PPPoE pools (currently dialup, DSL, and WiFi) get all IPs made available
922 # "DHCP" or "real-subnet" pools have the net, gw, and bcast IPs removed.
923 if ($args{type} =~ /^.p$/) {
924 $msg = "Could not initialize IPs in new $disp_alloctypes{$args{type}} $args{cidr}";
[574]925 my ($code,$rmsg) = initPool($dbh, $args{cidr}, $args{type}, $args{city}, "all", $args{rdepth}+1);
[554]926 die $rmsg if $code eq 'FAIL';
927 } elsif ($args{type} =~ /^.d$/) {
928 $msg = "Could not initialize IPs in new $disp_alloctypes{$args{type}} $args{cidr}";
[574]929 my ($code,$rmsg) = initPool($dbh, $args{cidr}, $args{type}, $args{city}, "normal", $args{rdepth}+1);
[554]930 die $rmsg if $code eq 'FAIL';
931 }
[77]932
[397]933# node hack
[554]934 if ($args{nodeid} && $args{nodeid} ne '') {
935 $dbh->do("INSERT INTO noderef (block,node_id) VALUES (?,?)", undef, ($args{cidr}, $args{nodeid}) );
[397]936 }
937# end node hack
[554]938
[77]939 $dbh->commit;
940 }; # end eval
941 if ($@) {
[256]942 $msg .= ": ".$@;
[77]943 eval { $dbh->rollback; };
[78]944 return ('FAIL',$msg);
[77]945 } else {
[78]946 return ('OK',"OK");
[77]947 }
948
949 } # end fullcidr != alloc_from
950
951 } # end static-IP vs netblock allocation
952
953} # end allocateBlock()
954
955
956## IPDB::initPool()
957# Initializes a pool
958# Requires a database handle, the pool CIDR, type, city, and a parameter
959# indicating whether the pool should allow allocation of literally every
960# IP, or if it should reserve network/gateway/broadcast IPs
[78]961# Note that this is NOT done in a transaction, that's why it's a private
962# function and should ONLY EVER get called from allocateBlock()
[77]963sub initPool {
[574]964 my ($dbh,undef,$type,$city,$class,$rdepth) = @_;
[77]965 my $pool = new NetAddr::IP $_[1];
966
[574]967 # IPv6 does not lend itself to IP pools as supported
968 return ('FAIL',"Refusing to create IPv6 static IP pool") if $pool->{isv6};
969 # IPv4 pools don't make much sense beyond even /24. Allow up to 4096-host footshooting anyway.
970 # NetAddr::IP won't allow more than a /16 (65k hosts).
971 return ('FAIL',"Refusing to create oversized static IP pool") if $pool->masklen <= 20;
972
[157]973##fixme Need to just replace 2nd char of type with i rather than capturing 1st char of type
974 $type =~ s/[pd]$/i/;
[77]975 my $sth;
[157]976 my $msg;
[77]977
[157]978 # Trap errors so we can pass them back to the caller. Even if the
979 # caller is only ever supposed to be local, and therefore already
980 # trapping errors. >:(
981 local $dbh->{AutoCommit} = 0; # These need to be local so we don't
982 local $dbh->{RaiseError} = 1; # step on our toes by accident.
983
984 eval {
985 # have to insert all pool IPs into poolips table as "unallocated".
[574]986 $sth = $dbh->prepare("INSERT INTO poolips (pool,ip,custid,city,type,rdepth)".
987 " VALUES ('$pool', ?, '$defcustid', ?, '$type', $rdepth)");
[157]988 my @poolip_list = $pool->hostenum;
989 if ($class eq 'all') { # (DSL-ish block - *all* IPs available
[246]990 if ($pool->addr !~ /\.0$/) { # .0 causes weirdness.
[485]991 $sth->execute($pool->addr, $city);
[246]992 }
[157]993 for (my $i=0; $i<=$#poolip_list; $i++) {
[485]994 $sth->execute($poolip_list[$i]->addr, $city);
[157]995 }
996 $pool--;
[246]997 if ($pool->addr !~ /\.255$/) { # .255 can cause weirdness.
[485]998 $sth->execute($pool->addr, $city);
[246]999 }
[157]1000 } else { # (real netblock)
1001 for (my $i=1; $i<=$#poolip_list; $i++) {
[485]1002 $sth->execute($poolip_list[$i]->addr, $city);
[157]1003 }
[77]1004 }
[574]1005 $dbh->commit;
[157]1006 };
1007 if ($@) {
[574]1008 $msg = $@;
[157]1009 eval { $dbh->rollback; };
1010 return ('FAIL',$msg);
1011 } else {
1012 return ('OK',"OK");
[77]1013 }
1014} # end initPool()
1015
1016
[531]1017## IPDB::updateBlock()
1018# Update an allocation
1019# Takes all allocation fields in a hash
1020sub updateBlock {
1021 my $dbh = shift;
1022 my %args = @_;
1023
1024 return ('FAIL', 'Missing block to update') if !$args{block};
1025
1026 # do it all in a transaction
1027 local $dbh->{AutoCommit} = 0;
1028 local $dbh->{RaiseError} = 1;
1029
1030 my @fieldlist;
1031 my @vallist;
1032 foreach ('custid', 'city', 'description', 'notes', 'circuitid', 'privdata') {
1033 if ($args{$_}) {
1034 push @fieldlist, $_;
1035 push @vallist, $args{$_};
1036 }
1037 }
1038
1039 my $updtable = 'allocations';
1040 my $keyfield = 'cidr';
[535]1041 if ($args{type} =~ /^(.)i$/) {
[531]1042 $updtable = 'poolips';
1043 $keyfield = 'ip';
1044 } else {
1045## fixme: there's got to be a better way...
1046 if ($args{swip}) {
1047 if ($args{swip} eq 'on' || $args{swip} eq '1' || $args{swip} eq 'y') {
1048 $args{swip} = 'y';
1049 } else {
1050 $args{swip} = 'n';
1051 }
1052 }
1053 foreach ('type', 'swip') {
1054 if ($args{$_}) {
1055 push @fieldlist, $_;
1056 push @vallist, $args{$_};
1057 }
1058 }
1059 }
1060
1061 return ('FAIL', 'No fields to update') if !@fieldlist;
1062
[579]1063# push @vallist, $args{block}, $args{rdepth}, $args{vrf};
1064 push @vallist, $args{block}, $args{rdepth};
[531]1065 my $sql = "UPDATE $updtable SET ";
1066 $sql .= join " = ?, ", @fieldlist;
[579]1067# $sql .= " = ? WHERE $keyfield = ? AND rdepth = ? AND vrf = ?";
1068 $sql .= " = ? WHERE $keyfield = ? AND rdepth = ? ";
[531]1069
1070 eval {
1071 # do the update
1072 $dbh->do($sql, undef, @vallist);
1073
1074 if ($args{node}) {
1075 # done with delete/insert so we don't have to worry about funkyness updating a node ref that isn't there
1076 $dbh->do("DELETE FROM noderef WHERE block = ?", undef, ($args{block}) );
1077 $dbh->do("INSERT INTO noderef (block,node_id) VALUES (?,?)", undef, ($args{block}, $args{node}) );
1078 }
1079
1080 $dbh->commit;
1081 };
1082 if ($@) {
1083 my $msg = $@;
1084 $dbh->rollback;
1085 return ('FAIL', $msg);
1086 }
1087 return 0;
1088} # end updateBlock()
1089
1090
[93]1091## IPDB::deleteBlock()
1092# Removes an allocation from the database, including deleting IPs
1093# from poolips and recombining entries in freeblocks if possible
1094# Also handles "deleting" a static IP allocation, and removal of a master
[558]1095# Requires a database handle, the block to delete, the routing depth (if applicable),
1096# and the VRF ID
[93]1097sub deleteBlock {
[558]1098 my ($dbh,undef,$rdepth,$vrf) = @_;
[93]1099 my $cidr = new NetAddr::IP $_[1];
1100
[558]1101# For possible auto-VRF-ignoring (since public IPs shouldn't usually be present in more than one VRF)
1102# is_rfc1918 requires NetAddr::IP >= 4.059
1103# rather than doing this over and over and over.....
1104 my $tmpnum = $cidr->numeric;
1105# 192.168.0.0/16 -> 192.168.255.255 => 3232235520 -> 3232301055
1106# 172.16.0.0/12 -> 172.31.255.255 => 2886729728 -> 2887778303
1107# 10.0.0.0/8 -> 10.255.255.255 => 167772160 -> 184549375
1108 my $isprivnet = (3232235520 <= $tmpnum && $tmpnum <= 3232301055) ||
1109 (2886729728 <= $tmpnum && $tmpnum <= 2887778303) ||
1110 (167772160 <= $tmpnum && $tmpnum <= 184549375);
1111
[93]1112 my $sth;
1113
[349]1114 # Magic variables used for odd allocation cases.
1115 my $container;
1116 my $con_type;
1117
[558]1118 # Collect info about the block we're going to delete
1119 my $binfo = getBlockData($dbh, $cidr, $rdepth, $vrf);
1120
1121 # temporarily forced null, until a sane UI for VRF tracking can be found.
1122 $vrf = '';# if !$vrf; # as with SQL, the null value is not equal to ''. *sigh*
1123
[93]1124 # To contain the error message, if any.
[558]1125 my $msg = "Unknown error deallocating $binfo->{type} $cidr";
1126 my $goback; # to put the parent in so we can link back where the deallocate started
1127
[93]1128 # Enable transactions and exception-on-errors... but only for this sub
1129 local $dbh->{AutoCommit} = 0;
1130 local $dbh->{RaiseError} = 1;
1131
1132 # First case. The "block" is a static IP
1133 # Note that we still need some additional code in the odd case
1134 # of a netblock-aligned contiguous group of static IPs
[558]1135 if ($binfo->{type} =~ /^.i$/) {
[93]1136
1137 eval {
[558]1138 $msg = "Unable to deallocate $disp_alloctypes{$binfo->{type}} $cidr";
1139 my ($pool,$pcust,$pvrf) = $dbh->selectrow_array("SELECT pool,custid,vrf FROM poolips WHERE ip=?", undef, ($cidr) );
1140##fixme: VRF and rdepth
1141 $dbh->do("UPDATE poolips SET custid=?,available='y',".
1142 "city=(SELECT city FROM allocations WHERE cidr=?),".
1143 "description='',notes='',circuitid='',vrf=? WHERE ip=?", undef, ($pcust, $pool, $pvrf, $cidr) );
1144 $goback = $pool;
[93]1145 $dbh->commit;
1146 };
1147 if ($@) {
[558]1148 $msg .= ": $@";
[93]1149 eval { $dbh->rollback; };
1150 return ('FAIL',$msg);
1151 } else {
1152 return ('OK',"OK");
1153 }
1154
[558]1155 } elsif ($binfo->{type} eq 'mm') { # end alloctype =~ /.i/
[93]1156
[558]1157##fixme: VRF limit
[93]1158 $msg = "Unable to delete master block $cidr";
1159 eval {
[558]1160 $dbh->do("DELETE FROM masterblocks WHERE cidr = ?", undef, ($cidr) );
1161 $dbh->do("DELETE FROM allocations WHERE cidr <<= ?", undef, ($cidr) );
1162 $dbh->do("DELETE FROM freeblocks WHERE cidr <<= ?", undef, ($cidr) );
[93]1163 $dbh->commit;
1164 };
1165 if ($@) {
[558]1166 $msg .= ": $@";
[93]1167 eval { $dbh->rollback; };
1168 return ('FAIL', $msg);
1169 } else {
1170 return ('OK',"OK");
1171 }
1172
1173 } else { # end alloctype master block case
1174
1175 ## This is a big block; but it HAS to be done in a chunk. Any removal
1176 ## of a netblock allocation may result in a larger chunk of free
1177 ## contiguous IP space - which may in turn be combined into a single
1178 ## netblock rather than a number of smaller netblocks.
1179
[558]1180 my $retcode = 'OK';
1181
[93]1182 eval {
1183
[558]1184##fixme: add recursive flag to allow "YES DAMMIT DELETE ALL EVARYTHING!!1!!" without
1185# explicitly deleting any suballocations of the block to be deleted.
[93]1186
[558]1187 # find the current parent of the block we're deleting
1188 my ($parent) = $dbh->selectrow_array("SELECT parent FROM allocations WHERE cidr=? AND rdepth=?",
1189 undef, ($cidr, $rdepth) );
[93]1190
[558]1191 # Delete the block
1192 $dbh->do("DELETE FROM allocations WHERE cidr=? AND rdepth=?", undef, ($cidr, $rdepth) );
[349]1193
[558]1194##fixme: we could maybe eliminate a special case if we put masterblocks in the allocations table...?
1195 my ($ptype,$pcity);
1196 if ($rdepth == 1) {
1197 # parent is a master block.
1198 $ptype = 'mm';
1199 $pcity = '<NULL>';
1200 } else {
1201 # get that parent's details
1202 ($ptype,$pcity) = $dbh->selectrow_array("SELECT type,city FROM allocations ".
1203 "WHERE cidr=? AND rdepth=?", undef, ($parent, $rdepth-1) );
1204 }
[186]1205
[558]1206 # munge the parent type a little
1207 $ptype = (split //, $ptype)[0];
[93]1208
[558]1209##fixme: you can't... CAN NOT.... assign the same public IP to multiple things.
1210# 'Net don't work like that, homey. Restrict VRF-uniqueness to private IPs?
1211# -> $isprivnet flag from start of sub
[93]1212
[558]1213 my $fbrdepth = $rdepth;
[404]1214
[558]1215 # check to see if any container allocations could be the "true" parent
1216 my ($tparent,$trdepth,$trtype,$tcity) = $dbh->selectrow_array("SELECT cidr,rdepth,type,city FROM allocations ".
1217 "WHERE (type='rm' OR type LIKE '_c') AND cidr >> ? ".
1218 "ORDER BY masklen(cidr) DESC", undef, ($cidr) );
[404]1219
[558]1220 my $fparent;
1221 if ($tparent && $tparent ne $parent) {
1222 # found an alternate parent; reset some parent-info bits
1223 $parent = $tparent;
1224 $ptype = (split //, $trtype)[0];
1225 $pcity = $tcity;
1226 ##fixme: hmm. collect $rdepth into $goback here before vanishing?
1227 $retcode = 'WARN'; # may be redundant
1228 $goback = $tparent;
1229 # munge freeblock rdepth and parent to match true parent
1230 $dbh->do("UPDATE freeblocks SET rdepth = ?, parent = ?, routed = ? WHERE cidr <<= ? AND rdepth = ?", undef,
1231 ($trdepth+1, $parent, $ptype, $cidr, $rdepth) );
1232 $rdepth = $trdepth;
1233 $fbrdepth = $trdepth+1;
1234 }
1235
1236 $parent = new NetAddr::IP $parent;
1237 $goback = "$parent,$fbrdepth"; # breadcrumb in case of live-parent-is-not-true-parent
1238
1239 # Special case - delete pool IPs
1240 if ($binfo->{type} =~ /^.[pd]$/) {
1241 # We have to delete the IPs from the pool listing.
1242##fixme: rdepth? vrf?
1243 $dbh->do("DELETE FROM poolips WHERE pool = ?", undef, ($cidr) );
1244 }
1245
1246 # Find out if the block we're deallocating is within a DSL pool (legacy goo)
1247 my ($pool,$poolcity,$pooltype,$pooldepth) = $dbh->selectrow_array(
1248 "SELECT cidr,city,type,rdepth FROM allocations WHERE type LIKE '_p' AND cidr >>= ?",
1249 undef, ($cidr) );
1250
1251 # If so, return the block's IPs to the pool, instead of to freeblocks
1252## NB: not possible to currently cause this even via admin tools, only legacy data.
1253 if ($pool) {
1254 ## Deallocate legacy blocks stashed in the middle of a static IP pool
1255 ## This may be expandable to an even more general case of contained netblock, or other pool types.
1256 $retcode = 'WARNPOOL';
1257 $goback = "$pool,$pooldepth";
[428]1258 # We've already deleted the block, now we have to stuff its IPs into the pool.
1259 $pooltype =~ s/p$/i/; # change type to static IP
[558]1260 my $sth2 = $dbh->prepare("INSERT INTO poolips (pool,ip,city,type,custid) VALUES ".
[428]1261 "('$pool',?,'$poolcity','$pooltype','$defcustid')");
[558]1262 # don't insert .0
[429]1263##fixme: need to not insert net, gateway, and bcast on "real netblock" pools (DHCPish)
[428]1264 $sth2->execute($cidr->addr) unless $cidr->addr =~ m|\.0$|;
1265 foreach my $ip ($cidr->hostenum) {
[558]1266 $sth2->execute($ip);
[428]1267 }
1268 $cidr--;
1269 # don't insert .255
1270 $sth2->execute($cidr->addr) unless $cidr->addr =~ m|\.255$|;
1271 } else { # done returning IPs from a block to a static DSL pool
[93]1272
[558]1273 # If the block wasn't legacy goo embedded in a static pool, we check the
1274 # freeblocks in the identified parent to see if we can combine any of them.
[93]1275
[559]1276 # if the block to be deleted is a container, move its freeblock(s) up a level, and reset their parenting info
1277 if ($binfo->{type} =~ /^.[mc]/) {
1278 # move the freeblocks into the parent
1279 # we don't insert a new freeblock because there could be a live reparented sub.
1280 $dbh->do("UPDATE freeblocks SET rdepth=rdepth-1,parent=?,routed=?,city=? ".
1281 "WHERE parent=? AND rdepth=?", undef,
1282 ($parent, $ptype, $pcity, $cidr, $rdepth+1) );
1283 } else {
1284 # ... otherwise, add the freeblock
1285 $dbh->do("INSERT INTO freeblocks (cidr, city, routed, parent, rdepth) VALUES (?,?,?,?,?)", undef,
1286 ($cidr, $pcity, $ptype, $parent, $rdepth) );
1287 }
1288
[558]1289##fixme: vrf
1290 # set up the query to get the list of blocks to try to merge.
1291 $sth = $dbh->prepare("SELECT cidr FROM freeblocks ".
1292 "WHERE parent = ? AND routed = ? AND rdepth = ? ".
1293 "ORDER BY masklen(cidr) DESC");
[428]1294
[558]1295 $sth->execute($parent, $ptype, $fbrdepth);
1296
[93]1297# NetAddr::IP->compact() attempts to produce the smallest inclusive block
1298# from the caller and the passed terms.
1299# EG: if you call $cidr->compact($ip1,$ip2,$ip3) when $cidr, $ip1, $ip2,
1300# and $ip3 are consecutive /27's starting on .0 (.0-.31, .32-.63,
1301# .64-.95, and .96-.128), you will get an array containing a single
1302# /25 as element 0 (.0-.127). Order is not important; you could have
1303# $cidr=.32/27, $ip1=.96/27, $ip2=.0/27, and $ip3=.64/27.
1304
[558]1305 my (@rawfb, @combinelist);
[428]1306 my $i=0;
[558]1307 # for each free block under $parent, push a NetAddr::IP object into one list, and
1308 # continuously use NetAddr::IP->compact to automagically merge netblocks as possible.
[428]1309 while (my @data = $sth->fetchrow_array) {
1310 my $testIP = new NetAddr::IP $data[0];
[558]1311 push @rawfb, $testIP;
1312 @combinelist = $testIP->compact(@combinelist);
[93]1313 }
1314
[558]1315 # now that we have the full list of "compacted" freeblocks, go back over
1316 # the list of raw freeblocks, and delete the ones that got merged.
1317 $sth = $dbh->prepare("DELETE FROM freeblocks WHERE cidr=? AND parent=? AND rdepth=?");
1318 foreach my $rawfree (@rawfb) {
1319 next if grep { $rawfree == $_ } @combinelist; # skip if the raw block is in the compacted list
1320 $sth->execute($rawfree, $parent, $fbrdepth);
1321 }
[93]1322
[558]1323 # now we walk the new list of compacted blocks, and see which ones we need to insert
1324 $sth = $dbh->prepare("INSERT INTO freeblocks (cidr,city,routed,parent,rdepth) VALUES (?,?,?,?,?)");
1325 foreach my $cme (@combinelist) {
1326 next if grep { $cme == $_ } @rawfb; # skip if the combined block was in the raw list
1327 $sth->execute($cme, $pcity, $ptype, $parent, $fbrdepth);
[428]1328 }
[93]1329
[428]1330 } # done returning IPs to the appropriate place
[404]1331
[93]1332 # If we got here, we've succeeded. Whew!
1333 $dbh->commit;
1334 }; # end eval
1335 if ($@) {
[558]1336 $msg .= ": $@";
[93]1337 eval { $dbh->rollback; };
1338 return ('FAIL', $msg);
1339 } else {
[558]1340 return ($retcode, $goback);
[93]1341 }
1342
1343 } # end alloctype != netblock
1344
1345} # end deleteBlock()
1346
1347
[370]1348## IPDB::getBlockData()
[557]1349# Get CIDR or IP, custid, type, city, circuit ID, description, notes, modification time,
1350# private/restricted data, for a CIDR block or pool IP
1351# Also returns SWIP status flag for CIDR blocks or pool netblock for IPs
1352# Takes the block/IP to look up, routing depth, and VRF identifier
1353# Returns a hashref to the block data
[370]1354sub getBlockData {
1355 my $dbh = shift;
1356 my $block = shift;
[557]1357 my $rdepth = shift;
1358 my $vrf = shift || '';
[370]1359
[534]1360 my $cidr = new NetAddr::IP $block;
1361
[557]1362 # better way to find IP allocations vs /32 "netblocks"
1363 my $btype = $dbh->selectrow_array("SELECT type FROM searchme WHERE cidr=?", undef, ($block) );
[534]1364
[557]1365 if (defined($rdepth) && $rdepth == 0) {
1366 # Only master blocks exist at rdepth 0
1367 my $binfo = $dbh->selectrow_hashref("SELECT cidr AS block, 'mm' AS type, 0 AS parent, cidr,".
1368 " ctime, mtime, rwhois, vrf".
[579]1369 " FROM masterblocks WHERE cidr = ?", undef, ($block) );
1370# " FROM masterblocks WHERE cidr = ? AND vrf = ?", undef, ($block, $vrf) );
[557]1371 return $binfo;
1372 } elsif ($btype =~ /^.i$/) {
1373 my $binfo = $dbh->selectrow_hashref("SELECT ip AS block, custid, type, city, circuitid, description,".
1374 " notes, modifystamp AS lastmod, privdata, vrf, pool, rdepth".
[579]1375 " FROM poolips WHERE ip = ?", undef, ($block) );
1376# " FROM poolips WHERE ip = ? AND vrf = ?", undef, ($block, $vrf) );
[557]1377 return $binfo;
1378 } else {
1379 my $binfo = $dbh->selectrow_hashref("SELECT cidr AS block, parent, custid, type, city, circuitid, ".
1380 "description, notes, modifystamp AS lastmod, privdata, vrf, swip, rdepth".
1381 " FROM allocations WHERE cidr = ? AND rdepth = ?", undef, ($block, $rdepth) );
1382# " FROM allocations WHERE cidr = ? AND rdepth = ? AND vrf = ?", undef, ($block, $rdepth, $vrf) );
1383 return $binfo;
[534]1384 }
[370]1385} # end getBlockData()
1386
1387
[519]1388## IPDB::getNodeList()
1389# Gets a list of node ID+name pairs as an arrayref to a list of hashrefs
1390sub getNodeList {
1391 my $dbh = shift;
1392
1393 my $ret = $dbh->selectall_arrayref("SELECT node_id, node_name FROM nodes ORDER BY node_type,node_id",
1394 { Slice => {} });
1395 return $ret;
1396} # end getNodeList()
1397
1398
[530]1399## IPDB::getNodeName()
1400# Get node name from the ID
1401sub getNodeName {
1402 my $dbh = shift;
1403 my $nid = shift;
1404
1405 my ($nname) = $dbh->selectrow_array("SELECT node_name FROM nodes WHERE node_id = ?", undef, ($nid) );
1406 return $nname;
1407} # end getNodeName()
1408
1409
1410## IPDB::getNodeInfo()
1411# Get node name and ID associated with a block
1412sub getNodeInfo {
1413 my $dbh = shift;
1414 my $block = shift;
1415
1416 my ($nid, $nname) = $dbh->selectrow_array("SELECT nodes.node_id,node_name FROM nodes INNER JOIN noderef".
1417 " ON nodes.node_id=noderef.node_id WHERE noderef.block = ?", undef, ($block) );
1418 return ($nid, $nname);
1419} # end getNodeInfo()
1420
1421
[77]1422## IPDB::mailNotify()
[66]1423# Sends notification mail to recipients regarding an IPDB operation
[416]1424sub mailNotify {
1425 my $dbh = shift;
1426 my ($action,$subj,$message) = @_;
[66]1427
[462]1428 return if $smtphost eq 'smtp.example.com'; # do nothing if still using default SMTP host.
1429
[422]1430##fixme: need to redesign the breakdown/processing for $action for proper handling of all cases
1431
[416]1432# split action into parts for fiddlement. nb: there are almost certainly better ways to do this.
[422]1433 my @actionbits = split //, $action;
[416]1434
1435 # want to notify anyone who has specifically requested notify on *this* type ($action as passed),
1436 # on "all static IP types" or "all pool types" (and other last-char-in-type groupings), on eg "all DSL types",
1437 # and "all events with this action"
1438 my @actionsets = ($action);
1439##fixme: ick, eww. really gotta find a better way to handle this...
1440 push @actionsets, ($actionbits[0].'.'.$actionbits[2],
1441 $actionbits[0].$actionbits[1].'.', $actionbits[0].'a') if $action =~ /^.{3}$/;
1442
1443 my $mailer = Net::SMTP->new($smtphost, Hello => "ipdb.$domain");
1444
1445 # get recip list from db
1446 my $sth = $dbh->prepare("SELECT reciplist FROM notify WHERE action=?");
1447
[443]1448 my %reciplist;
[416]1449 foreach (@actionsets) {
[426]1450 $sth->execute($_);
[416]1451##fixme - need to handle db errors
1452 my ($recipsub) = $sth->fetchrow_array;
1453 next if !$recipsub;
1454 foreach (split(/,/, $recipsub)) {
[443]1455 $reciplist{$_}++;
[416]1456 }
1457 }
1458
[443]1459 return if !%reciplist;
[420]1460
[443]1461 foreach my $recip (keys %reciplist) {
[416]1462 $mailer->mail("ipdb\@$domain");
1463 $mailer->to($recip);
[422]1464 $mailer->data("From: \"$org_name IP Database\" <ipdb\@$domain>\n",
[135]1465 "To: $recip\n",
[69]1466 "Date: ".strftime("%a, %d %b %Y %H:%M:%S %z",localtime)."\n",
1467 "Subject: {IPDB} $subj\n",
1468 "X-Mailer: IPDB Notify v".sprintf("%.1d",$IPDB::VERSION)."\n",
[417]1469 "Organization: $org_name\n",
[69]1470 "\n$message\n");
[416]1471 }
[66]1472 $mailer->quit;
1473}
1474
[4]1475# Indicates module loaded OK. Required by Perl.
14761;
Note: See TracBrowser for help on using the repository browser.