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

Last change on this file since 692 was 692, checked in by Kris Deugau, 9 years ago

/trunk

Start adding support for advisory "reserved block" assignments - when
creating a new assignment, flag an equal-sized block ahead or behind
to expand the assignment in the future. See #24.

  • free block assignment
  • guided assignment (still needs tweaking to dodge existing reserved blocks)
  • note flagged blocks in free block list
  • Property svn:keywords set to Date Rev Author
File size: 67.8 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: 2015-02-11 23:43:22 +0000 (Wed, 11 Feb 2015) $
6# SVN revision $Rev: 692 $
7# Last update by $Author: kdeugau $
8###
9# Copyright (C) 2004-2010 - Kris Deugau
10
11package IPDB;
12
13use strict;
14use warnings;
15use Exporter;
16use DBI;
17use Net::SMTP;
18use NetAddr::IP qw(:lower Compact );
19use Frontier::Client;
20use POSIX;
21use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
22
23$VERSION = 2; ##VERSION##
24@ISA = qw(Exporter);
25@EXPORT_OK = qw(
26 %disp_alloctypes %list_alloctypes %def_custids @citylist @poplist
27 %IPDBacl %aclmsg %rpcacl $maxfcgi
28 $errstr
29 &initIPDBGlobals &connectDB &finish &checkDBSanity
30 &addMaster &touchMaster
31 &listSummary &listSubs &listContainers &listAllocations &listFree &listPool
32 &getMasterList &getTypeList &getPoolSelect &findAllocateFrom
33 &ipParent &subParent &blockParent &getRoutedCity
34 &allocateBlock &updateBlock &deleteBlock &getBlockData &getBlockRDNS &getRDNSbyIP
35 &getNodeList &getNodeName &getNodeInfo
36 &mailNotify
37 );
38
39@EXPORT = (); # Export nothing by default.
40%EXPORT_TAGS = ( ALL => [qw(
41 %disp_alloctypes %list_alloctypes %def_custids @citylist @poplist
42 %IPDBacl %aclmsg %rpcacl $maxfcgi
43 $errstr
44 &initIPDBGlobals &connectDB &finish &checkDBSanity
45 &addMaster &touchMaster
46 &listSummary &listSubs &listContainers &listAllocations &listFree &listPool
47 &getMasterList &getTypeList &getPoolSelect &findAllocateFrom
48 &ipParent &subParent &blockParent &getRoutedCity
49 &allocateBlock &updateBlock &deleteBlock &getBlockData &getBlockRDNS &getRDNSbyIP
50 &getNodeList &getNodeName &getNodeInfo
51 &mailNotify
52 )]
53 );
54
55##
56## Global variables
57##
58our %disp_alloctypes;
59our %list_alloctypes;
60our %def_custids;
61our @citylist;
62our @poplist;
63our %IPDBacl;
64
65# mapping table for functional-area => error message
66our %aclmsg = (
67 addmaster => 'add a master block',
68 addblock => 'add an allocation',
69 updateblock => 'update a block',
70 delblock => 'delete an allocation',
71 );
72
73our %rpcacl;
74our $maxfcgi = 3;
75
76# error reporting
77our $errstr = '';
78
79our $org_name = 'Example Corp';
80our $smtphost = 'smtp.example.com';
81our $domain = 'example.com';
82our $defcustid = '5554242';
83our $smtpsender = 'ipdb@example.com';
84# mostly for rwhois
85##fixme: leave these blank by default?
86our $rwhoisDataPath = '/usr/local/rwhoisd/etc/rwhoisd'; # to match ./configure defaults from rwhoisd-1.5.9.6
87our $org_street = '123 4th Street';
88our $org_city = 'Anytown';
89our $org_prov_state = 'ON';
90our $org_pocode = 'H0H 0H0';
91our $org_country = 'CA';
92our $org_phone = '000-555-1234';
93our $org_techhandle = 'ISP-ARIN-HANDLE';
94our $org_email = 'noc@example.com';
95our $hostmaster = 'dns@example.com';
96
97our $syslog_facility = 'local2';
98
99our $rpc_url = '';
100our $revgroup = 1; # should probably be configurable somewhere
101our $rpccount = 0;
102
103# Largest inverse CIDR mask length to show per-IP rDNS list
104# (eg, NetAddr::IP->bits - NetAddr::IP->masklen)
105our $maxrevlist = 5; # /27
106
107# UI layout for subblocks/containers
108our $sublistlayout = 1;
109
110# VLAN validation mode. Set to 0 to allow alphanumeric vlan names instead of using the vlan number.
111our $numeric_vlan = 1;
112
113
114##
115## Internal utility functions
116##
117
118## IPDB::_rpc
119# Make an RPC call for DNS changes
120sub _rpc {
121 return if !$rpc_url; # Just In Case
122 my $rpcsub = shift;
123 my %args = @_;
124
125 # Make an object to represent the XML-RPC server.
126 my $server = Frontier::Client->new(url => $rpc_url, debug => 0);
127 my $result;
128
129 my %rpcargs = (
130 rpcsystem => 'ipdb',
131# must be provided by caller's caller
132# rpcuser => $args{user},
133 %args,
134 );
135
136 eval {
137 $result = $server->call("dnsdb.$rpcsub", %rpcargs);
138 };
139 if ($@) {
140 $errstr = $@;
141 $errstr =~ s/\s*$//;
142 $errstr =~ s/Fault returned from XML RPC Server, fault code 4: error executing RPC `dnsdb.$rpcsub'\.\s//;
143 }
144 $rpccount++;
145
146 return $result if $result;
147} # end _rpc()
148
149
150# Let's initialize the globals.
151## IPDB::initIPDBGlobals()
152# Initialize all globals. Takes a database handle, returns a success or error code
153sub initIPDBGlobals {
154 my $dbh = $_[0];
155 my $sth;
156
157 # Initialize alloctypes hashes
158 $sth = $dbh->prepare("select type,listname,dispname,listorder,def_custid from alloctypes order by listorder");
159 $sth->execute;
160 while (my @data = $sth->fetchrow_array) {
161 $disp_alloctypes{$data[0]} = $data[2];
162 $def_custids{$data[0]} = $data[4];
163 if ($data[3] < 900) {
164 $list_alloctypes{$data[0]} = $data[1];
165 }
166 }
167
168 # City and POP listings
169 $sth = $dbh->prepare("select city,routing from cities order by city");
170 $sth->execute;
171 return (undef,$sth->errstr) if $sth->err;
172 while (my @data = $sth->fetchrow_array) {
173 push @citylist, $data[0];
174 if ($data[1] eq 'y') {
175 push @poplist, $data[0];
176 }
177 }
178
179 # Load ACL data. Specific username checks are done at a different level.
180 $sth = $dbh->prepare("select username,acl from users");
181 $sth->execute;
182 return (undef,$sth->errstr) if $sth->err;
183 while (my @data = $sth->fetchrow_array) {
184 $IPDBacl{$data[0]} = $data[1];
185 }
186
187##fixme: initialize HTML::Template env var for template path
188# something like $self->path().'/templates' ?
189# $ENV{HTML_TEMPLATE_ROOT} = 'foo/bar';
190
191 return (1,"OK");
192} # end initIPDBGlobals
193
194
195## IPDB::connectDB()
196# Creates connection to IPDB.
197# Requires the database name, username, and password.
198# Returns a handle to the db.
199# Set up for a PostgreSQL db; could be any transactional DBMS with the
200# right changes.
201sub connectDB {
202 my $dbname = shift;
203 my $user = shift;
204 my $pass = shift;
205 my $dbhost = shift;
206
207 my $dbh;
208 my $DSN = "DBI:Pg:".($dbhost ? "host=$dbhost;" : '')."dbname=$dbname";
209
210# Note that we want to autocommit by default, and we will turn it off locally as necessary.
211# We may not want to print gobbledygook errors; YMMV. Have to ponder that further.
212 $dbh = DBI->connect($DSN, $user, $pass, {
213 AutoCommit => 1,
214 PrintError => 0
215 })
216 or return (undef, $DBI::errstr) if(!$dbh);
217
218# Return here if we can't select. Note that this indicates a
219# problem executing the select.
220 my $sth = $dbh->prepare("select type from alloctypes");
221 $sth->execute();
222 return (undef,$DBI::errstr) if ($sth->err);
223
224# See if the select returned anything (or null data). This should
225# succeed if the select executed, but...
226 $sth->fetchrow();
227 return (undef,$DBI::errstr) if ($sth->err);
228
229# If we get here, we should be OK.
230 return ($dbh,"DB connection OK");
231} # end connectDB
232
233
234## IPDB::finish()
235# Cleans up after database handles and so on.
236# Requires a database handle
237sub finish {
238 my $dbh = $_[0];
239 $dbh->disconnect if $dbh;
240} # end finish
241
242
243## IPDB::checkDBSanity()
244# Quick check to see if the db is responding. A full integrity
245# check will have to be a separate tool to walk the IP allocation trees.
246sub checkDBSanity {
247 my ($dbh) = $_[0];
248
249 if (!$dbh) {
250 print "No database handle, or connection has been closed.";
251 return -1;
252 } else {
253 # it connects, try a stmt.
254 my $sth = $dbh->prepare("select type from alloctypes");
255 my $err = $sth->execute();
256
257 if ($sth->fetchrow()) {
258 # all is well.
259 return 1;
260 } else {
261 print "Connected to the database, but could not execute test statement. ".$sth->errstr();
262 return -1;
263 }
264 }
265 # Clean up after ourselves.
266# $dbh->disconnect;
267} # end checkDBSanity
268
269
270## IPDB::addMaster()
271# Does all the magic necessary to sucessfully add a master block
272# Requires database handle, block to add
273# Returns failure code and error message or success code and "message"
274sub addMaster {
275 my $dbh = shift;
276 # warning! during testing, this somehow generated a "Bad file descriptor" error. O_o
277 my $cidr = new NetAddr::IP shift;
278 my %args = @_;
279
280 $args{vrf} = '' if !$args{vrf};
281 $args{rdns} = '' if !$args{rdns};
282 $args{defloc} = '' if !$args{defloc};
283 $args{rwhois} = 'n' if !$args{rwhois}; # fail "safe", sort of.
284 $args{rwhois} = 'n' if $args{rwhois} ne 'n' and $args{rwhois} ne 'y';
285
286 my $mid;
287
288 # Allow transactions, and raise an exception on errors so we can catch it later.
289 # Use local to make sure these get "reset" properly on exiting this block
290 local $dbh->{AutoCommit} = 0;
291 local $dbh->{RaiseError} = 1;
292
293 # Wrap all the SQL in a transaction
294 eval {
295 # First check - does the master exist? Ignore VRFs until we can see a sane UI
296 my ($mcontained) = $dbh->selectrow_array("SELECT cidr FROM allocations WHERE cidr >>= ? AND type = 'mm'",
297 undef, ($cidr) );
298 die "Master block $mcontained already exists and entirely contains $cidr\n"
299 if $mcontained;
300
301 # Second check - does the new master contain an existing one or ones?
302 my ($mexist) = $dbh->selectrow_array("SELECT cidr FROM allocations WHERE cidr <<= ? AND type = 'mm'",
303 undef, ($cidr) );
304
305 if (!$mexist) {
306 # First case - master is brand-spanking-new.
307##fixme: rwhois should be globally-flagable somewhere, much like a number of other things
308## maybe a db table called "config"?
309 $dbh->do("INSERT INTO allocations (cidr,type,swip,vrf,rdns) VALUES (?,?,?,?,?)", undef,
310 ($cidr, 'mm', 'y', $args{vrf}, $args{rdns}) );
311 ($mid) = $dbh->selectrow_array("SELECT currval('allocations_id_seq')");
312
313# Unrouted blocks aren't associated with a city (yet). We don't rely on this
314# elsewhere though; legacy data may have traps and pitfalls in it to break this.
315# Thus the "routed" flag.
316 $dbh->do("INSERT INTO freeblocks (cidr,city,routed,parent_id,vrf,master_id) VALUES (?,?,?,?,?,?)", undef,
317 ($cidr, '<NULL>', 'm', $mid, $args{vrf}, $mid) );
318
319 # master should be its own master, so deletes directly at the master level work
320 $dbh->do("UPDATE allocations SET master_id = ? WHERE id = ?", undef, ($mid, $mid) );
321
322 # If we get here, everything is happy. Commit changes.
323 $dbh->commit;
324
325 } # done new master does not contain existing master(s)
326 else {
327
328 # collect the master(s) we're going to absorb, and snag the longest netmask while we're at it.
329 my $smallmask = $cidr->masklen;
330 my $sth = $dbh->prepare("SELECT cidr,id FROM allocations WHERE cidr <<= ? AND type='mm' AND parent_id=0");
331 $sth->execute($cidr);
332 my @cmasters;
333 my @oldmids;
334 while (my @data = $sth->fetchrow_array) {
335 my $master = new NetAddr::IP $data[0];
336 push @cmasters, $master;
337 push @oldmids, $data[1];
338 $smallmask = $master->masklen if $master->masklen > $smallmask;
339 }
340
341 # split the new master, and keep only those blocks not part of an existing master
342 my @blocklist;
343 foreach my $seg ($cidr->split($smallmask)) {
344 my $contained = 0;
345 foreach my $master (@cmasters) {
346 $contained = 1 if $master->contains($seg);
347 }
348 push @blocklist, $seg if !$contained;
349 }
350
351##fixme: master_id
352 # collect the unrouted free blocks within the new master
353 $sth = $dbh->prepare("SELECT cidr FROM freeblocks WHERE masklen(cidr) <= ? AND cidr <<= ? AND routed = 'm'");
354 $sth->execute($smallmask, $cidr);
355 while (my @data = $sth->fetchrow_array) {
356 my $freeblock = new NetAddr::IP $data[0];
357 push @blocklist, $freeblock;
358 }
359
360 # combine the set of free blocks we should have now.
361 @blocklist = Compact(@blocklist);
362
363 # master
364 $dbh->do("INSERT INTO allocations (cidr,type,swip,vrf,rdns) VALUES (?,?,?,?,?)", undef,
365 ($cidr, 'mm', 'y', $args{vrf}, $args{rdns}) );
366 ($mid) = $dbh->selectrow_array("SELECT currval('allocations_id_seq')");
367
368 # master should be its own master, so deletes directly at the master level work
369 $dbh->do("UPDATE allocations SET master_id = ? WHERE id = ?", undef, ($mid, $mid) );
370
371 # and now insert the new data. Make sure to delete old masters too.
372
373 # freeblocks
374 $sth = $dbh->prepare("DELETE FROM freeblocks WHERE cidr <<= ? AND parent_id IN (".join(',', @oldmids).")");
375 my $sth2 = $dbh->prepare("INSERT INTO freeblocks (cidr,city,routed,parent_id,vrf,master_id)".
376 " VALUES (?,'<NULL>','m',?,?,?)");
377 foreach my $newblock (@blocklist) {
378 $sth->execute($newblock);
379 $sth2->execute($newblock, $mid, $args{vrf}, $mid);
380 }
381
382 # Update immediate allocations, and remove the old parents
383 $sth = $dbh->prepare("UPDATE allocations SET parent_id = ? WHERE parent_id = ?");
384 $sth2 = $dbh->prepare("DELETE FROM allocations WHERE id = ?");
385 foreach my $old (@oldmids) {
386 $sth->execute($mid, $old);
387 $sth2->execute($old);
388 }
389
390 # *whew* If we got here, we likely suceeded.
391 $dbh->commit;
392
393 } # new master contained existing master(s)
394 }; # end eval
395
396 if ($@) {
397 my $msg = $@;
398 eval { $dbh->rollback; };
399 return ('FAIL',$msg);
400 } else {
401
402 # Only attempt rDNS if the IPDB side succeeded
403 if ($rpc_url) {
404
405# Note *not* splitting reverse zones negates any benefit from caching the exported data.
406# IPv6 address space is far too large to split usefully, and in any case (also due to
407# the large address space) doesn't support the iterated template records v4 zones do
408# that causes the bulk of the slowdown that needs the cache anyway.
409
410 my @zonelist;
411# allow splitting reverse zones to be disabled, maybe, someday
412#if ($splitrevzones && !$cidr->{isv6}) {
413 if (1 && !$cidr->{isv6}) {
414 my $splitpoint = ($cidr->masklen <= 16 ? 16 : 24); # hack pthui
415 @zonelist = $cidr->split($splitpoint);
416 } else {
417 @zonelist = ($cidr);
418 }
419 my @fails;
420 ##fixme: remove hardcoding where possible
421 foreach my $subzone (@zonelist) {
422 my %rpcargs = (
423 rpcuser => $args{user},
424 revzone => "$subzone",
425 revpatt => $args{rdns},
426 defloc => $args{defloc},
427 group => $revgroup, # not sure how these two could sanely be exposed, tbh...
428 state => 1, # could make them globally configurable maybe
429 );
430 if ($rpc_url && !_rpc('addRDNS', %rpcargs)) {
431 push @fails, ("$subzone" => $errstr);
432 }
433 }
434 if (@fails) {
435 $errstr = "Warning(s) adding $cidr to reverse DNS:\n".join("\n", @fails);
436 return ('WARN',$mid);
437 }
438 }
439 return ('OK',$mid);
440 }
441} # end addMaster
442
443
444## IPDB::touchMaster()
445# Update last-changed timestamp on a master block.
446sub touchMaster {
447 my $dbh = shift;
448 my $master = shift;
449
450 local $dbh->{AutoCommit} = 0;
451 local $dbh->{RaiseError} = 1;
452
453 eval {
454 $dbh->do("UPDATE allocations SET modifystamp=now() WHERE id = ?", undef, ($master));
455 $dbh->commit;
456 };
457
458 if ($@) {
459 my $msg = $@;
460 eval { $dbh->rollback; };
461 return ('FAIL',$msg);
462 }
463 return ('OK','OK');
464} # end touchMaster()
465
466
467## IPDB::listSummary()
468# Get summary list of all master blocks
469# Returns an arrayref to a list of hashrefs containing the master block, routed count,
470# allocated count, free count, and largest free block masklength
471sub listSummary {
472 my $dbh = shift;
473
474 my $mlist = $dbh->selectall_arrayref("SELECT cidr AS master,id,vrf FROM allocations ".
475 "WHERE type='mm' ORDER BY cidr",
476 { Slice => {} });
477
478 foreach (@{$mlist}) {
479 my ($rcnt) = $dbh->selectrow_array("SELECT count(*) FROM allocations WHERE cidr <<= ? AND type='rm' AND master_id = ?",
480 undef, ($$_{master}, $$_{id}));
481 $$_{routed} = $rcnt;
482 my ($acnt) = $dbh->selectrow_array("SELECT count(*) FROM allocations WHERE cidr <<= ? ".
483 "AND NOT type='rm' AND NOT type='mm' AND master_id = ?",
484 undef, ($$_{master}, $$_{id}));
485 $$_{allocated} = $acnt;
486 my ($fcnt) = $dbh->selectrow_array("SELECT count(*) FROM freeblocks WHERE cidr <<= ? AND master_id = ?",
487 undef, ($$_{master}, $$_{id}));
488 $$_{free} = $fcnt;
489 my ($bigfree) = $dbh->selectrow_array("SELECT masklen(cidr) AS maskbits FROM freeblocks WHERE cidr <<= ?".
490 " AND master_id = ? ORDER BY masklen(cidr) LIMIT 1", undef, ($$_{master}, $$_{id}));
491##fixme: should find a way to do this without having to HTMLize the <>
492 $bigfree = "/$bigfree" if $bigfree;
493 $bigfree = '<NONE>' if !$bigfree;
494 $$_{bigfree} = $bigfree;
495 }
496 return $mlist;
497} # end listSummary()
498
499
500## IPDB::listSubs()
501# Get list of subnets within a specified CIDR block, on a specified VRF.
502# Returns an arrayref to a list of hashrefs containing the CIDR block, customer location or
503# city it's routed to, block type, SWIP status, and description
504sub listSubs {
505 my $dbh = shift;
506 my %args = @_;
507
508 # Just In Case
509 $args{vrf} = '' if !$args{vrf};
510
511 # Snag the allocations for this block
512 my $sth = $dbh->prepare("SELECT cidr,city,type,custid,swip,description,vrf,id,master_id".
513 " FROM allocations WHERE parent_id = ? ORDER BY cidr");
514 $sth->execute($args{parent});
515
516 # hack hack hack
517 # set up to flag swip=y records if they don't actually have supporting data in the customers table
518 my $custsth = $dbh->prepare("SELECT count(*) FROM customers WHERE custid = ?");
519
520 # snag some more details
521 my $substh = $dbh->prepare("SELECT count(*) FROM allocations WHERE cidr <<= ? ".
522 "AND type ~ '[mc]\$' AND master_id = ? AND NOT cidr = ? ");
523 my $alsth = $dbh->prepare("SELECT count(*) FROM allocations WHERE cidr <<= ? ".
524 "AND NOT type='rm' AND NOT type='mm' AND master_id = ?");
525 my $freesth = $dbh->prepare("SELECT count(*) FROM freeblocks WHERE cidr <<= ? AND master_id = ?");
526 my $lfreesth = $dbh->prepare("SELECT masklen(cidr) AS maskbits FROM freeblocks WHERE cidr <<= ?".
527 " AND master_id = ? ORDER BY masklen(cidr) LIMIT 1");
528
529 my @blocklist;
530 while (my ($cidr,$city,$type,$custid,$swip,$desc,$vrf,$id,$mid) = $sth->fetchrow_array()) {
531 $desc .= " - vrf:$vrf" if $desc && $vrf;
532 $desc = "vrf:$vrf" if !$desc && $vrf;
533 $custsth->execute($custid);
534 my ($ncust) = $custsth->fetchrow_array();
535 $substh->execute($cidr, $mid, $cidr);
536 my ($cont) = $substh->fetchrow_array();
537 $alsth->execute($cidr, $mid);
538 my ($alloc) = $alsth->fetchrow_array();
539 $freesth->execute($cidr, $mid);
540 my ($free) = $freesth->fetchrow_array();
541 $lfreesth->execute($cidr, $mid);
542 my ($lfree) = $lfreesth->fetchrow_array();
543 $lfree = "/$lfree" if $lfree;
544 $lfree = '<NONE>' if !$lfree;
545 my %row = (
546 block => $cidr,
547 subcontainers => $cont,
548 suballocs => $alloc,
549 subfree => $free,
550 lfree => $lfree,
551 city => $city,
552 type => $disp_alloctypes{$type},
553 custid => $custid,
554 swip => ($swip eq 'y' ? 'Yes' : 'No'),
555 partswip => ($swip eq 'y' && $ncust == 0 ? 1 : 0),
556 desc => $desc,
557 hassubs => ($type eq 'rm' || $type =~ /.c/ ? 1 : 0),
558 id => $id,
559 );
560# $row{subblock} = ($type =~ /^.r$/); # hmf. wonder why these won't work in the hash declaration...
561 $row{listpool} = ($type =~ /^.[pd]$/);
562 push (@blocklist, \%row);
563 }
564 return \@blocklist;
565} # end listSubs()
566
567
568## IPDB::listContainers()
569# List all container-type allocations in a given parent
570# Takes a database handle and a hash:
571# - parent is the ID of the parent block
572# Returns an arrayref to a list of hashrefs with the CIDR block, location, type,
573# description, block ID, and counts for the nmber uf suballocations (all types),
574# free blocks, and the CIDR size of the largest free block
575sub listContainers {
576 my $dbh = shift;
577 my %args = @_;
578
579 # Just In Case
580 $args{vrf} = '' if !$args{vrf};
581
582 # Snag the allocations for this block
583 my $sth = $dbh->prepare("SELECT cidr,city,type,custid,swip,description,vrf,id,master_id".
584 " FROM allocations WHERE parent_id = ? AND type ~ '[mc]\$' ORDER BY cidr");
585 $sth->execute($args{parent});
586
587 my $alsth = $dbh->prepare("SELECT count(*) FROM allocations WHERE cidr <<= ? ".
588 "AND NOT type='rm' AND NOT type='mm' AND master_id = ?");
589 my $freesth = $dbh->prepare("SELECT count(*) FROM freeblocks WHERE cidr <<= ? AND master_id = ?");
590 my $lfreesth = $dbh->prepare("SELECT masklen(cidr) AS maskbits FROM freeblocks WHERE cidr <<= ?".
591 " AND master_id = ? ORDER BY masklen(cidr) LIMIT 1");
592
593 my @blocklist;
594 while (my ($cidr,$city,$type,$custid,$swip,$desc,$vrf,$id,$mid) = $sth->fetchrow_array()) {
595 $desc .= " - vrf:$vrf" if $desc && $vrf;
596 $desc = "vrf:$vrf" if !$desc && $vrf;
597 $alsth->execute($cidr, $mid);
598 my ($alloc) = $alsth->fetchrow_array();
599 $freesth->execute($cidr, $mid);
600 my ($free) = $freesth->fetchrow_array();
601 $lfreesth->execute($cidr, $mid);
602 my ($lfree) = $lfreesth->fetchrow_array();
603 $lfree = "/$lfree" if $lfree;
604 $lfree = '<NONE>' if !$lfree;
605 my %row = (
606 block => $cidr,
607 suballocs => $alloc,
608 subfree => $free,
609 lfree => $lfree,
610 city => $city,
611 type => $disp_alloctypes{$type},
612 desc => $desc,
613 id => $id,
614 );
615 push (@blocklist, \%row);
616 }
617 return \@blocklist;
618} # end listContainers()
619
620
621## IPDB::listAllocations()
622# List all end-use allocations in a given parent
623# Takes a database handle and a hash:
624# - parent is the ID of the parent block
625# Returns an arrayref to a list of hashrefs with the CIDR block, location, type,
626# custID, SWIP flag, description, block ID, and master ID
627sub listAllocations {
628 my $dbh = shift;
629 my %args = @_;
630
631 # Snag the allocations for this block
632 my $sth = $dbh->prepare("SELECT cidr,city,type,custid,swip,description,vrf,id,master_id".
633 " FROM allocations WHERE parent_id = ? AND type !~ '[mc]\$' ORDER BY cidr");
634 $sth->execute($args{parent});
635
636 # hack hack hack
637 # set up to flag swip=y records if they don't actually have supporting data in the customers table
638 my $custsth = $dbh->prepare("SELECT count(*) FROM customers WHERE custid = ?");
639
640 my @blocklist;
641 while (my ($cidr,$city,$type,$custid,$swip,$desc,$vrf,$id,$mid) = $sth->fetchrow_array()) {
642 $desc .= " - vrf:$vrf" if $desc && $vrf;
643 $desc = "vrf:$vrf" if !$desc && $vrf;
644 $custsth->execute($custid);
645 my ($ncust) = $custsth->fetchrow_array();
646 my %row = (
647 block => $cidr,
648 city => $city,
649 type => $disp_alloctypes{$type},
650 custid => $custid,
651 swip => ($swip eq 'y' ? 'Yes' : 'No'),
652 partswip => ($swip eq 'y' && $ncust == 0 ? 1 : 0),
653 desc => $desc,
654 id => $id,
655 );
656# $row{subblock} = ($type =~ /^.r$/); # hmf. wonder why these won't work in the hash declaration...
657 $row{listpool} = ($type =~ /^.[pd]$/);
658 push (@blocklist, \%row);
659 }
660 return \@blocklist;
661} # end listAllocations()
662
663
664## IPDB::listFree()
665# Gets a list of free blocks in the requested parent/master and VRF instance in both CIDR and range notation
666# Takes a parent/master ID and an optional VRF specifier that defaults to empty.
667# Returns an arrayref to a list of hashrefs containing the CIDR and range-notation blocks
668# Returns some extra flags in the hashrefs for routed blocks, since those can have several subtypes
669sub listFree {
670 my $dbh = shift;
671
672 my %args = @_;
673 # Just In Case
674 $args{vrf} = '' if !$args{vrf};
675
676 my $sth = $dbh->prepare(q(
677 SELECT f.cidr,f.id,allocations.cidr
678 FROM freeblocks f
679 LEFT JOIN allocations ON f.reserve_for = allocations.id
680 WHERE f.parent_id = ?
681 ORDER BY f.cidr
682 ) );
683# $sth->execute($args{parent}, $args{vrf});
684 $sth->execute($args{parent});
685 my @flist;
686 while (my ($cidr,$id,$resv) = $sth->fetchrow_array()) {
687 $cidr = new NetAddr::IP $cidr;
688 my %row = (
689 fblock => "$cidr",
690 frange => $cidr->range,
691 fbid => $id,
692 fbparent => $args{parent},
693 resv => $resv,
694 );
695 push @flist, \%row;
696 }
697 return \@flist;
698} # end listFree()
699
700
701## IPDB::listPool()
702#
703sub listPool {
704 my $dbh = shift;
705 my $pool = shift;
706
707 my $sth = $dbh->prepare("SELECT ip,custid,available,description,type,id".
708 " FROM poolips WHERE parent_id = ? ORDER BY ip");
709 $sth->execute($pool);
710 my @poolips;
711 while (my ($ip,$custid,$available,$desc,$type,$id) = $sth->fetchrow_array) {
712 my %row = (
713 ip => $ip,
714 custid => $custid,
715 available => $available,
716 desc => $desc,
717 delme => $available eq 'n',
718 parent => $pool,
719 id => $id,
720 );
721 push @poolips, \%row;
722 }
723 return \@poolips;
724} # end listPool()
725
726
727## IPDB::getMasterList()
728# Get a list of master blocks, optionally including last-modified timestamps
729# Takes an optional flag to indicate whether to include timestamps;
730# 'm' includes ctime, all others (suggest 'c') do not.
731# Returns an arrayref to a list of hashrefs
732sub getMasterList {
733 my $dbh = shift;
734 my $stampme = shift || 'm'; # optional but should be set by caller for clarity
735
736 my $mlist = $dbh->selectall_arrayref("SELECT id,vrf,cidr AS master".($stampme eq 'm' ? ',modifystamp AS mtime' : '').
737 " FROM allocations WHERE type='mm' ORDER BY cidr", { Slice => {} });
738 return $mlist;
739} # end getMasterList()
740
741
742## IPDB::getTypeList()
743# Get an alloctype/description pair list suitable for dropdowns
744# Takes a flag to determine which general groups of types are returned
745# Returns an reference to an array of hashrefs
746sub getTypeList {
747 my $dbh = shift;
748 my $tgroup = shift || 'a'; # technically optional, like this, but should
749 # really be specified in the call for clarity
750 my $tlist;
751 if ($tgroup eq 'n') {
752 # grouping 'p' - all netblock types. These include routed blocks, containers (_c)
753 # and contained (_r) types, dynamic-allocation ranges (_e), static IP pools (_d and _p),
754 # and the "miscellaneous" cn, in, and en types.
755 $tlist = $dbh->selectall_arrayref("SELECT type,listname FROM alloctypes WHERE listorder <= 500 ".
756 "AND type NOT LIKE '_i' ORDER BY listorder", { Slice => {} });
757 } elsif ($tgroup eq 'p') {
758 # grouping 'p' - primary allocation types. As with 'n' above but without the _r contained types.
759 $tlist = $dbh->selectall_arrayref("SELECT type,listname FROM alloctypes WHERE listorder <= 500 ".
760 "AND type NOT LIKE '_i' AND type NOT LIKE '_r' ORDER BY listorder", { Slice => {} });
761 } elsif ($tgroup eq 'c') {
762 # grouping 'c' - contained types. These include all static IPs and all _r types.
763 $tlist = $dbh->selectall_arrayref("SELECT type,listname FROM alloctypes WHERE listorder <= 500 ".
764 " AND (type LIKE '_i' OR type LIKE '_r') ORDER BY listorder", { Slice => {} });
765 } elsif ($tgroup eq 'i') {
766 # grouping 'i' - static IP types.
767 $tlist = $dbh->selectall_arrayref("SELECT type,listname FROM alloctypes WHERE listorder <= 500 ".
768 " AND type LIKE '_i' ORDER BY listorder", { Slice => {} });
769 } else {
770 # grouping 'a' - all standard allocation types. This includes everything
771 # but mm (present only as a formality). Make this the default.
772 $tlist = $dbh->selectall_arrayref("SELECT type,listname FROM alloctypes WHERE listorder <= 500 ".
773 " ORDER BY listorder", { Slice => {} });
774 }
775 return $tlist;
776}
777
778
779## IPDB::getPoolSelect()
780# Get a list of pools matching the passed city and type that have 1 or more free IPs
781# Returns an arrayref to a list of hashrefs
782sub getPoolSelect {
783 my $dbh = shift;
784 my $iptype = shift;
785 my $pcity = shift;
786
787 my ($ptype) = ($iptype =~ /^(.)i$/);
788 return if !$ptype;
789 $ptype .= '_';
790
791 my $plist = $dbh->selectall_arrayref( q(
792 SELECT count(*) AS poolfree,p.pool AS poolblock, a.city AS poolcit
793 FROM poolips p
794 JOIN allocations a ON p.parent_id=a.id
795 WHERE p.available='y' AND a.city = ? AND p.type LIKE ?
796 GROUP BY p.pool,a.city
797 ),
798 { Slice => {} }, ($pcity, $ptype) );
799 return $plist;
800} # end getPoolSelect()
801
802
803## IPDB::findAllocateFrom()
804# Find free block to add a new allocation from. (CIDR block version of pool select above, more or less)
805# Takes
806# - mask length
807# - allocation type
808# - POP city "parent"
809# - optional master-block restriction
810# - optional flag to allow automatic pick-from-private-network-ranges
811# Returns a string with the first CIDR block matching the criteria, if any
812sub findAllocateFrom {
813 my $dbh = shift;
814 my $maskbits = shift;
815 my $type = shift;
816 my $city = shift;
817 my $pop = shift;
818 my %optargs = @_;
819
820 my $failmsg = "No suitable free block found\n";
821
822 my @vallist;
823 my $sql;
824
825 # Free pool IPs should be easy.
826 if ($type =~ /^.i$/) {
827 # User may get an IP from the wrong VRF. User should not be using admin tools to allocate static IPs.
828 $sql = "SELECT id, ip, parent_id FROM poolips WHERE ip = ?";
829 @vallist = ($optargs{gimme});
830 } else {
831
832## Set up the SQL to find out what freeblock we can (probably) use for an allocation.
833## Very large systems will require development of a reserve system (possibly an extension
834## of the reserve-for-expansion concept in https://secure.deepnet.cx/trac/ipdb/ticket/24?)
835## Also populate a value list for the DBI call.
836
837 @vallist = ($maskbits);
838 $sql = "SELECT id,cidr,parent_id FROM freeblocks WHERE masklen(cidr) <= ?";
839
840# cases, strict rules
841# .c -> container type
842# requires a routing container, fbtype r
843# .d -> DHCP/"normal-routing" static pool
844# requires a routing container, fbtype r
845# .e -> Dynamic-assignment connectivity
846# requires a routing container, fbtype r
847# .i -> error, can't allocate static IPs this way?
848# mm -> error, master block
849# rm -> routed block
850# requires master block, fbtype m
851# .n -> Miscellaneous usage
852# requires a routing container, fbtype r
853# .p -> PPP(oE) static pool
854# requires a routing container, fbtype r
855# .r -> contained type
856# requires a matching container, fbtype $1
857##fixme: strict-or-not flag
858
859##fixme: config or UI flag for "Strict" mode
860# if ($strictmode) {
861if (0) {
862 if ($type =~ /^(.)r$/) {
863 push @vallist, $1;
864 $sql .= " AND routed = ?";
865 } elsif ($type eq 'rm') {
866 $sql .= " AND routed = 'm'";
867 } else {
868 $sql .= " AND routed = 'r'";
869 }
870}
871
872 # for PPP(oE) and container types, the POP city is the one attached to the pool.
873 # individual allocations get listed with the customer city site.
874 ##fixme: chain cities to align roughly with a full layer-2 node graph
875 $city = $pop if $type !~ /^.[pc]$/;
876 if ($type ne 'rm' && $city) {
877 $sql .= " AND city = ?";
878 push @vallist, $city;
879 }
880 # Allow specifying an arbitrary full block, instead of a master
881 if ($optargs{gimme}) {
882 $sql .= " AND cidr >>= ?";
883 push @vallist, $optargs{gimme};
884 }
885 # if a specific master was requested, allow the requestor to self->shoot(foot)
886 if ($optargs{master} && $optargs{master} ne '-') {
887 $sql .= " AND master_id = ?";
888# if $optargs{master} ne '-';
889 push @vallist, $optargs{master};
890 } else {
891 # if a specific master was NOT requested, filter out the RFC 1918 private networks
892 if (!$optargs{allowpriv}) {
893 $sql .= " AND NOT (cidr <<= '192.168.0.0/16' OR cidr <<= '10.0.0.0/8' OR cidr <<= '172.16.0.0/12')";
894 }
895 }
896 # Sorting and limiting, since we don't (currently) care to provide a selection of
897 # blocks to carve up. This preserves something resembling optimal usage of the IP
898 # space by forcing contiguous allocations and free blocks as much as possible.
899 $sql .= " ORDER BY masklen(cidr) DESC,cidr LIMIT 1";
900 } # done setting up SQL for free CIDR block
901
902 my ($fbid,$fbfound,$fbparent) = $dbh->selectrow_array($sql, undef, @vallist);
903 return $fbid,$fbfound,$fbparent;
904} # end findAllocateFrom()
905
906
907## IPDB::ipParent()
908# Get an IP's parent pool's details
909# Takes a database handle and IP
910# Returns a hashref to the parent pool block, if any
911sub ipParent {
912 my $dbh = shift;
913 my $block = shift;
914
915 my $pinfo = $dbh->selectrow_hashref("SELECT cidr,custid,type,city,description FROM allocations".
916 " WHERE cidr >>= ? AND (type LIKE '_p' OR type LIKE '_d')", undef, ($block) );
917 return $pinfo;
918} # end ipParent()
919
920
921## IPDB::subParent()
922# Get a block's parent's details
923# Takes a database handle and CIDR block
924# Returns a hashref to the parent container block, if any
925sub subParent {
926 my $dbh = shift;
927 my $block = shift;
928
929 my $pinfo = $dbh->selectrow_hashref("SELECT cidr,custid,type,city,description FROM allocations".
930 " WHERE cidr >>= ?", undef, ($block) );
931 return $pinfo;
932} # end subParent()
933
934
935## IPDB::blockParent()
936# Get a block's parent's details
937# Takes a database handle and CIDR block
938# Returns a hashref to the parent container block, if any
939sub blockParent {
940 my $dbh = shift;
941 my $block = shift;
942
943 my $pinfo = $dbh->selectrow_hashref("SELECT cidr,city FROM routed".
944 " WHERE cidr >>= ?", undef, ($block) );
945 return $pinfo;
946} # end blockParent()
947
948
949## IPDB::getRoutedCity()
950# Get the city for a routed block.
951sub getRoutedCity {
952 my $dbh = shift;
953 my $block = shift;
954
955 my ($rcity) = $dbh->selectrow_array("SELECT city FROM routed WHERE cidr = ?", undef, ($block) );
956 return $rcity;
957} # end getRoutedCity()
958
959
960## IPDB::allocateBlock()
961# Does all of the magic of actually allocating a netblock
962# Requires a database handle, and a hash containing the block to allocate, routing depth, custid,
963# type, city, block to allocate from, and optionally a description, notes, circuit ID,
964# and private data
965# Returns a success code and optional error message.
966sub allocateBlock {
967 my $dbh = shift;
968
969 my %args = @_;
970
971 $args{cidr} = new NetAddr::IP $args{cidr};
972
973 $args{desc} = '' if !$args{desc};
974 $args{notes} = '' if !$args{notes};
975 $args{circid} = '' if !$args{circid};
976 $args{privdata} = '' if !$args{privdata};
977 $args{vrf} = '' if !$args{vrf};
978 $args{vlan} = '' if !$args{vlan};
979 $args{rdns} = '' if !$args{rdns};
980
981 # Could arguably allow this for eg /120 allocations, but end users who get a single v4 IP are
982 # usually given a v6 /64, and most v6 addressing schemes need at least half that address space
983 if ($args{cidr}->{isv6} && $args{rdns} =~ /\%/) {
984 return ('FAIL','Reverse DNS template patterns are not supported for IPv6 allocations');
985 }
986
987 my $sth;
988
989 # Snag the "type" of the freeblock and its CIDR
990 my ($alloc_from_type, $alloc_from, $fbparent, $fcity, $fbmaster) =
991 $dbh->selectrow_array("SELECT routed,cidr,parent_id,city,master_id FROM freeblocks WHERE id = ?",
992 undef, $args{fbid});
993 $alloc_from = new NetAddr::IP $alloc_from;
994 return ('FAIL',"Failed to allocate $args{cidr}; intended free block was used by another allocation.")
995 if !$fbparent;
996##fixme: fail here if !$alloc_from
997# also consider "lock for allocation" due to multistep allocation process
998
999 # To contain the error message, if any.
1000 my $msg = "Unknown error allocating $args{cidr} as '$disp_alloctypes{$args{type}}'";
1001
1002 # Enable transactions and error handling
1003 local $dbh->{AutoCommit} = 0; # These need to be local so we don't
1004 local $dbh->{RaiseError} = 1; # step on our toes by accident.
1005
1006 if ($args{type} =~ /^.i$/) {
1007 $msg = "Unable to assign static IP $args{cidr} to $args{custid}";
1008 eval {
1009 if ($args{cidr}) { # IP specified
1010 my ($isavail) = $dbh->selectrow_array("SELECT available FROM poolips WHERE ip=?", undef, ($args{cidr}) );
1011 die "IP is not in an IP pool.\n"
1012 if !$isavail;
1013 die "IP already allocated. Deallocate and reallocate, or update the entry\n"
1014 if $isavail eq 'n';
1015 } else { # IP not specified, take first available
1016 ($args{cidr}) = $dbh->selectrow_array("SELECT ip FROM poolips WHERE pool=? AND available='y' ORDER BY ip",
1017 undef, ($args{alloc_from}) );
1018 }
1019 $dbh->do("UPDATE poolips SET custid = ?, city = ?,available='n', description = ?, notes = ?, ".
1020 "circuitid = ?, privdata = ?, vrf = ?, rdns = ? ".
1021 "WHERE ip = ? AND parent_id = ?", undef,
1022 ($args{custid}, $args{city}, $args{desc}, $args{notes},
1023 $args{circid}, $args{privdata}, $args{vrf}, $args{rdns},
1024 $args{cidr}, $args{parent}) );
1025
1026# node hack
1027 if ($args{nodeid} && $args{nodeid} ne '') {
1028 $dbh->do("INSERT INTO noderef (block,node_id) VALUES (?,?)", undef, ($args{cidr}, $args{nodeid}) );
1029 }
1030# end node hack
1031
1032 $dbh->commit; # Allocate IP from pool
1033 };
1034 if ($@) {
1035 $msg .= ": $@";
1036 eval { $dbh->rollback; };
1037 return ('FAIL', $msg);
1038 } else {
1039 _rpc('addOrUpdateRevRec', cidr => "$args{cidr}", name => $args{rdns}, rpcuser => $args{user});
1040 return ('OK', $args{cidr});
1041 }
1042
1043 } else { # end IP-from-pool allocation
1044
1045 if ($args{cidr} == $alloc_from) {
1046 # Easiest case- insert in one table, delete in the other, and go home. More or less.
1047 # insert into allocations values (cidr,custid,type,city,desc) and
1048 # delete from freeblocks where cidr='cidr'
1049 # For data safety on non-transaction DBs, we delete first.
1050
1051 eval {
1052 $msg = "Unable to allocate $args{cidr} as '$disp_alloctypes{$args{type}}'";
1053
1054 # Insert the allocations entry
1055 $dbh->do("INSERT INTO allocations ".
1056 "(cidr,parent_id,master_id,vrf,vlan,custid,type,city,description,notes,circuitid,privdata,rdns)".
1057 " VALUES (?,?,?,?,?,?,?,?,?,?,?,?,?)", undef,
1058 ($args{cidr}, $fbparent, $fbmaster, $args{vrf}, $args{vlan}, $args{custid}, $args{type}, $args{city},
1059 $args{desc}, $args{notes}, $args{circid}, $args{privdata}, $args{rdns}) );
1060 my ($bid) = $dbh->selectrow_array("SELECT currval('allocations_id_seq')");
1061
1062 # Munge freeblocks
1063 if ($args{type} =~ /^(.)[mc]$/) {
1064 # special case - block is a routed or container/"reserve" block
1065 my $rtype = $1;
1066 $dbh->do("UPDATE freeblocks SET routed = ?,city = ?,parent_id = ? WHERE id = ?",
1067 undef, ($rtype, $args{city}, $bid, $args{fbid}) );
1068 } else {
1069 # "normal" case
1070 $dbh->do("DELETE FROM freeblocks WHERE id = ?", undef, ($args{fbid}) );
1071 }
1072
1073 # And initialize the pool, if necessary
1074 # PPPoE pools (currently dialup, DSL, and WiFi) get all IPs made available
1075 # "DHCP" or "real-subnet" pools have the net, gw, and bcast IPs removed.
1076 if ($args{type} =~ /^.p$/) {
1077 $msg = "Could not initialize IPs in new $disp_alloctypes{$args{type}} $args{cidr}";
1078 my ($code,$rmsg) = initPool($dbh, $args{cidr}, $args{type}, $args{city}, "all", $bid);
1079 die $rmsg if $code eq 'FAIL';
1080 } elsif ($args{type} =~ /^.d$/) {
1081 $msg = "Could not initialize IPs in new $disp_alloctypes{$args{type}} $args{cidr}";
1082 my ($code,$rmsg) = initPool($dbh, $args{cidr}, $args{type}, $args{city}, "normal", $bid);
1083 die $rmsg if $code eq 'FAIL';
1084 }
1085
1086# node hack
1087 if ($args{nodeid} && $args{nodeid} ne '') {
1088 $dbh->do("INSERT INTO noderef (block,node_id) VALUES (?,?)", undef, ($args{cidr}, $args{nodeid}) );
1089 }
1090# end node hack
1091
1092 $dbh->commit; # Simple block allocation
1093 }; # end of eval
1094 if ($@) {
1095 $msg .= ": ".$@;
1096 eval { $dbh->rollback; };
1097 return ('FAIL',$msg);
1098 }
1099
1100 } else { # cidr != alloc_from
1101
1102 # Hard case. Allocation is smaller than free block.
1103
1104 # make sure new allocation is in fact within freeblock. *sigh*
1105 return ('FAIL',"Requested allocation $args{cidr} is not within $alloc_from")
1106 if !$alloc_from->contains($args{cidr});
1107 my $wantmaskbits = $args{cidr}->masklen;
1108 my $maskbits = $alloc_from->masklen;
1109
1110 my @newfreeblocks; # Holds free blocks generated from splitting the source freeblock.
1111
1112 # This determines which blocks will be left "free" after allocation. We take the
1113 # block we're allocating from, and split it in half. We see which half the wanted
1114 # block is in, and repeat until the wanted block is equal to one of the halves.
1115 my $i=0;
1116 my $tmp_from = $alloc_from; # So we don't munge $args{alloc_from}
1117 while ($maskbits++ < $wantmaskbits) {
1118 my @subblocks = $tmp_from->split($maskbits);
1119 $newfreeblocks[$i++] = (($args{cidr}->within($subblocks[0])) ? $subblocks[1] : $subblocks[0]);
1120 $tmp_from = ( ($args{cidr}->within($subblocks[0])) ? $subblocks[0] : $subblocks[1] );
1121 } # while
1122
1123 # Begin SQL transaction block
1124 eval {
1125 $msg = "Unable to allocate $args{cidr} as '$disp_alloctypes{$args{type}}'";
1126
1127 # Delete old freeblocks entry
1128 $dbh->do("DELETE FROM freeblocks WHERE id = ?", undef, ($args{fbid}) );
1129
1130 # Insert the allocations entry
1131 $dbh->do("INSERT INTO allocations ".
1132 "(cidr,parent_id,master_id,vrf,vlan,custid,type,city,description,notes,circuitid,privdata,rdns)".
1133 " VALUES (?,?,?,?,?,?,?,?,?,?,?,?,?)", undef,
1134 ($args{cidr}, $fbparent, $fbmaster, $args{vrf}, $args{vlan}, $args{custid}, $args{type}, $args{city},
1135 $args{desc}, $args{notes}, $args{circid}, $args{privdata}, $args{rdns}) );
1136 my ($bid) = $dbh->selectrow_array("SELECT currval('allocations_id_seq')");
1137
1138 # Insert new list of smaller free blocks left over. Flag the one that matches the
1139 # masklength of the new allocation, if a reserve block was requested.
1140 $sth = $dbh->prepare("INSERT INTO freeblocks (cidr,city,routed,vrf,parent_id,master_id,reserve_for) ".
1141 "VALUES (?,?,?,?,?,?,?)");
1142 foreach my $block (@newfreeblocks) {
1143 $sth->execute($block, $fcity, $alloc_from_type, $args{vrf}, $fbparent, $fbmaster,
1144 ($block->masklen == $wantmaskbits ? $bid : 0));
1145 }
1146
1147 # For routed/container types, add a freeblock within the allocated block so we can subdivide it further
1148 if ($args{type} =~ /(.)[mc]/) { # rm and .c types - containers
1149 my $rtype = $1;
1150 $sth->execute($args{cidr}, $args{city}, $rtype, $args{vrf}, $bid, $fbmaster);
1151 }
1152
1153 # And initialize the pool, if necessary
1154 # PPPoE pools (currently dialup, DSL, and WiFi) get all IPs made available
1155 # "DHCP" or "real-subnet" pools have the net, gw, and bcast IPs removed.
1156 if ($args{type} =~ /^.p$/) {
1157 $msg = "Could not initialize IPs in new $disp_alloctypes{$args{type}} $args{cidr}";
1158 my ($code,$rmsg) = initPool($dbh, $args{cidr}, $args{type}, $args{city}, "all", $bid);
1159 die $rmsg if $code eq 'FAIL';
1160 } elsif ($args{type} =~ /^.d$/) {
1161 $msg = "Could not initialize IPs in new $disp_alloctypes{$args{type}} $args{cidr}";
1162 my ($code,$rmsg) = initPool($dbh, $args{cidr}, $args{type}, $args{city}, "normal", $bid);
1163 die $rmsg if $code eq 'FAIL';
1164 }
1165
1166# node hack
1167 if ($args{nodeid} && $args{nodeid} ne '') {
1168 $dbh->do("INSERT INTO noderef (block,node_id) VALUES (?,?)", undef, ($args{cidr}, $args{nodeid}) );
1169 }
1170# end node hack
1171
1172 $dbh->commit; # Complex block allocation
1173 }; # end eval
1174 if ($@) {
1175 $msg .= ": ".$@;
1176 eval { $dbh->rollback; };
1177 return ('FAIL',$msg);
1178 }
1179
1180 } # end fullcidr != alloc_from
1181
1182 # now we do the DNS dance for netblocks, if we have an RPC server to do it with and a pattern to use.
1183 _rpc('addOrUpdateRevRec', cidr => "$args{cidr}", name => $args{rdns}, rpcuser => $args{user})
1184 if $args{rdns};
1185
1186 # and the per-IP set, if there is one.
1187 _rpc('updateRevSet', %{$args{iprev}}, rpcuser => $args{user});
1188
1189 return ('OK', 'OK');
1190
1191 } # end static-IP vs netblock allocation
1192
1193} # end allocateBlock()
1194
1195
1196## IPDB::initPool()
1197# Initializes a pool
1198# Requires a database handle, the pool CIDR, type, city, and a parameter
1199# indicating whether the pool should allow allocation of literally every
1200# IP, or if it should reserve network/gateway/broadcast IPs
1201# Note that this is NOT done in a transaction, that's why it's a private
1202# function and should ONLY EVER get called from allocateBlock()
1203sub initPool {
1204 my ($dbh,undef,$type,$city,$class,$parent) = @_;
1205 my $pool = new NetAddr::IP $_[1];
1206
1207 # IPv6 does not lend itself to IP pools as supported
1208 return ('FAIL',"Refusing to create IPv6 static IP pool") if $pool->{isv6};
1209 # IPv4 pools don't make much sense beyond even /24. Allow up to 4096-host footshooting anyway.
1210 # NetAddr::IP won't allow more than a /16 (65k hosts).
1211 return ('FAIL',"Refusing to create oversized static IP pool") if $pool->masklen <= 20;
1212
1213 # Retrieve some odds and ends for defaults on the IPs
1214 my ($pcustid) = $dbh->selectrow_array("SELECT def_custid FROM alloctypes WHERE type=?", undef, ($type) );
1215 my ($vrf,$vlan) = $dbh->selectrow_array("SELECT vrf,vlan FROM allocations WHERE allocation_id = ?",
1216 undef, ($parent) );
1217
1218 $type =~ s/[pd]$/i/;
1219 my $sth;
1220 my $msg;
1221
1222 # Trap errors so we can pass them back to the caller. Even if the
1223 # caller is only ever supposed to be local, and therefore already
1224 # trapping errors. >:(
1225 local $dbh->{AutoCommit} = 0; # These need to be local so we don't
1226 local $dbh->{RaiseError} = 1; # step on our toes by accident.
1227
1228 eval {
1229 # have to insert all pool IPs into poolips table as "unallocated".
1230 $sth = $dbh->prepare("INSERT INTO poolips (ip,custid,city,type,parent_id) VALUES (?,?,?,?,?)");
1231 my @poolip_list = $pool->hostenum;
1232 if ($class eq 'all') { # (DSL-ish block - *all* IPs available
1233 if ($pool->addr !~ /\.0$/) { # .0 causes weirdness.
1234 $sth->execute($pool->addr, $pcustid, $city, $type, $parent);
1235 }
1236 for (my $i=0; $i<=$#poolip_list; $i++) {
1237 $sth->execute($poolip_list[$i]->addr, $pcustid, $city, $type, $parent);
1238 }
1239 $pool--;
1240 if ($pool->addr !~ /\.255$/) { # .255 can cause weirdness.
1241 $sth->execute($pool->addr, $pcustid, $city, $type, $parent);
1242 }
1243 } else { # (real netblock)
1244 for (my $i=1; $i<=$#poolip_list; $i++) {
1245 $sth->execute($poolip_list[$i]->addr, $pcustid, $city, $type, $parent);
1246 }
1247 }
1248# don't commit here! the caller may not be done.
1249# $dbh->commit;
1250 };
1251 if ($@) {
1252 $msg = $@;
1253# Don't roll back! It's up to the caller to handle this.
1254# eval { $dbh->rollback; };
1255 return ('FAIL',$msg);
1256 } else {
1257 return ('OK',"OK");
1258 }
1259} # end initPool()
1260
1261
1262## IPDB::updateBlock()
1263# Update an allocation
1264# Takes all allocation fields in a hash
1265sub updateBlock {
1266 my $dbh = shift;
1267 my %args = @_;
1268
1269 return ('FAIL', 'Missing block to update') if !$args{block};
1270
1271 # Spaces don't show up well in lots of places. Make sure they don't get into the DB.
1272 $args{custid} =~ s/^\s+//;
1273 $args{custid} =~ s/\s+$//;
1274
1275 # do it all in a transaction
1276 local $dbh->{AutoCommit} = 0;
1277 local $dbh->{RaiseError} = 1;
1278
1279 my @fieldlist;
1280 my @vallist;
1281 foreach ('custid', 'city', 'description', 'notes', 'circuitid', 'privdata', 'rdns', 'vrf', 'vlan') {
1282 if ($args{$_}) {
1283 push @fieldlist, $_;
1284 push @vallist, $args{$_};
1285 }
1286 }
1287
1288 my $binfo;
1289 my $updtable = 'allocations';
1290 my $keyfield = 'id';
1291 if ($args{type} =~ /^(.)i$/) {
1292 $updtable = 'poolips';
1293 $binfo = getBlockData($dbh, $args{block}, 'i');
1294 } else {
1295## fixme: there's got to be a better way...
1296 $binfo = getBlockData($dbh, $args{block});
1297 if ($args{swip}) {
1298 if ($args{swip} eq 'on' || $args{swip} eq '1' || $args{swip} eq 'y') {
1299 $args{swip} = 'y';
1300 } else {
1301 $args{swip} = 'n';
1302 }
1303 }
1304 foreach ('type', 'swip') {
1305 if ($args{$_}) {
1306 push @fieldlist, $_;
1307 push @vallist, $args{$_};
1308 }
1309 }
1310 }
1311
1312 return ('FAIL', 'No fields to update') if !@fieldlist;
1313
1314 push @vallist, $args{block};
1315 my $sql = "UPDATE $updtable SET ";
1316 $sql .= join " = ?, ", @fieldlist;
1317 $sql .= " = ? WHERE $keyfield = ?";
1318
1319 eval {
1320 # do the update
1321 $dbh->do($sql, undef, @vallist);
1322
1323 if ($args{node}) {
1324 # done with delete/insert so we don't have to worry about funkyness updating a node ref that isn't there
1325 $dbh->do("DELETE FROM noderef WHERE block = ?", undef, ($binfo->{block}) );
1326 $dbh->do("INSERT INTO noderef (block,node_id) VALUES (?,?)", undef, ($binfo->{block}, $args{node}) )
1327 if $args{node} ne '--';
1328 }
1329
1330 $dbh->commit;
1331 };
1332 if ($@) {
1333 my $msg = $@;
1334 $dbh->rollback;
1335 return ('FAIL', $msg);
1336 }
1337
1338 # In case of any container (mainly master block), only update freeblocks so we don't stomp subs
1339 # (which would be the wrong thing in pretty much any case except "DELETE ALL EVARYTHING!!1!oneone!")
1340 if ($binfo->{type} =~ '.[mc]') {
1341 # Not using listFree() as it doesn't return quite all of the blocks wanted.
1342 # Retrieve the immediate free blocks
1343 my $sth = $dbh->prepare(q(
1344 SELECT cidr FROM freeblocks WHERE parent_id = ?
1345 UNION
1346 SELECT cidr FROM freeblocks f WHERE
1347 cidr = (SELECT cidr FROM allocations a WHERE f.cidr = a.cidr)
1348 AND master_id = ?
1349 ) );
1350 $sth->execute($args{block}, $binfo->{master_id});
1351 my %fbset;
1352 while (my ($fb) = $sth->fetchrow_array) {
1353 $fbset{"host_$fb"} = $args{rdns};
1354 }
1355 # We use this RPC call instead of multiple addOrUpdateRevRec calls, since we don't
1356 # know how many records we'll be updating and more than 3-4 is far too slow. This
1357 # should be safe to call unconditionally.
1358 # Requires dnsadmin >= r678
1359 _rpc('updateRevSet', %fbset, rpcuser => $args{user});
1360
1361 } else {
1362 $binfo->{block} =~ s|/32$||;
1363 _rpc('addOrUpdateRevRec', cidr => $binfo->{block}, name => $args{rdns}, rpcuser => $args{user});
1364
1365 # and the per-IP set, if there is one.
1366 _rpc('updateRevSet', %{$args{iprev}}, rpcuser => $args{user}) if keys (%{$args{iprev}});
1367 }
1368
1369 return ('OK','OK');
1370} # end updateBlock()
1371
1372
1373## IPDB::deleteBlock()
1374# Removes an allocation from the database, including deleting IPs
1375# from poolips and recombining entries in freeblocks if possible
1376# Also handles "deleting" a static IP allocation, and removal of a master
1377# Requires a database handle, the block to delete, the routing depth (if applicable),
1378# the VRF ID, and a flag to indicate whether to delete associated forward DNS entries
1379# as well as the reverse entry
1380sub deleteBlock {
1381 my ($dbh,$id,$basetype,$delfwd,$user) = @_;
1382
1383 # Collect info about the block we're going to delete
1384 my $binfo = getBlockData($dbh, $id, $basetype);
1385 my $cidr = new NetAddr::IP $binfo->{block};
1386
1387# For possible auto-VRF-ignoring (since public IPs shouldn't usually be present in more than one VRF)
1388# is_rfc1918 requires NetAddr::IP >= 4.059
1389# rather than doing this over and over and over.....
1390 my $tmpnum = $cidr->numeric;
1391# 192.168.0.0/16 -> 192.168.255.255 => 3232235520 -> 3232301055
1392# 172.16.0.0/12 -> 172.31.255.255 => 2886729728 -> 2887778303
1393# 10.0.0.0/8 -> 10.255.255.255 => 167772160 -> 184549375
1394 my $isprivnet = (3232235520 <= $tmpnum && $tmpnum <= 3232301055) ||
1395 (2886729728 <= $tmpnum && $tmpnum <= 2887778303) ||
1396 (167772160 <= $tmpnum && $tmpnum <= 184549375);
1397
1398 my $sth;
1399
1400 # Magic variables used for odd allocation cases.
1401 my $container;
1402 my $con_type;
1403
1404
1405 # temporarily forced null, until a sane UI for VRF tracking can be found.
1406# $vrf = '';# if !$vrf; # as with SQL, the null value is not equal to ''. *sigh*
1407
1408 # To contain the error message, if any.
1409 my $msg = "Unknown error deallocating $binfo->{type} $cidr";
1410 my $goback; # to put the parent in so we can link back where the deallocate started
1411
1412 # Enable transactions and exception-on-errors... but only for this sub
1413 local $dbh->{AutoCommit} = 0;
1414 local $dbh->{RaiseError} = 1;
1415
1416 if ($binfo->{type} =~ /^.i$/) {
1417 # First case. The "block" is a static IP
1418 # Note that we still need some additional code in the odd case
1419 # of a netblock-aligned contiguous group of static IPs
1420
1421 eval {
1422 $msg = "Unable to deallocate $disp_alloctypes{$binfo->{type}} $cidr";
1423 my $pinfo = getBlockData($dbh, $binfo->{parent_id}, 'b');
1424##fixme: VRF and rdepth
1425 $dbh->do("UPDATE poolips SET custid = ?, available = 'y',".
1426 "city = (SELECT city FROM allocations WHERE id = ?),".
1427 "description = '', notes = '', circuitid = '', vrf = ? WHERE id = ?", undef,
1428 ($pinfo->{custid}, $binfo->{parent_id}, $pinfo->{vrf}, $id) );
1429 $dbh->commit;
1430 };
1431 if ($@) {
1432 $msg .= ": $@";
1433 eval { $dbh->rollback; };
1434 return ('FAIL',$msg);
1435 } else {
1436##fixme: RPC return code?
1437 _rpc('delByCIDR', cidr => "$cidr", user => $user, delforward => $delfwd, rpcuser => $user);
1438 return ('OK',"OK");
1439 }
1440
1441 } elsif ($binfo->{type} eq 'mm') { # end alloctype =~ /.i/
1442 # Second case. The block is a full master block
1443
1444##fixme: VRF limit
1445 $msg = "Unable to delete master block $cidr";
1446 eval {
1447 $dbh->do("DELETE FROM allocations WHERE cidr <<= ? AND master_id = ?", undef, ($cidr, $binfo->{master_id}) );
1448 $dbh->do("DELETE FROM freeblocks WHERE cidr <<= ? AND master_id = ?", undef, ($cidr, $binfo->{master_id}) );
1449 $dbh->commit;
1450 };
1451 if ($@) {
1452 $msg .= ": $@";
1453 eval { $dbh->rollback; };
1454 return ('FAIL', $msg);
1455 }
1456
1457 # Have to handle potentially split reverse zones. Assume they *are* split,
1458 # since if we added them here, they would have been added split.
1459# allow splitting reverse zones to be disabled, maybe, someday
1460#if ($splitrevzones && !$cidr->{isv6}) {
1461 my @zonelist;
1462 if (1 && !$cidr->{isv6}) {
1463 my $splitpoint = ($cidr->masklen <= 16 ? 16 : 24); # hack pthui
1464 @zonelist = $cidr->split($splitpoint);
1465 } else {
1466 @zonelist = ($cidr);
1467 }
1468 my @fails;
1469 foreach my $subzone (@zonelist) {
1470 if ($rpc_url && !_rpc('delZone', zone => "$subzone", revrec => 'y', rpcuser => $user, delforward => $delfwd) ) {
1471 push @fails, ("$subzone" => $errstr);
1472 }
1473 }
1474 if (@fails) {
1475 return ('WARN',"Warning(s) deleting $cidr from reverse DNS:\n".join("\n", @fails));
1476 }
1477 return ('OK','OK');
1478
1479 } else { # end alloctype master block case
1480
1481 ## This is a big block; but it HAS to be done in a chunk. Any removal
1482 ## of a netblock allocation may result in a larger chunk of free
1483 ## contiguous IP space - which may in turn be combined into a single
1484 ## netblock rather than a number of smaller netblocks.
1485
1486 my $retcode = 'OK';
1487 my ($ptype,$pcity,$ppatt,$p_id);
1488
1489 eval {
1490
1491##fixme: add recursive flag to allow "YES DAMMIT DELETE ALL EVARYTHING!!1!!" without
1492# explicitly deleting any suballocations of the block to be deleted.
1493
1494 # get parent info of the block we're deleting
1495 my $pinfo = getBlockData($dbh, $binfo->{parent_id});
1496 $ptype = $pinfo->{type};
1497 $pcity = $pinfo->{city};
1498 $ppatt = $pinfo->{rdns};
1499 $p_id = $binfo->{parent_id};
1500
1501 # Delete the block
1502 $dbh->do("DELETE FROM allocations WHERE id = ?", undef, ($id) );
1503
1504 # munge the parent type a little
1505 $ptype = (split //, $ptype)[1];
1506
1507##fixme: you can't... CAN NOT.... assign the same public IP to multiple things.
1508# 'Net don't work like that, homey. Restrict VRF-uniqueness to private IPs?
1509# -> $isprivnet flag from start of sub
1510
1511 # check to see if any container allocations could be the "true" parent
1512 my ($tparent,$tpar_id,$trtype,$tcity);
1513 $tpar_id = 0;
1514
1515##fixme: this is far simpler in the strict VRF case; we "know" that any allocation
1516# contained by a container is a part of the same allocation tree when the VRF fields are equal.
1517
1518# logic:
1519# For each possible container of $cidr
1520# note the parent id
1521# walk the chain up the parents
1522# if we intersect $cidr's current parent, break
1523# if we've intersected $cidr's current parent
1524# set some variables to track that block
1525# break
1526
1527# Set up part of "is it in the middle of a pool?" check
1528 my $wuzpool = $dbh->selectrow_hashref("SELECT cidr,parent_id,type,city,custid,id FROM allocations ".
1529 "WHERE (type LIKE '_d' OR type LIKE '_p') AND cidr >> ? AND master_id = ?", { Slice => {} },
1530 ($cidr, $binfo->{master_id}) );
1531
1532##fixme?
1533# edge cases not handled, or handled badly:
1534# -> $cidr managed to get to be the entirety of an IP pool
1535
1536 if ($wuzpool && $wuzpool->{id} != $id) {
1537 # we have legacy goo to be purified
1538 # going to ignore nested pools; not possible to create them via API and no current legacy data includes any.
1539
1540 # for convenience
1541 my $poolid = $wuzpool->{id};
1542 my $pool = $wuzpool->{cidr};
1543 my $poolcity = $wuzpool->{city};
1544 my $pooltype = $wuzpool->{type};
1545 my $poolcustid = $wuzpool->{custid};
1546
1547 $retcode = 'WARNPOOL';
1548 $goback = "$poolid,$pool";
1549 # We've already deleted the block, now we have to stuff its IPs into the pool.
1550 $pooltype =~ s/[dp]$/i/; # change type to static IP
1551 my $sth2 = $dbh->prepare("INSERT INTO poolips (ip,city,type,custid,parent_id) VALUES ".
1552 "(?,'$poolcity','$pooltype','$poolcustid',$poolid)");
1553
1554##fixme: need to not insert net, gateway, and bcast on "real netblock" pools (DHCPish)
1555 # don't insert .0
1556 $sth2->execute($cidr->addr) unless $cidr->addr =~ m|\.0$|;
1557 $cidr++;
1558 my $bcast = $cidr->broadcast;
1559 while ($cidr != $bcast) {
1560 $sth2->execute($cidr->addr);
1561 $cidr++;
1562 }
1563 # don't insert .255
1564 $sth2->execute($cidr->addr) unless $cidr->addr =~ m|\.255$|;
1565
1566# Weirdness Happens. $cidr goes read-only somewhere (this is a thing?!?),
1567# causing ->split, ->hostenum, and related methods to explode. O_o
1568# foreach my $ip ($cidr->hostenum) {
1569# $sth2->execute($ip);
1570# }
1571
1572 }
1573
1574## important!
1575# ... or IS IT?
1576# we may have undef'ed $wuzpool above, if the allocation tree $cidr is in doesn't intersect the pool we found
1577#if (!$wuzpool) {
1578
1579 else {
1580
1581# Edge case: Block is the same size as more than one parent level. Should be rare.
1582# - mainly master + first routing. Sorting on parent_id hides the problem pretty well,
1583# but it's likely still possible to fail in particularly well-mangled databases.
1584# The ultimate fix for this may be to resurrect the "routing depth" atrocity. :/
1585 # Get all possible (and probably a number of impossible) containers for $cidr
1586 $sth = $dbh->prepare("SELECT cidr,parent_id,type,city,id FROM allocations ".
1587 "WHERE (type LIKE '_m' OR type LIKE '_c') AND cidr >>= ? AND master_id = ? ".
1588 "ORDER BY masklen(cidr) DESC,parent_id DESC");
1589 $sth->execute($cidr, $binfo->{master_id});
1590
1591 # Quickly get certain fields (simpler than getBlockData()
1592 my $sth2 = $dbh->prepare("SELECT cidr,parent_id,type,city FROM allocations ".
1593 "WHERE (type LIKE '_m' OR type LIKE '_c') AND id = ? AND master_id = ?");
1594
1595 # For each possible container of $cidr...
1596 while (my @data = $sth->fetchrow_array) {
1597 my $i = 0;
1598 # Save some state and set a start point - parent ID of container we're checking
1599 $tparent = $data[0];
1600 my $ppid = $data[1];
1601 $trtype = $data[2];
1602 $tcity = $data[3];
1603 $tpar_id = $data[4];
1604 last if $data[4] == $binfo->{parent_id}; # Preemptively break if we're already in the right place
1605 last if $ppid == $binfo->{parent_id}; # ... or if the parent of the container is the block's parent
1606 while (1) {
1607 # Retrieve bits on that parent ID
1608 $sth2->execute($ppid, $binfo->{master_id});
1609 my @container = $sth2->fetchrow_array;
1610 $ppid = $container[1];
1611 last if $container[1] == 0; # Break if we've hit a master block
1612 last if $ppid == $binfo->{parent_id}; # Break if we've reached the block $cidr is currently in
1613 }
1614 last if $ppid == $binfo->{parent_id};
1615 }
1616
1617 # found an alternate parent; reset some parent-info bits
1618 if ($tpar_id != $binfo->{parent_id}) {
1619 $ptype = (split //, $trtype)[1];
1620 $pcity = $tcity;
1621 $retcode = 'WARNMERGE'; # may be redundant
1622 $p_id = $tpar_id;
1623 }
1624
1625 $goback = "$p_id,$tparent"; # breadcrumb, currently only used in case of live-parent-is-not-true-parent
1626
1627 # Special case - delete pool IPs
1628 if ($binfo->{type} =~ /^.[pd]$/) {
1629 # We have to delete the IPs from the pool listing.
1630##fixme: rdepth? vrf?
1631 $dbh->do("DELETE FROM poolips WHERE parent_id = ?", undef, ($id) );
1632 }
1633
1634 $pinfo = getBlockData($dbh, $p_id);
1635
1636 # If the block wasn't legacy goo embedded in a static pool, we check the
1637 # freeblocks in the identified parent to see if we can combine any of them.
1638
1639 # if the block to be deleted is a container, move its freeblock(s) up a level, and reset their parenting info
1640 if ($binfo->{type} =~ /^.[mc]/) {
1641 # move the freeblocks into the parent
1642 # we don't insert a new freeblock because there could be a live reparented sub.
1643 $dbh->do("UPDATE freeblocks SET parent_id = ?, routed = ?, city = ? WHERE parent_id = ?", undef,
1644 ($p_id, $ptype, $pcity, $id) );
1645 } else {
1646 # ... otherwise, add the freeblock
1647 $dbh->do("INSERT INTO freeblocks (cidr, city, routed, parent_id, master_id) VALUES (?,?,?,?,?)", undef,
1648 ($cidr, $pcity, $ptype, $p_id, $binfo->{master_id}) );
1649 }
1650
1651##fixme: vrf
1652##fixme: simplify since all containers now represent different "layers"/"levels"?
1653 # set up the query to get the list of blocks to try to merge.
1654 $sth = $dbh->prepare("SELECT cidr,id FROM freeblocks ".
1655 "WHERE parent_id = ? ".
1656 "ORDER BY masklen(cidr) DESC");
1657
1658 $sth->execute($p_id);
1659
1660# NetAddr::IP->compact() attempts to produce the smallest inclusive block
1661# from the caller and the passed terms.
1662# EG: if you call $cidr->compact($ip1,$ip2,$ip3) when $cidr, $ip1, $ip2,
1663# and $ip3 are consecutive /27's starting on .0 (.0-.31, .32-.63,
1664# .64-.95, and .96-.128), you will get an array containing a single
1665# /25 as element 0 (.0-.127). Order is not important; you could have
1666# $cidr=.32/27, $ip1=.96/27, $ip2=.0/27, and $ip3=.64/27.
1667
1668 my (@rawfb, @combinelist, %rawid);
1669 my $i=0;
1670 # for each free block under $parent, push a NetAddr::IP object into one list, and
1671 # continuously use NetAddr::IP->compact to automagically merge netblocks as possible.
1672 while (my @data = $sth->fetchrow_array) {
1673 my $testIP = new NetAddr::IP $data[0];
1674 push @rawfb, $testIP;
1675 $rawid{"$testIP"} = $data[1]; # $data[0] vs "$testIP" *does* make a difference for v6
1676 @combinelist = $testIP->compact(@combinelist);
1677 }
1678
1679 # now that we have the full list of "compacted" freeblocks, go back over
1680 # the list of raw freeblocks, and delete the ones that got merged.
1681 $sth = $dbh->prepare("DELETE FROM freeblocks WHERE id = ?");
1682 foreach my $rawfree (@rawfb) {
1683 next if grep { $rawfree == $_ } @combinelist; # skip if the raw block is in the compacted list
1684 $sth->execute($rawid{$rawfree});
1685 }
1686
1687 # now we walk the new list of compacted blocks, and see which ones we need to insert
1688 $sth = $dbh->prepare("INSERT INTO freeblocks (cidr,city,routed,parent_id,master_id) VALUES (?,?,?,?,?)");
1689 foreach my $cme (@combinelist) {
1690 next if grep { $cme == $_ } @rawfb; # skip if the combined block was in the raw list
1691 $sth->execute($cme, $pcity, $ptype, $p_id, $binfo->{master_id});
1692 }
1693
1694 } # done returning IPs to the appropriate place
1695
1696 # If we got here, we've succeeded. Whew!
1697 $dbh->commit;
1698 }; # end eval
1699 if ($@) {
1700 $msg .= ": $@";
1701 eval { $dbh->rollback; };
1702 return ('FAIL', $msg);
1703 } else {
1704##fixme: RPC return code?
1705 _rpc('delByCIDR', cidr => "$cidr", rpcuser => $user, delforward => $delfwd, delsubs => 'y', parpatt => $ppatt);
1706 return ($retcode, $goback);
1707 }
1708
1709 } # end alloctype != netblock
1710
1711} # end deleteBlock()
1712
1713
1714## IPDB::getBlockData()
1715# Get CIDR or IP, custid, type, city, circuit ID, description, notes, modification time,
1716# private/restricted data, for a CIDR block or pool IP
1717# Also returns SWIP status flag for CIDR blocks or pool netblock for IPs
1718# Takes the block ID or IP to look up and an optional flag to indicate a pool IP lookup
1719# instead of a netblock.
1720# Returns a hashref to the block data
1721sub getBlockData {
1722 my $dbh = shift;
1723 my $id = shift;
1724 my $type = shift || 'b'; # default to netblock for lazy callers
1725
1726 # netblocks are in the allocations table; pool IPs are in the poolips table.
1727 # If we try to look up a CIDR in an integer field we should just get back nothing.
1728 my ($btype) = $dbh->selectrow_array("SELECT type FROM allocations WHERE id=?", undef, ($id) );
1729
1730 # Note city, vrf, parent_id and master_id removed due to JOIN uncertainty for block allocations
1731 my $commonfields = q(custid, type, circuitid, description, notes, modifystamp AS lastmod,
1732 privdata, vlan, rdns);
1733
1734 if ($type eq 'i') {
1735 my $binfo = $dbh->selectrow_hashref(qq(
1736 SELECT ip AS block, city, vrf, parent_id, master_id, $commonfields
1737 FROM poolips WHERE id = ?
1738 ), undef, ($id) );
1739 return $binfo;
1740 } else {
1741 my $binfo = $dbh->selectrow_hashref(qq(
1742 SELECT a.cidr AS block, a.city, a.vrf, a.parent_id, a.master_id, swip, $commonfields,
1743 f.cidr AS reserve, f.id as reserve_id
1744 FROM allocations a LEFT JOIN freeblocks f ON a.id=f.reserve_for
1745 WHERE a.id = ?
1746 ), undef, ($id) );
1747 return $binfo;
1748 }
1749} # end getBlockData()
1750
1751
1752## IPDB::getBlockRDNS()
1753# Gets reverse DNS pattern for a block or IP. Note that this will also
1754# retrieve any default pattern following the parent chain up, and check via
1755# RPC (if available) to see what the narrowest pattern for the requested block is
1756# Returns the current pattern for the block or IP.
1757sub getBlockRDNS {
1758 my $dbh = shift;
1759 my %args = @_;
1760
1761 $args{type} = 'b' if !$args{type};
1762 my $cached = 1;
1763
1764 # snag entry from database
1765 my ($rdns,$rfrom,$pid);
1766 if ($args{type} =~ /.i/) {
1767 ($rdns, $rfrom, $pid) = $dbh->selectrow_array("SELECT rdns,ip,parent_id FROM poolips WHERE id = ?",
1768 undef, ($args{id}) );
1769 } else {
1770 ($rdns, $rfrom, $pid) = $dbh->selectrow_array("SELECT rdns,cidr,parent_id FROM allocations WHERE id = ?",
1771 undef, ($args{id}) );
1772 }
1773
1774 # Can't see a way this could end up empty, for any case I care about. If the caller
1775 # doesn't know an allocation ID to request, then they don't know anything else anyway.
1776 my $selfblock = $rfrom;
1777
1778 my $type;
1779 while (!$rdns && $pid) {
1780 ($rdns, $rfrom, $pid, $type) = $dbh->selectrow_array(
1781 "SELECT rdns,cidr,parent_id,type FROM allocations WHERE id = ?",
1782 undef, ($pid) );
1783 last if $type eq 'mm'; # break loops in unfortunate legacy data
1784 }
1785
1786 # use the actual allocation to check against the DNS utility; we don't want
1787 # to always go chasing up the chain to the master... which may (usually won't)
1788 # be present directly in DNS anyway
1789 my $cidr = new NetAddr::IP $selfblock;
1790
1791 if ($rpc_url) {
1792 # Use the first /16 or /24, rather than dithering over which sub-/14 /16
1793 # or sub-/19 /24 to retrieve - it's the least-wrong way to do things.
1794
1795 my ($rpcblock) = ($cidr->masklen <= 24 ? $cidr->split( ($cidr->masklen <= 16 ? 16 : 24) ) : $cidr);
1796 my %rpcargs = (
1797 rpcuser => $args{user},
1798 group => $revgroup, # not sure how this could sanely be exposed, tbh...
1799 cidr => "$rpcblock",
1800 );
1801
1802 my $remote_rdns = _rpc('getRevPattern', %rpcargs);
1803 $rdns = $remote_rdns if $remote_rdns;
1804 $cached = 0;
1805 }
1806
1807 # hmm. do we care about where it actually came from?
1808 return $rdns, $cached;
1809} # end getBlockRDNS()
1810
1811
1812## IPDB::getRDNSbyIP()
1813# Get individual reverse entries for the IP or CIDR IP range passed. Sort of looking the
1814# opposite direction down the netblock tree compared to getBlockRDNS() above.
1815sub getRDNSbyIP {
1816 my $dbh = shift;
1817 my %args = @_; # We want to accept a variety of call types
1818
1819 # key arguments: allocation ID, type
1820 unless ($args{id} || $args{type}) {
1821 $errstr = 'Missing allocation ID or type';
1822 return;
1823 }
1824
1825 my @ret = ();
1826 # special case: single IP. Check if it's an allocation or in a pool, then do the RPC call for fresh data.
1827 if ($args{type} =~ /^.i$/) {
1828 my ($ip, $localrev) = $dbh->selectrow_array("SELECT ip, rdns FROM poolips WHERE id = ?", undef, ($args{id}) );
1829 push @ret, { 'r_ip' => $ip, 'iphost' => $localrev };
1830 } else {
1831 if ($rpc_url) {
1832 my %rpcargs = (
1833 rpcuser => $args{user},
1834 group => $revgroup, # not sure how this could sanely be exposed, tbh...
1835 cidr => $args{range},
1836 );
1837
1838 my $remote_rdns = _rpc('getRevSet', %rpcargs);
1839 return $remote_rdns;
1840# $rdns = $remote_rdns if $remote_rdns;
1841# $cached = 0;
1842 }
1843 }
1844 return \@ret;
1845} # end getRDNSbyIP()
1846
1847
1848## IPDB::getNodeList()
1849# Gets a list of node ID+name pairs as an arrayref to a list of hashrefs
1850sub getNodeList {
1851 my $dbh = shift;
1852
1853 my $ret = $dbh->selectall_arrayref("SELECT node_id, node_name FROM nodes ORDER BY node_type,node_id",
1854 { Slice => {} });
1855 return $ret;
1856} # end getNodeList()
1857
1858
1859## IPDB::getNodeName()
1860# Get node name from the ID
1861sub getNodeName {
1862 my $dbh = shift;
1863 my $nid = shift;
1864
1865 my ($nname) = $dbh->selectrow_array("SELECT node_name FROM nodes WHERE node_id = ?", undef, ($nid) );
1866 return $nname;
1867} # end getNodeName()
1868
1869
1870## IPDB::getNodeInfo()
1871# Get node name and ID associated with a block
1872sub getNodeInfo {
1873 my $dbh = shift;
1874 my $block = shift;
1875
1876 my ($nid, $nname) = $dbh->selectrow_array("SELECT nodes.node_id,node_name FROM nodes INNER JOIN noderef".
1877 " ON nodes.node_id=noderef.node_id WHERE noderef.block = ?", undef, ($block) );
1878 return ($nid, $nname);
1879} # end getNodeInfo()
1880
1881
1882## IPDB::mailNotify()
1883# Sends notification mail to recipients regarding an IPDB operation
1884sub mailNotify {
1885 my $dbh = shift;
1886 my ($action,$subj,$message) = @_;
1887
1888 return if $smtphost eq 'smtp.example.com'; # do nothing if still using default SMTP host.
1889
1890##fixme: need to redesign the breakdown/processing for $action for proper handling of all cases
1891
1892# split action into parts for fiddlement. nb: there are almost certainly better ways to do this.
1893 my @actionbits = split //, $action;
1894
1895 # want to notify anyone who has specifically requested notify on *this* type ($action as passed),
1896 # on "all static IP types" or "all pool types" (and other last-char-in-type groupings), on eg "all DSL types",
1897 # and "all events with this action"
1898 my @actionsets = ($action);
1899##fixme: ick, eww. really gotta find a better way to handle this...
1900 push @actionsets, ($actionbits[0].'.'.$actionbits[2],
1901 $actionbits[0].$actionbits[1].'.', $actionbits[0].'a') if $action =~ /^.{3}$/;
1902
1903 my $mailer = Net::SMTP->new($smtphost, Hello => "ipdb.$domain");
1904
1905 # get recip list from db
1906 my $sth = $dbh->prepare("SELECT reciplist FROM notify WHERE action=?");
1907
1908 my %reciplist;
1909 foreach (@actionsets) {
1910 $sth->execute($_);
1911##fixme - need to handle db errors
1912 my ($recipsub) = $sth->fetchrow_array;
1913 next if !$recipsub;
1914 foreach (split(/,/, $recipsub)) {
1915 $reciplist{$_}++;
1916 }
1917 }
1918
1919 return if !%reciplist;
1920
1921 foreach my $recip (keys %reciplist) {
1922 $mailer->mail($smtpsender);
1923 $mailer->to($recip);
1924 $mailer->data("From: \"$org_name IP Database\" <$smtpsender>\n",
1925 "To: $recip\n",
1926 "Date: ".strftime("%a, %d %b %Y %H:%M:%S %z",localtime)."\n",
1927 "Subject: {IPDB} $subj\n",
1928 "X-Mailer: IPDB Notify v".sprintf("%.1d",$IPDB::VERSION)."\n",
1929 "Organization: $org_name\n",
1930 "\n$message\n");
1931 }
1932 $mailer->quit;
1933}
1934
1935# Indicates module loaded OK. Required by Perl.
19361;
Note: See TracBrowser for help on using the repository browser.