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

Last change on this file since 562 was 562, checked in by Kris Deugau, 11 years ago

/trunk

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