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

Last change on this file since 691 was 691, checked in by Kris Deugau, 10 years ago

/trunk

Expose VRF field, and add a similar VLAN field (see #10).
  • Property svn:keywords set to Date Rev Author
File size: 67.1 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-06 22:42:26 +0000 (Fri, 06 Feb 2015) $
6# SVN revision $Rev: 691 $
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("SELECT cidr,id FROM freeblocks WHERE parent_id = ? ORDER BY cidr");
677# $sth->execute($args{parent}, $args{vrf});
678 $sth->execute($args{parent});
679 my @flist;
680 while (my ($cidr,$id) = $sth->fetchrow_array()) {
681 $cidr = new NetAddr::IP $cidr;
682 my %row = (
683 fblock => "$cidr",
684 frange => $cidr->range,
685 fbid => $id,
686 fbparent => $args{parent},
687 );
688 push @flist, \%row;
689 }
690 return \@flist;
691} # end listFree()
692
693
694## IPDB::listPool()
695#
696sub listPool {
697 my $dbh = shift;
698 my $pool = shift;
699
700 my $sth = $dbh->prepare("SELECT ip,custid,available,description,type,id".
701 " FROM poolips WHERE parent_id = ? ORDER BY ip");
702 $sth->execute($pool);
703 my @poolips;
704 while (my ($ip,$custid,$available,$desc,$type,$id) = $sth->fetchrow_array) {
705 my %row = (
706 ip => $ip,
707 custid => $custid,
708 available => $available,
709 desc => $desc,
710 delme => $available eq 'n',
711 parent => $pool,
712 id => $id,
713 );
714 push @poolips, \%row;
715 }
716 return \@poolips;
717} # end listPool()
718
719
720## IPDB::getMasterList()
721# Get a list of master blocks, optionally including last-modified timestamps
722# Takes an optional flag to indicate whether to include timestamps;
723# 'm' includes ctime, all others (suggest 'c') do not.
724# Returns an arrayref to a list of hashrefs
725sub getMasterList {
726 my $dbh = shift;
727 my $stampme = shift || 'm'; # optional but should be set by caller for clarity
728
729 my $mlist = $dbh->selectall_arrayref("SELECT id,vrf,cidr AS master".($stampme eq 'm' ? ',modifystamp AS mtime' : '').
730 " FROM allocations WHERE type='mm' ORDER BY cidr", { Slice => {} });
731 return $mlist;
732} # end getMasterList()
733
734
735## IPDB::getTypeList()
736# Get an alloctype/description pair list suitable for dropdowns
737# Takes a flag to determine which general groups of types are returned
738# Returns an reference to an array of hashrefs
739sub getTypeList {
740 my $dbh = shift;
741 my $tgroup = shift || 'a'; # technically optional, like this, but should
742 # really be specified in the call for clarity
743 my $tlist;
744 if ($tgroup eq 'n') {
745 # grouping 'p' - all netblock types. These include routed blocks, containers (_c)
746 # and contained (_r) types, dynamic-allocation ranges (_e), static IP pools (_d and _p),
747 # and the "miscellaneous" cn, in, and en types.
748 $tlist = $dbh->selectall_arrayref("SELECT type,listname FROM alloctypes WHERE listorder <= 500 ".
749 "AND type NOT LIKE '_i' ORDER BY listorder", { Slice => {} });
750 } elsif ($tgroup eq 'p') {
751 # grouping 'p' - primary allocation types. As with 'n' above but without the _r contained types.
752 $tlist = $dbh->selectall_arrayref("SELECT type,listname FROM alloctypes WHERE listorder <= 500 ".
753 "AND type NOT LIKE '_i' AND type NOT LIKE '_r' ORDER BY listorder", { Slice => {} });
754 } elsif ($tgroup eq 'c') {
755 # grouping 'c' - contained types. These include all static IPs and all _r types.
756 $tlist = $dbh->selectall_arrayref("SELECT type,listname FROM alloctypes WHERE listorder <= 500 ".
757 " AND (type LIKE '_i' OR type LIKE '_r') ORDER BY listorder", { Slice => {} });
758 } elsif ($tgroup eq 'i') {
759 # grouping 'i' - static IP types.
760 $tlist = $dbh->selectall_arrayref("SELECT type,listname FROM alloctypes WHERE listorder <= 500 ".
761 " AND type LIKE '_i' ORDER BY listorder", { Slice => {} });
762 } else {
763 # grouping 'a' - all standard allocation types. This includes everything
764 # but mm (present only as a formality). Make this the default.
765 $tlist = $dbh->selectall_arrayref("SELECT type,listname FROM alloctypes WHERE listorder <= 500 ".
766 " ORDER BY listorder", { Slice => {} });
767 }
768 return $tlist;
769}
770
771
772## IPDB::getPoolSelect()
773# Get a list of pools matching the passed city and type that have 1 or more free IPs
774# Returns an arrayref to a list of hashrefs
775sub getPoolSelect {
776 my $dbh = shift;
777 my $iptype = shift;
778 my $pcity = shift;
779
780 my ($ptype) = ($iptype =~ /^(.)i$/);
781 return if !$ptype;
782 $ptype .= '_';
783
784 my $plist = $dbh->selectall_arrayref( q(
785 SELECT count(*) AS poolfree,p.pool AS poolblock, a.city AS poolcit
786 FROM poolips p
787 JOIN allocations a ON p.parent_id=a.id
788 WHERE p.available='y' AND a.city = ? AND p.type LIKE ?
789 GROUP BY p.pool,a.city
790 ),
791 { Slice => {} }, ($pcity, $ptype) );
792 return $plist;
793} # end getPoolSelect()
794
795
796## IPDB::findAllocateFrom()
797# Find free block to add a new allocation from. (CIDR block version of pool select above, more or less)
798# Takes
799# - mask length
800# - allocation type
801# - POP city "parent"
802# - optional master-block restriction
803# - optional flag to allow automatic pick-from-private-network-ranges
804# Returns a string with the first CIDR block matching the criteria, if any
805sub findAllocateFrom {
806 my $dbh = shift;
807 my $maskbits = shift;
808 my $type = shift;
809 my $city = shift;
810 my $pop = shift;
811 my %optargs = @_;
812
813 my $failmsg = "No suitable free block found\n";
814
815 my @vallist;
816 my $sql;
817
818 # Free pool IPs should be easy.
819 if ($type =~ /^.i$/) {
820 # User may get an IP from the wrong VRF. User should not be using admin tools to allocate static IPs.
821 $sql = "SELECT id, ip, parent_id FROM poolips WHERE ip = ?";
822 @vallist = ($optargs{gimme});
823 } else {
824
825## Set up the SQL to find out what freeblock we can (probably) use for an allocation.
826## Very large systems will require development of a reserve system (possibly an extension
827## of the reserve-for-expansion concept in https://secure.deepnet.cx/trac/ipdb/ticket/24?)
828## Also populate a value list for the DBI call.
829
830 @vallist = ($maskbits);
831 $sql = "SELECT id,cidr,parent_id FROM freeblocks WHERE masklen(cidr) <= ?";
832
833# cases, strict rules
834# .c -> container type
835# requires a routing container, fbtype r
836# .d -> DHCP/"normal-routing" static pool
837# requires a routing container, fbtype r
838# .e -> Dynamic-assignment connectivity
839# requires a routing container, fbtype r
840# .i -> error, can't allocate static IPs this way?
841# mm -> error, master block
842# rm -> routed block
843# requires master block, fbtype m
844# .n -> Miscellaneous usage
845# requires a routing container, fbtype r
846# .p -> PPP(oE) static pool
847# requires a routing container, fbtype r
848# .r -> contained type
849# requires a matching container, fbtype $1
850##fixme: strict-or-not flag
851
852##fixme: config or UI flag for "Strict" mode
853# if ($strictmode) {
854if (0) {
855 if ($type =~ /^(.)r$/) {
856 push @vallist, $1;
857 $sql .= " AND routed = ?";
858 } elsif ($type eq 'rm') {
859 $sql .= " AND routed = 'm'";
860 } else {
861 $sql .= " AND routed = 'r'";
862 }
863}
864
865 # for PPP(oE) and container types, the POP city is the one attached to the pool.
866 # individual allocations get listed with the customer city site.
867 ##fixme: chain cities to align roughly with a full layer-2 node graph
868 $city = $pop if $type !~ /^.[pc]$/;
869 if ($type ne 'rm' && $city) {
870 $sql .= " AND city = ?";
871 push @vallist, $city;
872 }
873 # Allow specifying an arbitrary full block, instead of a master
874 if ($optargs{gimme}) {
875 $sql .= " AND cidr >>= ?";
876 push @vallist, $optargs{gimme};
877 }
878 # if a specific master was requested, allow the requestor to self->shoot(foot)
879 if ($optargs{master} && $optargs{master} ne '-') {
880 $sql .= " AND master_id = ?";
881# if $optargs{master} ne '-';
882 push @vallist, $optargs{master};
883 } else {
884 # if a specific master was NOT requested, filter out the RFC 1918 private networks
885 if (!$optargs{allowpriv}) {
886 $sql .= " AND NOT (cidr <<= '192.168.0.0/16' OR cidr <<= '10.0.0.0/8' OR cidr <<= '172.16.0.0/12')";
887 }
888 }
889 # Sorting and limiting, since we don't (currently) care to provide a selection of
890 # blocks to carve up. This preserves something resembling optimal usage of the IP
891 # space by forcing contiguous allocations and free blocks as much as possible.
892 $sql .= " ORDER BY masklen(cidr) DESC,cidr LIMIT 1";
893 } # done setting up SQL for free CIDR block
894
895 my ($fbid,$fbfound,$fbparent) = $dbh->selectrow_array($sql, undef, @vallist);
896 return $fbid,$fbfound,$fbparent;
897} # end findAllocateFrom()
898
899
900## IPDB::ipParent()
901# Get an IP's parent pool's details
902# Takes a database handle and IP
903# Returns a hashref to the parent pool block, if any
904sub ipParent {
905 my $dbh = shift;
906 my $block = shift;
907
908 my $pinfo = $dbh->selectrow_hashref("SELECT cidr,custid,type,city,description FROM allocations".
909 " WHERE cidr >>= ? AND (type LIKE '_p' OR type LIKE '_d')", undef, ($block) );
910 return $pinfo;
911} # end ipParent()
912
913
914## IPDB::subParent()
915# Get a block's parent's details
916# Takes a database handle and CIDR block
917# Returns a hashref to the parent container block, if any
918sub subParent {
919 my $dbh = shift;
920 my $block = shift;
921
922 my $pinfo = $dbh->selectrow_hashref("SELECT cidr,custid,type,city,description FROM allocations".
923 " WHERE cidr >>= ?", undef, ($block) );
924 return $pinfo;
925} # end subParent()
926
927
928## IPDB::blockParent()
929# Get a block's parent's details
930# Takes a database handle and CIDR block
931# Returns a hashref to the parent container block, if any
932sub blockParent {
933 my $dbh = shift;
934 my $block = shift;
935
936 my $pinfo = $dbh->selectrow_hashref("SELECT cidr,city FROM routed".
937 " WHERE cidr >>= ?", undef, ($block) );
938 return $pinfo;
939} # end blockParent()
940
941
942## IPDB::getRoutedCity()
943# Get the city for a routed block.
944sub getRoutedCity {
945 my $dbh = shift;
946 my $block = shift;
947
948 my ($rcity) = $dbh->selectrow_array("SELECT city FROM routed WHERE cidr = ?", undef, ($block) );
949 return $rcity;
950} # end getRoutedCity()
951
952
953## IPDB::allocateBlock()
954# Does all of the magic of actually allocating a netblock
955# Requires a database handle, and a hash containing the block to allocate, routing depth, custid,
956# type, city, block to allocate from, and optionally a description, notes, circuit ID,
957# and private data
958# Returns a success code and optional error message.
959sub allocateBlock {
960 my $dbh = shift;
961
962 my %args = @_;
963
964 $args{cidr} = new NetAddr::IP $args{cidr};
965
966 $args{desc} = '' if !$args{desc};
967 $args{notes} = '' if !$args{notes};
968 $args{circid} = '' if !$args{circid};
969 $args{privdata} = '' if !$args{privdata};
970 $args{vrf} = '' if !$args{vrf};
971 $args{vlan} = '' if !$args{vlan};
972 $args{rdns} = '' if !$args{rdns};
973
974 # Could arguably allow this for eg /120 allocations, but end users who get a single v4 IP are
975 # usually given a v6 /64, and most v6 addressing schemes need at least half that address space
976 if ($args{cidr}->{isv6} && $args{rdns} =~ /\%/) {
977 return ('FAIL','Reverse DNS template patterns are not supported for IPv6 allocations');
978 }
979
980 my $sth;
981
982 # Snag the "type" of the freeblock and its CIDR
983 my ($alloc_from_type, $alloc_from, $fbparent, $fcity, $fbmaster) =
984 $dbh->selectrow_array("SELECT routed,cidr,parent_id,city,master_id FROM freeblocks WHERE id = ?",
985 undef, $args{fbid});
986 $alloc_from = new NetAddr::IP $alloc_from;
987
988 # To contain the error message, if any.
989 my $msg = "Unknown error allocating $args{cidr} as '$disp_alloctypes{$args{type}}'";
990
991 # Enable transactions and error handling
992 local $dbh->{AutoCommit} = 0; # These need to be local so we don't
993 local $dbh->{RaiseError} = 1; # step on our toes by accident.
994
995 if ($args{type} =~ /^.i$/) {
996 $msg = "Unable to assign static IP $args{cidr} to $args{custid}";
997 eval {
998 if ($args{cidr}) { # IP specified
999 my ($isavail) = $dbh->selectrow_array("SELECT available FROM poolips WHERE ip=?", undef, ($args{cidr}) );
1000 die "IP is not in an IP pool.\n"
1001 if !$isavail;
1002 die "IP already allocated. Deallocate and reallocate, or update the entry\n"
1003 if $isavail eq 'n';
1004 } else { # IP not specified, take first available
1005 ($args{cidr}) = $dbh->selectrow_array("SELECT ip FROM poolips WHERE pool=? AND available='y' ORDER BY ip",
1006 undef, ($args{alloc_from}) );
1007 }
1008 $dbh->do("UPDATE poolips SET custid = ?, city = ?,available='n', description = ?, notes = ?, ".
1009 "circuitid = ?, privdata = ?, vrf = ?, rdns = ? ".
1010 "WHERE ip = ? AND parent_id = ?", undef,
1011 ($args{custid}, $args{city}, $args{desc}, $args{notes},
1012 $args{circid}, $args{privdata}, $args{vrf}, $args{rdns},
1013 $args{cidr}, $args{parent}) );
1014
1015# node hack
1016 if ($args{nodeid} && $args{nodeid} ne '') {
1017 $dbh->do("INSERT INTO noderef (block,node_id) VALUES (?,?)", undef, ($args{cidr}, $args{nodeid}) );
1018 }
1019# end node hack
1020
1021 $dbh->commit; # Allocate IP from pool
1022 };
1023 if ($@) {
1024 $msg .= ": $@";
1025 eval { $dbh->rollback; };
1026 return ('FAIL', $msg);
1027 } else {
1028 _rpc('addOrUpdateRevRec', cidr => "$args{cidr}", name => $args{rdns}, rpcuser => $args{user});
1029 return ('OK', $args{cidr});
1030 }
1031
1032 } else { # end IP-from-pool allocation
1033
1034 if ($args{cidr} == $alloc_from) {
1035 # Easiest case- insert in one table, delete in the other, and go home. More or less.
1036 # insert into allocations values (cidr,custid,type,city,desc) and
1037 # delete from freeblocks where cidr='cidr'
1038 # For data safety on non-transaction DBs, we delete first.
1039
1040 eval {
1041 $msg = "Unable to allocate $args{cidr} as '$disp_alloctypes{$args{type}}'";
1042
1043 # Insert the allocations entry
1044 $dbh->do("INSERT INTO allocations ".
1045 "(cidr,parent_id,master_id,vrf,vlan,custid,type,city,description,notes,circuitid,privdata,rdns)".
1046 " VALUES (?,?,?,?,?,?,?,?,?,?,?,?,?)", undef,
1047 ($args{cidr}, $fbparent, $fbmaster, $args{vrf}, $args{vlan}, $args{custid}, $args{type}, $args{city},
1048 $args{desc}, $args{notes}, $args{circid}, $args{privdata}, $args{rdns}) );
1049 my ($bid) = $dbh->selectrow_array("SELECT currval('allocations_id_seq')");
1050
1051 # Munge freeblocks
1052 if ($args{type} =~ /^(.)[mc]$/) {
1053 # special case - block is a routed or container/"reserve" block
1054 my $rtype = $1;
1055 $dbh->do("UPDATE freeblocks SET routed = ?,city = ?,parent_id = ? WHERE id = ?",
1056 undef, ($rtype, $args{city}, $bid, $args{fbid}) );
1057 } else {
1058 # "normal" case
1059 $dbh->do("DELETE FROM freeblocks WHERE id = ?", undef, ($args{fbid}) );
1060 }
1061
1062 # And initialize the pool, if necessary
1063 # PPPoE pools (currently dialup, DSL, and WiFi) get all IPs made available
1064 # "DHCP" or "real-subnet" pools have the net, gw, and bcast IPs removed.
1065 if ($args{type} =~ /^.p$/) {
1066 $msg = "Could not initialize IPs in new $disp_alloctypes{$args{type}} $args{cidr}";
1067 my ($code,$rmsg) = initPool($dbh, $args{cidr}, $args{type}, $args{city}, "all", $bid);
1068 die $rmsg if $code eq 'FAIL';
1069 } elsif ($args{type} =~ /^.d$/) {
1070 $msg = "Could not initialize IPs in new $disp_alloctypes{$args{type}} $args{cidr}";
1071 my ($code,$rmsg) = initPool($dbh, $args{cidr}, $args{type}, $args{city}, "normal", $bid);
1072 die $rmsg if $code eq 'FAIL';
1073 }
1074
1075# node hack
1076 if ($args{nodeid} && $args{nodeid} ne '') {
1077 $dbh->do("INSERT INTO noderef (block,node_id) VALUES (?,?)", undef, ($args{cidr}, $args{nodeid}) );
1078 }
1079# end node hack
1080
1081 $dbh->commit; # Simple block allocation
1082 }; # end of eval
1083 if ($@) {
1084 $msg .= ": ".$@;
1085 eval { $dbh->rollback; };
1086 return ('FAIL',$msg);
1087 }
1088
1089 } else { # cidr != alloc_from
1090
1091 # Hard case. Allocation is smaller than free block.
1092
1093 # make sure new allocation is in fact within freeblock. *sigh*
1094 return ('FAIL',"Requested allocation $args{cidr} is not within $alloc_from")
1095 if !$alloc_from->contains($args{cidr});
1096 my $wantmaskbits = $args{cidr}->masklen;
1097 my $maskbits = $alloc_from->masklen;
1098
1099 my @newfreeblocks; # Holds free blocks generated from splitting the source freeblock.
1100
1101 # This determines which blocks will be left "free" after allocation. We take the
1102 # block we're allocating from, and split it in half. We see which half the wanted
1103 # block is in, and repeat until the wanted block is equal to one of the halves.
1104 my $i=0;
1105 my $tmp_from = $alloc_from; # So we don't munge $args{alloc_from}
1106 while ($maskbits++ < $wantmaskbits) {
1107 my @subblocks = $tmp_from->split($maskbits);
1108 $newfreeblocks[$i++] = (($args{cidr}->within($subblocks[0])) ? $subblocks[1] : $subblocks[0]);
1109 $tmp_from = ( ($args{cidr}->within($subblocks[0])) ? $subblocks[0] : $subblocks[1] );
1110 } # while
1111
1112 # Begin SQL transaction block
1113 eval {
1114 $msg = "Unable to allocate $args{cidr} as '$disp_alloctypes{$args{type}}'";
1115
1116 # Delete old freeblocks entry
1117 $dbh->do("DELETE FROM freeblocks WHERE id = ?", undef, ($args{fbid}) );
1118
1119 # Insert new list of smaller free blocks left over
1120 $sth = $dbh->prepare("INSERT INTO freeblocks (cidr,city,routed,vrf,parent_id,master_id) VALUES (?,?,?,?,?,?)");
1121 foreach my $block (@newfreeblocks) {
1122 $sth->execute($block, $fcity, $alloc_from_type, $args{vrf}, $fbparent, $fbmaster);
1123 }
1124
1125 # Insert the allocations entry
1126 $dbh->do("INSERT INTO allocations ".
1127 "(cidr,parent_id,master_id,vrf,vlan,custid,type,city,description,notes,circuitid,privdata,rdns)".
1128 " VALUES (?,?,?,?,?,?,?,?,?,?,?,?,?)", undef,
1129 ($args{cidr}, $fbparent, $fbmaster, $args{vrf}, $args{vlan}, $args{custid}, $args{type}, $args{city},
1130 $args{desc}, $args{notes}, $args{circid}, $args{privdata}, $args{rdns}) );
1131 my ($bid) = $dbh->selectrow_array("SELECT currval('allocations_id_seq')");
1132
1133 # For routed/container types, add a freeblock within the allocated block so we can subdivide it further
1134 if ($args{type} =~ /(.)[mc]/) { # rm and .c types - containers
1135 my $rtype = $1;
1136 $sth->execute($args{cidr}, $args{city}, $rtype, $args{vrf}, $bid, $fbmaster);
1137 }
1138
1139 # And initialize the pool, if necessary
1140 # PPPoE pools (currently dialup, DSL, and WiFi) get all IPs made available
1141 # "DHCP" or "real-subnet" pools have the net, gw, and bcast IPs removed.
1142 if ($args{type} =~ /^.p$/) {
1143 $msg = "Could not initialize IPs in new $disp_alloctypes{$args{type}} $args{cidr}";
1144 my ($code,$rmsg) = initPool($dbh, $args{cidr}, $args{type}, $args{city}, "all", $bid);
1145 die $rmsg if $code eq 'FAIL';
1146 } elsif ($args{type} =~ /^.d$/) {
1147 $msg = "Could not initialize IPs in new $disp_alloctypes{$args{type}} $args{cidr}";
1148 my ($code,$rmsg) = initPool($dbh, $args{cidr}, $args{type}, $args{city}, "normal", $bid);
1149 die $rmsg if $code eq 'FAIL';
1150 }
1151
1152# node hack
1153 if ($args{nodeid} && $args{nodeid} ne '') {
1154 $dbh->do("INSERT INTO noderef (block,node_id) VALUES (?,?)", undef, ($args{cidr}, $args{nodeid}) );
1155 }
1156# end node hack
1157
1158 $dbh->commit; # Complex block allocation
1159 }; # end eval
1160 if ($@) {
1161 $msg .= ": ".$@;
1162 eval { $dbh->rollback; };
1163 return ('FAIL',$msg);
1164 }
1165
1166 } # end fullcidr != alloc_from
1167
1168 # now we do the DNS dance for netblocks, if we have an RPC server to do it with and a pattern to use.
1169 _rpc('addOrUpdateRevRec', cidr => "$args{cidr}", name => $args{rdns}, rpcuser => $args{user})
1170 if $args{rdns};
1171
1172 # and the per-IP set, if there is one.
1173 _rpc('updateRevSet', %{$args{iprev}}, rpcuser => $args{user});
1174
1175 return ('OK', 'OK');
1176
1177 } # end static-IP vs netblock allocation
1178
1179} # end allocateBlock()
1180
1181
1182## IPDB::initPool()
1183# Initializes a pool
1184# Requires a database handle, the pool CIDR, type, city, and a parameter
1185# indicating whether the pool should allow allocation of literally every
1186# IP, or if it should reserve network/gateway/broadcast IPs
1187# Note that this is NOT done in a transaction, that's why it's a private
1188# function and should ONLY EVER get called from allocateBlock()
1189sub initPool {
1190 my ($dbh,undef,$type,$city,$class,$parent) = @_;
1191 my $pool = new NetAddr::IP $_[1];
1192
1193 # IPv6 does not lend itself to IP pools as supported
1194 return ('FAIL',"Refusing to create IPv6 static IP pool") if $pool->{isv6};
1195 # IPv4 pools don't make much sense beyond even /24. Allow up to 4096-host footshooting anyway.
1196 # NetAddr::IP won't allow more than a /16 (65k hosts).
1197 return ('FAIL',"Refusing to create oversized static IP pool") if $pool->masklen <= 20;
1198
1199 # Retrieve some odds and ends for defaults on the IPs
1200 my ($pcustid) = $dbh->selectrow_array("SELECT def_custid FROM alloctypes WHERE type=?", undef, ($type) );
1201 my ($vrf,$vlan) = $dbh->selectrow_array("SELECT vrf,vlan FROM allocations WHERE allocation_id = ?",
1202 undef, ($parent) );
1203
1204 $type =~ s/[pd]$/i/;
1205 my $sth;
1206 my $msg;
1207
1208 # Trap errors so we can pass them back to the caller. Even if the
1209 # caller is only ever supposed to be local, and therefore already
1210 # trapping errors. >:(
1211 local $dbh->{AutoCommit} = 0; # These need to be local so we don't
1212 local $dbh->{RaiseError} = 1; # step on our toes by accident.
1213
1214 eval {
1215 # have to insert all pool IPs into poolips table as "unallocated".
1216 $sth = $dbh->prepare("INSERT INTO poolips (ip,custid,city,type,parent_id) VALUES (?,?,?,?,?)");
1217 my @poolip_list = $pool->hostenum;
1218 if ($class eq 'all') { # (DSL-ish block - *all* IPs available
1219 if ($pool->addr !~ /\.0$/) { # .0 causes weirdness.
1220 $sth->execute($pool->addr, $pcustid, $city, $type, $parent);
1221 }
1222 for (my $i=0; $i<=$#poolip_list; $i++) {
1223 $sth->execute($poolip_list[$i]->addr, $pcustid, $city, $type, $parent);
1224 }
1225 $pool--;
1226 if ($pool->addr !~ /\.255$/) { # .255 can cause weirdness.
1227 $sth->execute($pool->addr, $pcustid, $city, $type, $parent);
1228 }
1229 } else { # (real netblock)
1230 for (my $i=1; $i<=$#poolip_list; $i++) {
1231 $sth->execute($poolip_list[$i]->addr, $pcustid, $city, $type, $parent);
1232 }
1233 }
1234# don't commit here! the caller may not be done.
1235# $dbh->commit;
1236 };
1237 if ($@) {
1238 $msg = $@;
1239# Don't roll back! It's up to the caller to handle this.
1240# eval { $dbh->rollback; };
1241 return ('FAIL',$msg);
1242 } else {
1243 return ('OK',"OK");
1244 }
1245} # end initPool()
1246
1247
1248## IPDB::updateBlock()
1249# Update an allocation
1250# Takes all allocation fields in a hash
1251sub updateBlock {
1252 my $dbh = shift;
1253 my %args = @_;
1254
1255 return ('FAIL', 'Missing block to update') if !$args{block};
1256
1257 # Spaces don't show up well in lots of places. Make sure they don't get into the DB.
1258 $args{custid} =~ s/^\s+//;
1259 $args{custid} =~ s/\s+$//;
1260
1261 # do it all in a transaction
1262 local $dbh->{AutoCommit} = 0;
1263 local $dbh->{RaiseError} = 1;
1264
1265 my @fieldlist;
1266 my @vallist;
1267 foreach ('custid', 'city', 'description', 'notes', 'circuitid', 'privdata', 'rdns', 'vrf', 'vlan') {
1268 if ($args{$_}) {
1269 push @fieldlist, $_;
1270 push @vallist, $args{$_};
1271 }
1272 }
1273
1274 my $binfo;
1275 my $updtable = 'allocations';
1276 my $keyfield = 'id';
1277 if ($args{type} =~ /^(.)i$/) {
1278 $updtable = 'poolips';
1279 $binfo = getBlockData($dbh, $args{block}, 'i');
1280 } else {
1281## fixme: there's got to be a better way...
1282 $binfo = getBlockData($dbh, $args{block});
1283 if ($args{swip}) {
1284 if ($args{swip} eq 'on' || $args{swip} eq '1' || $args{swip} eq 'y') {
1285 $args{swip} = 'y';
1286 } else {
1287 $args{swip} = 'n';
1288 }
1289 }
1290 foreach ('type', 'swip') {
1291 if ($args{$_}) {
1292 push @fieldlist, $_;
1293 push @vallist, $args{$_};
1294 }
1295 }
1296 }
1297
1298 return ('FAIL', 'No fields to update') if !@fieldlist;
1299
1300 push @vallist, $args{block};
1301 my $sql = "UPDATE $updtable SET ";
1302 $sql .= join " = ?, ", @fieldlist;
1303 $sql .= " = ? WHERE $keyfield = ?";
1304
1305 eval {
1306 # do the update
1307 $dbh->do($sql, undef, @vallist);
1308
1309 if ($args{node}) {
1310 # done with delete/insert so we don't have to worry about funkyness updating a node ref that isn't there
1311 $dbh->do("DELETE FROM noderef WHERE block = ?", undef, ($binfo->{block}) );
1312 $dbh->do("INSERT INTO noderef (block,node_id) VALUES (?,?)", undef, ($binfo->{block}, $args{node}) )
1313 if $args{node} ne '--';
1314 }
1315
1316 $dbh->commit;
1317 };
1318 if ($@) {
1319 my $msg = $@;
1320 $dbh->rollback;
1321 return ('FAIL', $msg);
1322 }
1323
1324 # In case of any container (mainly master block), only update freeblocks so we don't stomp subs
1325 # (which would be the wrong thing in pretty much any case except "DELETE ALL EVARYTHING!!1!oneone!")
1326 if ($binfo->{type} =~ '.[mc]') {
1327 # Not using listFree() as it doesn't return quite all of the blocks wanted.
1328 # Retrieve the immediate free blocks
1329 my $sth = $dbh->prepare(q(
1330 SELECT cidr FROM freeblocks WHERE parent_id = ?
1331 UNION
1332 SELECT cidr FROM freeblocks f WHERE
1333 cidr = (SELECT cidr FROM allocations a WHERE f.cidr = a.cidr)
1334 AND master_id = ?
1335 ) );
1336 $sth->execute($args{block}, $binfo->{master_id});
1337 my %fbset;
1338 while (my ($fb) = $sth->fetchrow_array) {
1339 $fbset{"host_$fb"} = $args{rdns};
1340 }
1341 # We use this RPC call instead of multiple addOrUpdateRevRec calls, since we don't
1342 # know how many records we'll be updating and more than 3-4 is far too slow. This
1343 # should be safe to call unconditionally.
1344 # Requires dnsadmin >= r678
1345 _rpc('updateRevSet', %fbset, rpcuser => $args{user});
1346
1347 } else {
1348 $binfo->{block} =~ s|/32$||;
1349 _rpc('addOrUpdateRevRec', cidr => $binfo->{block}, name => $args{rdns}, rpcuser => $args{user});
1350
1351 # and the per-IP set, if there is one.
1352 _rpc('updateRevSet', %{$args{iprev}}, rpcuser => $args{user}) if keys (%{$args{iprev}});
1353 }
1354
1355 return ('OK','OK');
1356} # end updateBlock()
1357
1358
1359## IPDB::deleteBlock()
1360# Removes an allocation from the database, including deleting IPs
1361# from poolips and recombining entries in freeblocks if possible
1362# Also handles "deleting" a static IP allocation, and removal of a master
1363# Requires a database handle, the block to delete, the routing depth (if applicable),
1364# the VRF ID, and a flag to indicate whether to delete associated forward DNS entries
1365# as well as the reverse entry
1366sub deleteBlock {
1367 my ($dbh,$id,$basetype,$delfwd,$user) = @_;
1368
1369 # Collect info about the block we're going to delete
1370 my $binfo = getBlockData($dbh, $id, $basetype);
1371 my $cidr = new NetAddr::IP $binfo->{block};
1372
1373# For possible auto-VRF-ignoring (since public IPs shouldn't usually be present in more than one VRF)
1374# is_rfc1918 requires NetAddr::IP >= 4.059
1375# rather than doing this over and over and over.....
1376 my $tmpnum = $cidr->numeric;
1377# 192.168.0.0/16 -> 192.168.255.255 => 3232235520 -> 3232301055
1378# 172.16.0.0/12 -> 172.31.255.255 => 2886729728 -> 2887778303
1379# 10.0.0.0/8 -> 10.255.255.255 => 167772160 -> 184549375
1380 my $isprivnet = (3232235520 <= $tmpnum && $tmpnum <= 3232301055) ||
1381 (2886729728 <= $tmpnum && $tmpnum <= 2887778303) ||
1382 (167772160 <= $tmpnum && $tmpnum <= 184549375);
1383
1384 my $sth;
1385
1386 # Magic variables used for odd allocation cases.
1387 my $container;
1388 my $con_type;
1389
1390
1391 # temporarily forced null, until a sane UI for VRF tracking can be found.
1392# $vrf = '';# if !$vrf; # as with SQL, the null value is not equal to ''. *sigh*
1393
1394 # To contain the error message, if any.
1395 my $msg = "Unknown error deallocating $binfo->{type} $cidr";
1396 my $goback; # to put the parent in so we can link back where the deallocate started
1397
1398 # Enable transactions and exception-on-errors... but only for this sub
1399 local $dbh->{AutoCommit} = 0;
1400 local $dbh->{RaiseError} = 1;
1401
1402 if ($binfo->{type} =~ /^.i$/) {
1403 # First case. The "block" is a static IP
1404 # Note that we still need some additional code in the odd case
1405 # of a netblock-aligned contiguous group of static IPs
1406
1407 eval {
1408 $msg = "Unable to deallocate $disp_alloctypes{$binfo->{type}} $cidr";
1409 my $pinfo = getBlockData($dbh, $binfo->{parent_id}, 'b');
1410##fixme: VRF and rdepth
1411 $dbh->do("UPDATE poolips SET custid = ?, available = 'y',".
1412 "city = (SELECT city FROM allocations WHERE id = ?),".
1413 "description = '', notes = '', circuitid = '', vrf = ? WHERE id = ?", undef,
1414 ($pinfo->{custid}, $binfo->{parent_id}, $pinfo->{vrf}, $id) );
1415 $dbh->commit;
1416 };
1417 if ($@) {
1418 $msg .= ": $@";
1419 eval { $dbh->rollback; };
1420 return ('FAIL',$msg);
1421 } else {
1422##fixme: RPC return code?
1423 _rpc('delByCIDR', cidr => "$cidr", user => $user, delforward => $delfwd, rpcuser => $user);
1424 return ('OK',"OK");
1425 }
1426
1427 } elsif ($binfo->{type} eq 'mm') { # end alloctype =~ /.i/
1428 # Second case. The block is a full master block
1429
1430##fixme: VRF limit
1431 $msg = "Unable to delete master block $cidr";
1432 eval {
1433 $dbh->do("DELETE FROM allocations WHERE cidr <<= ? AND master_id = ?", undef, ($cidr, $binfo->{master_id}) );
1434 $dbh->do("DELETE FROM freeblocks WHERE cidr <<= ? AND master_id = ?", undef, ($cidr, $binfo->{master_id}) );
1435 $dbh->commit;
1436 };
1437 if ($@) {
1438 $msg .= ": $@";
1439 eval { $dbh->rollback; };
1440 return ('FAIL', $msg);
1441 }
1442
1443 # Have to handle potentially split reverse zones. Assume they *are* split,
1444 # since if we added them here, they would have been added split.
1445# allow splitting reverse zones to be disabled, maybe, someday
1446#if ($splitrevzones && !$cidr->{isv6}) {
1447 my @zonelist;
1448 if (1 && !$cidr->{isv6}) {
1449 my $splitpoint = ($cidr->masklen <= 16 ? 16 : 24); # hack pthui
1450 @zonelist = $cidr->split($splitpoint);
1451 } else {
1452 @zonelist = ($cidr);
1453 }
1454 my @fails;
1455 foreach my $subzone (@zonelist) {
1456 if ($rpc_url && !_rpc('delZone', zone => "$subzone", revrec => 'y', rpcuser => $user, delforward => $delfwd) ) {
1457 push @fails, ("$subzone" => $errstr);
1458 }
1459 }
1460 if (@fails) {
1461 return ('WARN',"Warning(s) deleting $cidr from reverse DNS:\n".join("\n", @fails));
1462 }
1463 return ('OK','OK');
1464
1465 } else { # end alloctype master block case
1466
1467 ## This is a big block; but it HAS to be done in a chunk. Any removal
1468 ## of a netblock allocation may result in a larger chunk of free
1469 ## contiguous IP space - which may in turn be combined into a single
1470 ## netblock rather than a number of smaller netblocks.
1471
1472 my $retcode = 'OK';
1473 my ($ptype,$pcity,$ppatt,$p_id);
1474
1475 eval {
1476
1477##fixme: add recursive flag to allow "YES DAMMIT DELETE ALL EVARYTHING!!1!!" without
1478# explicitly deleting any suballocations of the block to be deleted.
1479
1480 # get parent info of the block we're deleting
1481 my $pinfo = getBlockData($dbh, $binfo->{parent_id});
1482 $ptype = $pinfo->{type};
1483 $pcity = $pinfo->{city};
1484 $ppatt = $pinfo->{rdns};
1485 $p_id = $binfo->{parent_id};
1486
1487 # Delete the block
1488 $dbh->do("DELETE FROM allocations WHERE id = ?", undef, ($id) );
1489
1490 # munge the parent type a little
1491 $ptype = (split //, $ptype)[1];
1492
1493##fixme: you can't... CAN NOT.... assign the same public IP to multiple things.
1494# 'Net don't work like that, homey. Restrict VRF-uniqueness to private IPs?
1495# -> $isprivnet flag from start of sub
1496
1497 # check to see if any container allocations could be the "true" parent
1498 my ($tparent,$tpar_id,$trtype,$tcity);
1499 $tpar_id = 0;
1500
1501##fixme: this is far simpler in the strict VRF case; we "know" that any allocation
1502# contained by a container is a part of the same allocation tree when the VRF fields are equal.
1503
1504# logic:
1505# For each possible container of $cidr
1506# note the parent id
1507# walk the chain up the parents
1508# if we intersect $cidr's current parent, break
1509# if we've intersected $cidr's current parent
1510# set some variables to track that block
1511# break
1512
1513# Set up part of "is it in the middle of a pool?" check
1514 my $wuzpool = $dbh->selectrow_hashref("SELECT cidr,parent_id,type,city,custid,id FROM allocations ".
1515 "WHERE (type LIKE '_d' OR type LIKE '_p') AND cidr >> ? AND master_id = ?", { Slice => {} },
1516 ($cidr, $binfo->{master_id}) );
1517
1518##fixme?
1519# edge cases not handled, or handled badly:
1520# -> $cidr managed to get to be the entirety of an IP pool
1521
1522 if ($wuzpool && $wuzpool->{id} != $id) {
1523 # we have legacy goo to be purified
1524 # going to ignore nested pools; not possible to create them via API and no current legacy data includes any.
1525
1526 # for convenience
1527 my $poolid = $wuzpool->{id};
1528 my $pool = $wuzpool->{cidr};
1529 my $poolcity = $wuzpool->{city};
1530 my $pooltype = $wuzpool->{type};
1531 my $poolcustid = $wuzpool->{custid};
1532
1533 $retcode = 'WARNPOOL';
1534 $goback = "$poolid,$pool";
1535 # We've already deleted the block, now we have to stuff its IPs into the pool.
1536 $pooltype =~ s/[dp]$/i/; # change type to static IP
1537 my $sth2 = $dbh->prepare("INSERT INTO poolips (ip,city,type,custid,parent_id) VALUES ".
1538 "(?,'$poolcity','$pooltype','$poolcustid',$poolid)");
1539
1540##fixme: need to not insert net, gateway, and bcast on "real netblock" pools (DHCPish)
1541 # don't insert .0
1542 $sth2->execute($cidr->addr) unless $cidr->addr =~ m|\.0$|;
1543 $cidr++;
1544 my $bcast = $cidr->broadcast;
1545 while ($cidr != $bcast) {
1546 $sth2->execute($cidr->addr);
1547 $cidr++;
1548 }
1549 # don't insert .255
1550 $sth2->execute($cidr->addr) unless $cidr->addr =~ m|\.255$|;
1551
1552# Weirdness Happens. $cidr goes read-only somewhere (this is a thing?!?),
1553# causing ->split, ->hostenum, and related methods to explode. O_o
1554# foreach my $ip ($cidr->hostenum) {
1555# $sth2->execute($ip);
1556# }
1557
1558 }
1559
1560## important!
1561# ... or IS IT?
1562# we may have undef'ed $wuzpool above, if the allocation tree $cidr is in doesn't intersect the pool we found
1563#if (!$wuzpool) {
1564
1565 else {
1566
1567# Edge case: Block is the same size as more than one parent level. Should be rare.
1568# - mainly master + first routing. Sorting on parent_id hides the problem pretty well,
1569# but it's likely still possible to fail in particularly well-mangled databases.
1570# The ultimate fix for this may be to resurrect the "routing depth" atrocity. :/
1571 # Get all possible (and probably a number of impossible) containers for $cidr
1572 $sth = $dbh->prepare("SELECT cidr,parent_id,type,city,id FROM allocations ".
1573 "WHERE (type LIKE '_m' OR type LIKE '_c') AND cidr >>= ? AND master_id = ? ".
1574 "ORDER BY masklen(cidr) DESC,parent_id DESC");
1575 $sth->execute($cidr, $binfo->{master_id});
1576
1577 # Quickly get certain fields (simpler than getBlockData()
1578 my $sth2 = $dbh->prepare("SELECT cidr,parent_id,type,city FROM allocations ".
1579 "WHERE (type LIKE '_m' OR type LIKE '_c') AND id = ? AND master_id = ?");
1580
1581 # For each possible container of $cidr...
1582 while (my @data = $sth->fetchrow_array) {
1583 my $i = 0;
1584 # Save some state and set a start point - parent ID of container we're checking
1585 $tparent = $data[0];
1586 my $ppid = $data[1];
1587 $trtype = $data[2];
1588 $tcity = $data[3];
1589 $tpar_id = $data[4];
1590 last if $data[4] == $binfo->{parent_id}; # Preemptively break if we're already in the right place
1591 last if $ppid == $binfo->{parent_id}; # ... or if the parent of the container is the block's parent
1592 while (1) {
1593 # Retrieve bits on that parent ID
1594 $sth2->execute($ppid, $binfo->{master_id});
1595 my @container = $sth2->fetchrow_array;
1596 $ppid = $container[1];
1597 last if $container[1] == 0; # Break if we've hit a master block
1598 last if $ppid == $binfo->{parent_id}; # Break if we've reached the block $cidr is currently in
1599 }
1600 last if $ppid == $binfo->{parent_id};
1601 }
1602
1603 # found an alternate parent; reset some parent-info bits
1604 if ($tpar_id != $binfo->{parent_id}) {
1605 $ptype = (split //, $trtype)[1];
1606 $pcity = $tcity;
1607 $retcode = 'WARNMERGE'; # may be redundant
1608 $p_id = $tpar_id;
1609 }
1610
1611 $goback = "$p_id,$tparent"; # breadcrumb, currently only used in case of live-parent-is-not-true-parent
1612
1613 # Special case - delete pool IPs
1614 if ($binfo->{type} =~ /^.[pd]$/) {
1615 # We have to delete the IPs from the pool listing.
1616##fixme: rdepth? vrf?
1617 $dbh->do("DELETE FROM poolips WHERE parent_id = ?", undef, ($id) );
1618 }
1619
1620 $pinfo = getBlockData($dbh, $p_id);
1621
1622 # If the block wasn't legacy goo embedded in a static pool, we check the
1623 # freeblocks in the identified parent to see if we can combine any of them.
1624
1625 # if the block to be deleted is a container, move its freeblock(s) up a level, and reset their parenting info
1626 if ($binfo->{type} =~ /^.[mc]/) {
1627 # move the freeblocks into the parent
1628 # we don't insert a new freeblock because there could be a live reparented sub.
1629 $dbh->do("UPDATE freeblocks SET parent_id = ?, routed = ?, city = ? WHERE parent_id = ?", undef,
1630 ($p_id, $ptype, $pcity, $id) );
1631 } else {
1632 # ... otherwise, add the freeblock
1633 $dbh->do("INSERT INTO freeblocks (cidr, city, routed, parent_id, master_id) VALUES (?,?,?,?,?)", undef,
1634 ($cidr, $pcity, $ptype, $p_id, $binfo->{master_id}) );
1635 }
1636
1637##fixme: vrf
1638##fixme: simplify since all containers now represent different "layers"/"levels"?
1639 # set up the query to get the list of blocks to try to merge.
1640 $sth = $dbh->prepare("SELECT cidr,id FROM freeblocks ".
1641 "WHERE parent_id = ? ".
1642 "ORDER BY masklen(cidr) DESC");
1643
1644 $sth->execute($p_id);
1645
1646# NetAddr::IP->compact() attempts to produce the smallest inclusive block
1647# from the caller and the passed terms.
1648# EG: if you call $cidr->compact($ip1,$ip2,$ip3) when $cidr, $ip1, $ip2,
1649# and $ip3 are consecutive /27's starting on .0 (.0-.31, .32-.63,
1650# .64-.95, and .96-.128), you will get an array containing a single
1651# /25 as element 0 (.0-.127). Order is not important; you could have
1652# $cidr=.32/27, $ip1=.96/27, $ip2=.0/27, and $ip3=.64/27.
1653
1654 my (@rawfb, @combinelist, %rawid);
1655 my $i=0;
1656 # for each free block under $parent, push a NetAddr::IP object into one list, and
1657 # continuously use NetAddr::IP->compact to automagically merge netblocks as possible.
1658 while (my @data = $sth->fetchrow_array) {
1659 my $testIP = new NetAddr::IP $data[0];
1660 push @rawfb, $testIP;
1661 $rawid{"$testIP"} = $data[1]; # $data[0] vs "$testIP" *does* make a difference for v6
1662 @combinelist = $testIP->compact(@combinelist);
1663 }
1664
1665 # now that we have the full list of "compacted" freeblocks, go back over
1666 # the list of raw freeblocks, and delete the ones that got merged.
1667 $sth = $dbh->prepare("DELETE FROM freeblocks WHERE id = ?");
1668 foreach my $rawfree (@rawfb) {
1669 next if grep { $rawfree == $_ } @combinelist; # skip if the raw block is in the compacted list
1670 $sth->execute($rawid{$rawfree});
1671 }
1672
1673 # now we walk the new list of compacted blocks, and see which ones we need to insert
1674 $sth = $dbh->prepare("INSERT INTO freeblocks (cidr,city,routed,parent_id,master_id) VALUES (?,?,?,?,?)");
1675 foreach my $cme (@combinelist) {
1676 next if grep { $cme == $_ } @rawfb; # skip if the combined block was in the raw list
1677 $sth->execute($cme, $pcity, $ptype, $p_id, $binfo->{master_id});
1678 }
1679
1680 } # done returning IPs to the appropriate place
1681
1682 # If we got here, we've succeeded. Whew!
1683 $dbh->commit;
1684 }; # end eval
1685 if ($@) {
1686 $msg .= ": $@";
1687 eval { $dbh->rollback; };
1688 return ('FAIL', $msg);
1689 } else {
1690##fixme: RPC return code?
1691 _rpc('delByCIDR', cidr => "$cidr", rpcuser => $user, delforward => $delfwd, delsubs => 'y', parpatt => $ppatt);
1692 return ($retcode, $goback);
1693 }
1694
1695 } # end alloctype != netblock
1696
1697} # end deleteBlock()
1698
1699
1700## IPDB::getBlockData()
1701# Get CIDR or IP, custid, type, city, circuit ID, description, notes, modification time,
1702# private/restricted data, for a CIDR block or pool IP
1703# Also returns SWIP status flag for CIDR blocks or pool netblock for IPs
1704# Takes the block ID or IP to look up and an optional flag to indicate a pool IP lookup
1705# instead of a netblock.
1706# Returns a hashref to the block data
1707sub getBlockData {
1708 my $dbh = shift;
1709 my $id = shift;
1710 my $type = shift || 'b'; # default to netblock for lazy callers
1711
1712 # netblocks are in the allocations table; pool IPs are in the poolips table.
1713 # If we try to look up a CIDR in an integer field we should just get back nothing.
1714 my ($btype) = $dbh->selectrow_array("SELECT type FROM allocations WHERE id=?", undef, ($id) );
1715
1716 if ($type eq 'i') {
1717 my $binfo = $dbh->selectrow_hashref("SELECT ip AS block, custid, type, city, circuitid, description,".
1718 " notes, modifystamp AS lastmod, privdata, vrf, vlan, rdns, parent_id, master_id".
1719 " FROM poolips WHERE id = ?", undef, ($id) );
1720 return $binfo;
1721 } else {
1722 my $binfo = $dbh->selectrow_hashref("SELECT cidr AS block, custid, type, city, circuitid, ".
1723 "description, notes, modifystamp AS lastmod, privdata, vrf, vlan, swip, rdns, parent_id, master_id".
1724 " FROM allocations WHERE id = ?", undef, ($id) );
1725 return $binfo;
1726 }
1727} # end getBlockData()
1728
1729
1730## IPDB::getBlockRDNS()
1731# Gets reverse DNS pattern for a block or IP. Note that this will also
1732# retrieve any default pattern following the parent chain up, and check via
1733# RPC (if available) to see what the narrowest pattern for the requested block is
1734# Returns the current pattern for the block or IP.
1735sub getBlockRDNS {
1736 my $dbh = shift;
1737 my %args = @_;
1738
1739 $args{type} = 'b' if !$args{type};
1740 my $cached = 1;
1741
1742 # snag entry from database
1743 my ($rdns,$rfrom,$pid);
1744 if ($args{type} =~ /.i/) {
1745 ($rdns, $rfrom, $pid) = $dbh->selectrow_array("SELECT rdns,ip,parent_id FROM poolips WHERE id = ?",
1746 undef, ($args{id}) );
1747 } else {
1748 ($rdns, $rfrom, $pid) = $dbh->selectrow_array("SELECT rdns,cidr,parent_id FROM allocations WHERE id = ?",
1749 undef, ($args{id}) );
1750 }
1751
1752 # Can't see a way this could end up empty, for any case I care about. If the caller
1753 # doesn't know an allocation ID to request, then they don't know anything else anyway.
1754 my $selfblock = $rfrom;
1755
1756 my $type;
1757 while (!$rdns && $pid) {
1758 ($rdns, $rfrom, $pid, $type) = $dbh->selectrow_array(
1759 "SELECT rdns,cidr,parent_id,type FROM allocations WHERE id = ?",
1760 undef, ($pid) );
1761 last if $type eq 'mm'; # break loops in unfortunate legacy data
1762 }
1763
1764 # use the actual allocation to check against the DNS utility; we don't want
1765 # to always go chasing up the chain to the master... which may (usually won't)
1766 # be present directly in DNS anyway
1767 my $cidr = new NetAddr::IP $selfblock;
1768
1769 if ($rpc_url) {
1770 # Use the first /16 or /24, rather than dithering over which sub-/14 /16
1771 # or sub-/19 /24 to retrieve - it's the least-wrong way to do things.
1772
1773 my ($rpcblock) = ($cidr->masklen <= 24 ? $cidr->split( ($cidr->masklen <= 16 ? 16 : 24) ) : $cidr);
1774 my %rpcargs = (
1775 rpcuser => $args{user},
1776 group => $revgroup, # not sure how this could sanely be exposed, tbh...
1777 cidr => "$rpcblock",
1778 );
1779
1780 my $remote_rdns = _rpc('getRevPattern', %rpcargs);
1781 $rdns = $remote_rdns if $remote_rdns;
1782 $cached = 0;
1783 }
1784
1785 # hmm. do we care about where it actually came from?
1786 return $rdns, $cached;
1787} # end getBlockRDNS()
1788
1789
1790## IPDB::getRDNSbyIP()
1791# Get individual reverse entries for the IP or CIDR IP range passed. Sort of looking the
1792# opposite direction down the netblock tree compared to getBlockRDNS() above.
1793sub getRDNSbyIP {
1794 my $dbh = shift;
1795 my %args = @_; # We want to accept a variety of call types
1796
1797 # key arguments: allocation ID, type
1798 unless ($args{id} || $args{type}) {
1799 $errstr = 'Missing allocation ID or type';
1800 return;
1801 }
1802
1803 my @ret = ();
1804 # special case: single IP. Check if it's an allocation or in a pool, then do the RPC call for fresh data.
1805 if ($args{type} =~ /^.i$/) {
1806 my ($ip, $localrev) = $dbh->selectrow_array("SELECT ip, rdns FROM poolips WHERE id = ?", undef, ($args{id}) );
1807 push @ret, { 'r_ip' => $ip, 'iphost' => $localrev };
1808 } else {
1809 if ($rpc_url) {
1810 my %rpcargs = (
1811 rpcuser => $args{user},
1812 group => $revgroup, # not sure how this could sanely be exposed, tbh...
1813 cidr => $args{range},
1814 );
1815
1816 my $remote_rdns = _rpc('getRevSet', %rpcargs);
1817 return $remote_rdns;
1818# $rdns = $remote_rdns if $remote_rdns;
1819# $cached = 0;
1820 }
1821 }
1822 return \@ret;
1823} # end getRDNSbyIP()
1824
1825
1826## IPDB::getNodeList()
1827# Gets a list of node ID+name pairs as an arrayref to a list of hashrefs
1828sub getNodeList {
1829 my $dbh = shift;
1830
1831 my $ret = $dbh->selectall_arrayref("SELECT node_id, node_name FROM nodes ORDER BY node_type,node_id",
1832 { Slice => {} });
1833 return $ret;
1834} # end getNodeList()
1835
1836
1837## IPDB::getNodeName()
1838# Get node name from the ID
1839sub getNodeName {
1840 my $dbh = shift;
1841 my $nid = shift;
1842
1843 my ($nname) = $dbh->selectrow_array("SELECT node_name FROM nodes WHERE node_id = ?", undef, ($nid) );
1844 return $nname;
1845} # end getNodeName()
1846
1847
1848## IPDB::getNodeInfo()
1849# Get node name and ID associated with a block
1850sub getNodeInfo {
1851 my $dbh = shift;
1852 my $block = shift;
1853
1854 my ($nid, $nname) = $dbh->selectrow_array("SELECT nodes.node_id,node_name FROM nodes INNER JOIN noderef".
1855 " ON nodes.node_id=noderef.node_id WHERE noderef.block = ?", undef, ($block) );
1856 return ($nid, $nname);
1857} # end getNodeInfo()
1858
1859
1860## IPDB::mailNotify()
1861# Sends notification mail to recipients regarding an IPDB operation
1862sub mailNotify {
1863 my $dbh = shift;
1864 my ($action,$subj,$message) = @_;
1865
1866 return if $smtphost eq 'smtp.example.com'; # do nothing if still using default SMTP host.
1867
1868##fixme: need to redesign the breakdown/processing for $action for proper handling of all cases
1869
1870# split action into parts for fiddlement. nb: there are almost certainly better ways to do this.
1871 my @actionbits = split //, $action;
1872
1873 # want to notify anyone who has specifically requested notify on *this* type ($action as passed),
1874 # on "all static IP types" or "all pool types" (and other last-char-in-type groupings), on eg "all DSL types",
1875 # and "all events with this action"
1876 my @actionsets = ($action);
1877##fixme: ick, eww. really gotta find a better way to handle this...
1878 push @actionsets, ($actionbits[0].'.'.$actionbits[2],
1879 $actionbits[0].$actionbits[1].'.', $actionbits[0].'a') if $action =~ /^.{3}$/;
1880
1881 my $mailer = Net::SMTP->new($smtphost, Hello => "ipdb.$domain");
1882
1883 # get recip list from db
1884 my $sth = $dbh->prepare("SELECT reciplist FROM notify WHERE action=?");
1885
1886 my %reciplist;
1887 foreach (@actionsets) {
1888 $sth->execute($_);
1889##fixme - need to handle db errors
1890 my ($recipsub) = $sth->fetchrow_array;
1891 next if !$recipsub;
1892 foreach (split(/,/, $recipsub)) {
1893 $reciplist{$_}++;
1894 }
1895 }
1896
1897 return if !%reciplist;
1898
1899 foreach my $recip (keys %reciplist) {
1900 $mailer->mail($smtpsender);
1901 $mailer->to($recip);
1902 $mailer->data("From: \"$org_name IP Database\" <$smtpsender>\n",
1903 "To: $recip\n",
1904 "Date: ".strftime("%a, %d %b %Y %H:%M:%S %z",localtime)."\n",
1905 "Subject: {IPDB} $subj\n",
1906 "X-Mailer: IPDB Notify v".sprintf("%.1d",$IPDB::VERSION)."\n",
1907 "Organization: $org_name\n",
1908 "\n$message\n");
1909 }
1910 $mailer->quit;
1911}
1912
1913# Indicates module loaded OK. Required by Perl.
19141;
Note: See TracBrowser for help on using the repository browser.