source: branches/stable/cgi-bin/IPDB.pm@ 549

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

/branches/stable

Minimal server-meltdown-prevention patch for IPv6; create the
block but don't populate IP pools. See #22, sort of.
  • Property svn:keywords set to Date Rev Author
File size: 29.7 KB
Line 
1# ipdb/cgi-bin/IPDB.pm
2# Contains functions for IPDB - database access, subnet mangling, block allocation, etc
3###
4# SVN revision info
5# $Date: 2012-11-09 16:57:22 +0000 (Fri, 09 Nov 2012) $
6# SVN revision $Rev: 549 $
7# Last update by $Author: kdeugau $
8###
9# Copyright (C) 2004-2010 - Kris Deugau
10
11package IPDB;
12
13use strict;
14use warnings;
15use Exporter;
16use DBI;
17use Net::SMTP;
18use NetAddr::IP qw( Compact );
19use POSIX;
20use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
21
22$VERSION = 2; ##VERSION##
23@ISA = qw(Exporter);
24@EXPORT_OK = qw(
25 %disp_alloctypes %list_alloctypes %def_custids @citylist @poplist @masterblocks
26 %allocated %free %routed %bigfree %IPDBacl
27 &initIPDBGlobals &connectDB &finish &checkDBSanity &allocateBlock &addMaster
28 &deleteBlock &getBlockData &mailNotify
29 );
30
31@EXPORT = (); # Export nothing by default.
32%EXPORT_TAGS = ( ALL => [qw(
33 %disp_alloctypes %list_alloctypes %def_custids @citylist @poplist
34 @masterblocks %allocated %free %routed %bigfree %IPDBacl
35 &initIPDBGlobals &connectDB &finish &checkDBSanity &allocateBlock
36 &addMaster &deleteBlock &getBlockData &mailNotify
37 )]
38 );
39
40##
41## Global variables
42##
43our %disp_alloctypes;
44our %list_alloctypes;
45our %def_custids;
46our @citylist;
47our @poplist;
48our @masterblocks;
49our %allocated;
50our %free;
51our %routed;
52our %bigfree;
53our %IPDBacl;
54
55our $org_name = 'Example Corp';
56our $smtphost = 'smtp.example.com';
57our $domain = 'example.com';
58our $defcustid = '5554242';
59# mostly for rwhois
60##fixme: leave these blank by default?
61our $rwhoisDataPath = '/usr/local/rwhoisd/etc/rwhoisd'; # to match ./configure defaults from rwhoisd-1.5.9.6
62our $org_street = '123 4th Street';
63our $org_city = 'Anytown';
64our $org_prov_state = 'ON';
65our $org_pocode = 'H0H 0H0';
66our $org_country = 'CA';
67our $org_phone = '000-555-1234';
68our $org_techhandle = 'ISP-ARIN-HANDLE';
69our $org_email = 'noc@example.com';
70our $hostmaster = 'dns@example.com';
71
72our $syslog_facility = 'local2';
73
74# Allow allocations to come from private IP ranges by default?
75# Set to 'y' or 'on' to enable.
76our $allowprivrange = '';
77
78# Let's initialize the globals.
79## IPDB::initIPDBGlobals()
80# Initialize all globals. Takes a database handle, returns a success or error code
81sub initIPDBGlobals {
82 my $dbh = $_[0];
83 my $sth;
84
85 # Initialize alloctypes hashes
86 $sth = $dbh->prepare("select type,listname,dispname,listorder,def_custid from alloctypes order by listorder");
87 $sth->execute;
88 while (my @data = $sth->fetchrow_array) {
89 $disp_alloctypes{$data[0]} = $data[2];
90 $def_custids{$data[0]} = $data[4];
91 if ($data[3] < 900) {
92 $list_alloctypes{$data[0]} = $data[1];
93 }
94 }
95
96 # City and POP listings
97 $sth = $dbh->prepare("select city,routing from cities order by city");
98 $sth->execute;
99 return (undef,$sth->errstr) if $sth->err;
100 while (my @data = $sth->fetchrow_array) {
101 push @citylist, $data[0];
102 if ($data[1] eq 'y') {
103 push @poplist, $data[0];
104 }
105 }
106
107 # Master block list
108 $sth = $dbh->prepare("select cidr from masterblocks order by cidr");
109 $sth->execute;
110 return (undef,$sth->errstr) if $sth->err;
111 for (my $i=0; my @data = $sth->fetchrow_array(); $i++) {
112 $masterblocks[$i] = new NetAddr::IP $data[0];
113 $allocated{"$masterblocks[$i]"} = 0;
114 $free{"$masterblocks[$i]"} = 0;
115 $bigfree{"$masterblocks[$i]"} = 128; # Larger number means smaller block.
116 # Set to 128 to prepare for IPv6
117 $routed{"$masterblocks[$i]"} = 0;
118 }
119
120 # Load ACL data. Specific username checks are done at a different level.
121 $sth = $dbh->prepare("select username,acl from users");
122 $sth->execute;
123 return (undef,$sth->errstr) if $sth->err;
124 while (my @data = $sth->fetchrow_array) {
125 $IPDBacl{$data[0]} = $data[1];
126 }
127
128 return (1,"OK");
129} # end initIPDBGlobals
130
131
132## IPDB::connectDB()
133# Creates connection to IPDB.
134# Requires the database name, username, and password.
135# Returns a handle to the db.
136# Set up for a PostgreSQL db; could be any transactional DBMS with the
137# right changes.
138sub connectDB {
139 my $dbname = shift;
140 my $user = shift;
141 my $pass = shift;
142 my $dbhost = shift;
143
144 my $dbh;
145 my $DSN = "DBI:Pg:".($dbhost ? "host=$dbhost;" : '')."dbname=$dbname";
146
147# Note that we want to autocommit by default, and we will turn it off locally as necessary.
148# We may not want to print gobbledygook errors; YMMV. Have to ponder that further.
149 $dbh = DBI->connect($DSN, $user, $pass, {
150 AutoCommit => 1,
151 PrintError => 0
152 })
153 or return (undef, $DBI::errstr) if(!$dbh);
154
155# Return here if we can't select. Note that this indicates a
156# problem executing the select.
157 my $sth = $dbh->prepare("select type from alloctypes");
158 $sth->execute();
159 return (undef,$DBI::errstr) if ($sth->err);
160
161# See if the select returned anything (or null data). This should
162# succeed if the select executed, but...
163 $sth->fetchrow();
164 return (undef,$DBI::errstr) if ($sth->err);
165
166# If we get here, we should be OK.
167 return ($dbh,"DB connection OK");
168} # end connectDB
169
170
171## IPDB::finish()
172# Cleans up after database handles and so on.
173# Requires a database handle
174sub finish {
175 my $dbh = $_[0];
176 $dbh->disconnect;
177} # end finish
178
179
180## IPDB::checkDBSanity()
181# Quick check to see if the db is responding. A full integrity
182# check will have to be a separate tool to walk the IP allocation trees.
183sub checkDBSanity {
184 my ($dbh) = $_[0];
185
186 if (!$dbh) {
187 print "No database handle, or connection has been closed.";
188 return -1;
189 } else {
190 # it connects, try a stmt.
191 my $sth = $dbh->prepare("select type from alloctypes");
192 my $err = $sth->execute();
193
194 if ($sth->fetchrow()) {
195 # all is well.
196 return 1;
197 } else {
198 print "Connected to the database, but could not execute test statement. ".$sth->errstr();
199 return -1;
200 }
201 }
202 # Clean up after ourselves.
203# $dbh->disconnect;
204} # end checkDBSanity
205
206
207## IPDB::addMaster()
208# Does all the magic necessary to sucessfully add a master block
209# Requires database handle, block to add
210# Returns failure code and error message or success code and "message"
211sub addMaster {
212 my $dbh = shift;
213 my $cidr = new NetAddr::IP shift;
214
215 # Allow transactions, and raise an exception on errors so we can catch it later.
216 # Use local to make sure these get "reset" properly on exiting this block
217 local $dbh->{AutoCommit} = 0;
218 local $dbh->{RaiseError} = 1;
219
220 # Wrap all the SQL in a transaction
221 eval {
222 my $sth = $dbh->prepare("select count(*) from masterblocks where cidr <<= '$cidr'");
223 $sth->execute;
224 my @data = $sth->fetchrow_array;
225
226 if ($data[0] eq 0) {
227 # First case - master is brand-spanking-new.
228##fixme: rwhois should be globally-flagable somewhere, much like a number of other things
229## maybe a db table called "config"?
230 $sth = $dbh->prepare("insert into masterblocks (cidr,rwhois) values ('$cidr','y')");
231 $sth->execute;
232
233# Unrouted blocks aren't associated with a city (yet). We don't rely on this
234# elsewhere though; legacy data may have traps and pitfalls in it to break this.
235# Thus the "routed" flag.
236
237 $sth = $dbh->prepare("insert into freeblocks (cidr,maskbits,city,routed)".
238 " values ('$cidr',".$cidr->masklen.",'<NULL>','n')");
239 $sth->execute;
240
241 # If we get here, everything is happy. Commit changes.
242 $dbh->commit;
243
244 } # new master does not contain existing master(s)
245 else {
246
247 # collect the master(s) we're going to absorb, and snag the longest netmask while we're at it.
248 my $smallmask = $cidr->masklen;
249 $sth = $dbh->prepare("select cidr as mask from masterblocks where cidr <<= '$cidr'");
250 $sth->execute;
251 my @cmasters;
252 while (my @data = $sth->fetchrow_array) {
253 my $master = new NetAddr::IP $data[0];
254 push @cmasters, $master;
255 $smallmask = $master->masklen if $master->masklen > $smallmask;
256 }
257
258 # split the new master, and keep only those blocks not part of an existing master
259 my @blocklist;
260 foreach my $seg ($cidr->split($smallmask)) {
261 my $contained = 0;
262 foreach my $master (@cmasters) {
263 $contained = 1 if $master->contains($seg);
264 }
265 push @blocklist, $seg if !$contained;
266 }
267
268 # collect the unrouted free blocks within the new master
269 $sth = $dbh->prepare("select cidr from freeblocks where ".
270 "maskbits>=$smallmask and cidr <<= '$cidr' and routed='n'");
271 $sth->execute;
272 while (my @data = $sth->fetchrow_array) {
273 my $freeblock = new NetAddr::IP $data[0];
274 push @blocklist, $freeblock;
275 }
276
277 # combine the set of free blocks we should have now.
278 @blocklist = Compact(@blocklist);
279
280 # and now insert the new data. Make sure to delete old masters too.
281
282 # freeblocks
283 $sth = $dbh->prepare("delete from freeblocks where cidr <<= ?");
284 my $sth2 = $dbh->prepare("insert into freeblocks (cidr,maskbits,city,routed) values (?,?,'<NULL>','n')");
285 foreach my $newblock (@blocklist) {
286 $sth->execute("$newblock");
287 $sth2->execute("$newblock", $newblock->masklen);
288 }
289
290 # master
291 $sth = $dbh->prepare("delete from masterblocks where cidr <<= '$cidr'");
292 $sth->execute;
293 $sth = $dbh->prepare("insert into masterblocks (cidr,rwhois) values ('$cidr','y')");
294 $sth->execute;
295
296 # *whew* If we got here, we likely suceeded.
297 $dbh->commit;
298 } # new master contained existing master(s)
299 }; # end eval
300
301 if ($@) {
302 my $msg = $@;
303 eval { $dbh->rollback; };
304 return ('FAIL',$msg);
305 } else {
306 return ('OK','OK');
307 }
308} # end addMaster
309
310
311## IPDB::allocateBlock()
312# Does all of the magic of actually allocating a netblock
313# Requires database handle, block to allocate, custid, type, city,
314# description, notes, circuit ID, block to allocate from, private data
315# Returns a success code and optional error message.
316sub allocateBlock {
317 my ($dbh,undef,undef,$custid,$type,$city,$desc,$notes,$circid,$privdata,$nodeid) = @_;
318 $privdata = '' if !defined($privdata);
319
320 my $cidr = new NetAddr::IP $_[1];
321 my $alloc_from = new NetAddr::IP $_[2];
322 my $sth;
323
324 # Snag the "type" of the freeblock (alloc_from) "just in case"
325 $sth = $dbh->prepare("select routed from freeblocks where cidr='$alloc_from'");
326 $sth->execute;
327 my ($alloc_from_type) = $sth->fetchrow_array;
328
329 # To contain the error message, if any.
330 my $msg = "Unknown error allocating $cidr as '$type'";
331
332 # Enable transactions and error handling
333 local $dbh->{AutoCommit} = 0; # These need to be local so we don't
334 local $dbh->{RaiseError} = 1; # step on our toes by accident.
335
336 if ($type =~ /^.i$/) {
337 $msg = "Unable to assign static IP $cidr to $custid";
338 eval {
339 # We have to do this in two parts because otherwise we lose
340 # the ability to return the IP assigned. Should that change,
341 # the commented SQL statement below may become usable.
342# update poolips set custid='$custid',city='$city',available='n',
343# description='$desc',notes='$notes',circuitid='$circid'
344# where ip=(select ip from poolips where pool='$alloc_from'
345# and available='y' order by ip limit 1);
346
347 $sth = $dbh->prepare("select ip from poolips where pool='$alloc_from'".
348 " and available='y' order by ip");
349 $sth->execute;
350
351 my @data = $sth->fetchrow_array;
352 $cidr = $data[0]; # $cidr is already declared when we get here!
353
354 $sth = $dbh->prepare("update poolips set custid='$custid',".
355 "city='$city',available='n',description='$desc',notes='$notes',".
356 "circuitid='$circid',privdata='$privdata'".
357 " where ip='$cidr'");
358 $sth->execute;
359# node hack
360 if ($nodeid && $nodeid ne '') {
361 $sth = $dbh->prepare("INSERT INTO noderef (block,node_id) VALUES (?,?)");
362 $sth->execute("$cidr",$nodeid);
363 }
364# end node hack
365 $dbh->commit;
366 };
367 if ($@) {
368 $msg .= ": '".$sth->errstr."'";
369 eval { $dbh->rollback; };
370 return ('FAIL',$msg);
371 } else {
372 return ('OK',"$cidr");
373 }
374
375 } else { # end IP-from-pool allocation
376
377 my $errcode = 'OK';
378 if ($cidr == $alloc_from) {
379 # Easiest case- insert in one table, delete in the other, and go home. More or less.
380 # insert into allocations values (cidr,custid,type,city,desc) and
381 # delete from freeblocks where cidr='cidr'
382 # For data safety on non-transaction DBs, we delete first.
383
384 eval {
385 $msg = "Unable to allocate $cidr as '$disp_alloctypes{$type}'";
386 if ($type eq 'rm') {
387 $sth = $dbh->prepare("update freeblocks set routed='y',city='$city'".
388 " where cidr='$cidr'");
389 $sth->execute;
390 $sth = $dbh->prepare("insert into routed (cidr,maskbits,city)".
391 " values ('$cidr',".$cidr->masklen.",'$city')");
392 $sth->execute;
393 } else {
394 # common stuff for end-use, dialup, dynDSL, pools, etc, etc.
395
396 # special case - block is a container/"reserve" block
397 if ($type =~ /^(.)c$/) {
398 $sth = $dbh->prepare("update freeblocks set routed='$1' where cidr='$cidr'");
399 $sth->execute;
400 } else {
401 # "normal" case
402 $sth = $dbh->prepare("delete from freeblocks where cidr='$cidr'");
403 $sth->execute;
404 }
405 $sth = $dbh->prepare("insert into allocations".
406 " (cidr,custid,type,city,description,notes,maskbits,circuitid,privdata)".
407 " values ('$cidr','$custid','$type','$city',?,?,".
408 $cidr->masklen.",?,?)");
409 $sth->execute($desc,$notes,$circid,$privdata);
410
411 # And initialize the pool, if necessary
412 # PPPoE pools (currently dialup, DSL, and WiFi) get all IPs made available
413 # "DHCP" or "real-subnet" pools have the net, gw, and bcast IPs removed.
414 if ($type =~ /^.p$/) {
415 $msg = "Could not initialize IPs in new $disp_alloctypes{$type} $cidr";
416 my ($code,$rmsg) = initPool($dbh,$cidr,$type,$city,"all");
417 die $rmsg if $code eq 'FAIL';
418 $msg = $rmsg;
419 $errcode = $code;
420 } elsif ($type =~ /^.d$/) {
421 $msg = "Could not initialize IPs in new $disp_alloctypes{$type} $cidr";
422 my ($code,$rmsg) = initPool($dbh,$cidr,$type,$city,"normal");
423 die $rmsg if $code eq 'FAIL';
424 $msg = $rmsg;
425 $errcode = $code;
426 }
427
428 } # routing vs non-routing netblock
429
430# node hack
431 if ($nodeid && $nodeid ne '') {
432 $sth = $dbh->prepare("INSERT INTO noderef (block,node_id) VALUES (?,?)");
433 $sth->execute("$cidr",$nodeid);
434 }
435# end node hack
436 $dbh->commit;
437 }; # end of eval
438 if ($@) {
439 $msg .= ": ".$@;
440 eval { $dbh->rollback; };
441 return ('FAIL',$msg);
442 } else {
443 return ($errcode,($type =~ /^.[pd]$/ ? $msg : "OK"));
444 }
445
446 } else { # cidr != alloc_from
447
448 # Hard case. Allocation is smaller than free block.
449 my $wantmaskbits = $cidr->masklen;
450 my $maskbits = $alloc_from->masklen;
451
452 my @newfreeblocks; # Holds free blocks generated from splitting the source freeblock.
453
454 # This determines which blocks will be left "free" after allocation. We take the
455 # block we're allocating from, and split it in half. We see which half the wanted
456 # block is in, and repeat until the wanted block is equal to one of the halves.
457 my $i=0;
458 my $tmp_from = $alloc_from; # So we don't munge $alloc_from
459 while ($maskbits++ < $wantmaskbits) {
460 my @subblocks = $tmp_from->split($maskbits);
461 $newfreeblocks[$i++] = (($cidr->within($subblocks[0])) ? $subblocks[1] : $subblocks[0]);
462 $tmp_from = ( ($cidr->within($subblocks[0])) ? $subblocks[0] : $subblocks[1] );
463 } # while
464
465 # Begin SQL transaction block
466 eval {
467 $msg = "Unable to allocate $cidr as '$disp_alloctypes{$type}'";
468
469 # Delete old freeblocks entry
470 $sth = $dbh->prepare("delete from freeblocks where cidr='$alloc_from'");
471 $sth->execute();
472
473 # now we have to do some magic for routing blocks
474 if ($type eq 'rm') {
475
476 # Insert the new freeblocks entries
477 # Note that non-routed blocks are assigned to <NULL>
478 # and use the default value for the routed column ('n')
479 $sth = $dbh->prepare("insert into freeblocks (cidr,maskbits,city)".
480 " values (?, ?, '<NULL>')");
481 foreach my $block (@newfreeblocks) {
482 $sth->execute("$block", $block->masklen);
483 }
484
485 # Insert the entry in the routed table
486 $sth = $dbh->prepare("insert into routed (cidr,maskbits,city)".
487 " values ('$cidr',".$cidr->masklen.",'$city')");
488 $sth->execute;
489 # Insert the (almost) same entry in the freeblocks table
490 $sth = $dbh->prepare("insert into freeblocks (cidr,maskbits,city,routed)".
491 " values ('$cidr',".$cidr->masklen.",'$city','y')");
492 $sth->execute;
493
494 } else { # done with alloctype == rm
495
496 # Insert the new freeblocks entries
497 # Along with some more HairyPerl(TM):
498 # if $alloc_type_from is p
499 # OR
500 # $type matches /^(.)r$/
501 # inserted value for routed column should match.
502 # This solves the case of inserting an arbitrary block into a
503 # "Reserve-for-routed-DSL" block. Which you really shouldn't
504 # do in the first place, but anyway...
505 $sth = $dbh->prepare("insert into freeblocks (cidr,maskbits,city,routed)".
506 " values (?, ?, (select city from routed where cidr >>= '$cidr'),'".
507 ( ( ($alloc_from_type =~ /^(p)$/) || ($type =~ /^(.)r$/) ) ? "$1" : 'y')."')");
508 foreach my $block (@newfreeblocks) {
509 $sth->execute("$block", $block->masklen);
510 }
511 # Special-case for reserve/"container" blocks - generate
512 # the "extra" freeblocks entry for the container
513 if ($type =~ /^(.)c$/) {
514 $sth = $dbh->prepare("insert into freeblocks (cidr,maskbits,city,routed)".
515 " values ('$cidr',".$cidr->masklen.",'$city','$1')");
516 $sth->execute;
517 }
518 # Insert the allocations entry
519 $sth = $dbh->prepare("insert into allocations (cidr,custid,type,city,".
520 "description,notes,maskbits,circuitid,privdata)".
521 " values ('$cidr','$custid','$type','$city',?,?,".
522 $cidr->masklen.",?,?)");
523 $sth->execute($desc,$notes,$circid,$privdata);
524
525 # And initialize the pool, if necessary
526 # PPPoE pools (currently dialup, DSL, and WiFi) get all IPs made available
527 # "DHCP" or "real-subnet" pools have the net, gw, and bcast IPs removed.
528 if ($type =~ /^.p$/) {
529 $msg = "Could not initialize IPs in new $disp_alloctypes{$type} $cidr";
530 my ($code,$rmsg) = initPool($dbh,$cidr,$type,$city,"all");
531 die $rmsg if $code eq 'FAIL';
532 } elsif ($type =~ /^.d$/) {
533 $msg = "Could not initialize IPs in new $disp_alloctypes{$type} $cidr";
534 my ($code,$rmsg) = initPool($dbh,$cidr,$type,$city,"normal");
535 die $rmsg if $code eq 'FAIL';
536 }
537
538 } # done with netblock alloctype != rm
539
540# node hack
541 if ($nodeid && $nodeid ne '') {
542 $sth = $dbh->prepare("INSERT INTO noderef (block,node_id) VALUES (?,?)");
543 $sth->execute("$cidr",$nodeid);
544 }
545# end node hack
546 $dbh->commit;
547 }; # end eval
548 if ($@) {
549 $msg .= ": ".$@;
550 eval { $dbh->rollback; };
551 return ('FAIL',$msg);
552 } else {
553 return ($errcode,($type =~ /^.[pd]$/ ? $msg : "OK"));
554 }
555
556 } # end fullcidr != alloc_from
557
558 } # end static-IP vs netblock allocation
559
560} # end allocateBlock()
561
562
563## IPDB::initPool()
564# Initializes a pool
565# Requires a database handle, the pool CIDR, type, city, and a parameter
566# indicating whether the pool should allow allocation of literally every
567# IP, or if it should reserve network/gateway/broadcast IPs
568# Note that this is NOT done in a transaction, that's why it's a private
569# function and should ONLY EVER get called from allocateBlock()
570sub initPool {
571 my ($dbh,undef,$type,$city,$class) = @_;
572 my $pool = new NetAddr::IP $_[1];
573
574 return ('WARN','Refusing to melt server with IPv6 IP pool') if $pool->bits == 128;
575
576##fixme Need to just replace 2nd char of type with i rather than capturing 1st char of type
577 $type =~ s/[pd]$/i/;
578 my $sth;
579 my $msg;
580
581 # Trap errors so we can pass them back to the caller. Even if the
582 # caller is only ever supposed to be local, and therefore already
583 # trapping errors. >:(
584 local $dbh->{AutoCommit} = 0; # These need to be local so we don't
585 local $dbh->{RaiseError} = 1; # step on our toes by accident.
586
587 eval {
588 # have to insert all pool IPs into poolips table as "unallocated".
589 $sth = $dbh->prepare("insert into poolips (pool,ip,custid,city,type)".
590 " values ('$pool', ?, '$defcustid', '$city', '$type')");
591 my @poolip_list = $pool->hostenum;
592 if ($class eq 'all') { # (DSL-ish block - *all* IPs available
593 if ($pool->addr !~ /\.0$/) { # .0 causes weirdness.
594 $sth->execute($pool->addr);
595 }
596 for (my $i=0; $i<=$#poolip_list; $i++) {
597 $sth->execute($poolip_list[$i]->addr);
598 }
599 $pool--;
600 if ($pool->addr !~ /\.255$/) { # .255 can cause weirdness.
601 $sth->execute($pool->addr);
602 }
603 } else { # (real netblock)
604 for (my $i=1; $i<=$#poolip_list; $i++) {
605 $sth->execute($poolip_list[$i]->addr);
606 }
607 }
608 };
609 if ($@) {
610 $msg = "'".$sth->errstr."'";
611 eval { $dbh->rollback; };
612 return ('FAIL',$msg);
613 } else {
614 return ('OK',"OK");
615 }
616} # end initPool()
617
618
619## IPDB::deleteBlock()
620# Removes an allocation from the database, including deleting IPs
621# from poolips and recombining entries in freeblocks if possible
622# Also handles "deleting" a static IP allocation, and removal of a master
623# Requires a database handle, the block to delete, and the type of block
624sub deleteBlock {
625 my ($dbh,undef,$type) = @_;
626 my $cidr = new NetAddr::IP $_[1];
627
628 my $sth;
629
630 # Magic variables used for odd allocation cases.
631 my $container;
632 my $con_type;
633
634 # To contain the error message, if any.
635 my $msg = "Unknown error deallocating $type $cidr";
636 # Enable transactions and exception-on-errors... but only for this sub
637 local $dbh->{AutoCommit} = 0;
638 local $dbh->{RaiseError} = 1;
639
640 # First case. The "block" is a static IP
641 # Note that we still need some additional code in the odd case
642 # of a netblock-aligned contiguous group of static IPs
643 if ($type =~ /^.i$/) {
644
645 eval {
646 $msg = "Unable to deallocate $disp_alloctypes{$type} $cidr";
647 $sth = $dbh->prepare("update poolips set custid='$defcustid',available='y',".
648 "city=(select city from allocations where cidr >>= '$cidr'".
649 " order by masklen(cidr) desc limit 1),".
650 "description='',notes='',circuitid='' where ip='$cidr'");
651 $sth->execute;
652 $dbh->commit;
653 };
654 if ($@) {
655 eval { $dbh->rollback; };
656 return ('FAIL',$msg);
657 } else {
658 return ('OK',"OK");
659 }
660
661 } elsif ($type eq 'mm') { # end alloctype =~ /.i/
662
663 $msg = "Unable to delete master block $cidr";
664 eval {
665 $sth = $dbh->prepare("delete from masterblocks where cidr='$cidr'");
666 $sth->execute;
667 $sth = $dbh->prepare("delete from freeblocks where cidr <<= '$cidr'");
668 $sth->execute;
669 $dbh->commit;
670 };
671 if ($@) {
672 eval { $dbh->rollback; };
673 return ('FAIL', $msg);
674 } else {
675 return ('OK',"OK");
676 }
677
678 } else { # end alloctype master block case
679
680 ## This is a big block; but it HAS to be done in a chunk. Any removal
681 ## of a netblock allocation may result in a larger chunk of free
682 ## contiguous IP space - which may in turn be combined into a single
683 ## netblock rather than a number of smaller netblocks.
684
685 eval {
686
687 if ($type eq 'rm') {
688 $msg = "Unable to remove routing allocation $cidr";
689 $sth = $dbh->prepare("delete from routed where cidr='$cidr'");
690 $sth->execute;
691 # Make sure block getting deleted is properly accounted for.
692 $sth = $dbh->prepare("update freeblocks set routed='n',city='<NULL>'".
693 " where cidr='$cidr'");
694 $sth->execute;
695 # Set up query to start compacting free blocks.
696 $sth = $dbh->prepare("select cidr from freeblocks where ".
697 "maskbits<=".$cidr->masklen." and routed='n' order by maskbits desc");
698
699 } else { # end alloctype routing case
700
701 # Magic. We need to get information about the containing block (if any)
702 # so as to make sure that the freeblocks we insert get the correct "type".
703 $sth = $dbh->prepare("select cidr,type from allocations where cidr >> '$cidr'");
704 $sth->execute;
705 ($container, $con_type) = $sth->fetchrow_array;
706
707 # Delete all allocations within the block being deleted. This is
708 # deliberate and correct, and removes the need to special-case
709 # removal of "container" blocks.
710 $sth = $dbh->prepare("delete from allocations where cidr <<='$cidr'");
711 $sth->execute;
712
713 # Special case - delete pool IPs
714 if ($type =~ /^.[pd]$/) {
715 # We have to delete the IPs from the pool listing.
716 $sth = $dbh->prepare("delete from poolips where pool='$cidr'");
717 $sth->execute;
718 }
719
720 # Set up query for compacting free blocks.
721 if ($con_type && $con_type eq 'pc') {
722 # Clean up after "bad" allocations (blocks that are not formally
723 # contained which have nevertheless been allocated from a container block)
724 # We want to make certain that the freeblocks are properly "labelled"
725 $sth = $dbh->prepare("select cidr from freeblocks where cidr <<= '$container' order by maskbits desc");
726 } else {
727 # Standard deallocation.
728 $sth = $dbh->prepare("select cidr from freeblocks where cidr <<= ".
729 "(select cidr from routed where cidr >>= '$cidr') ".
730 " and maskbits<=".$cidr->masklen.
731 " and routed='".(($type =~ /^(.)r$/) ? "$1" : 'y').
732 "' order by maskbits desc");
733 }
734
735 } # end alloctype general case
736
737 ## Deallocate legacy blocks stashed in the middle of a static IP pool
738 ## This may be expandable to an even more general case of contained netblock, or other pool types.
739
740 # Find out if the block we're deallocating is within a DSL pool
741 my $sth2 = $dbh->prepare("SELECT cidr,city,type FROM allocations WHERE type LIKE '_p' AND cidr >>= ?");
742 $sth2->execute("$cidr");
743 my ($pool,$poolcity,$pooltype) = $sth2->fetchrow_array;
744
745 if ($pool || $sth2->rows) {
746 # We've already deleted the block, now we have to stuff its IPs into the pool.
747 $pooltype =~ s/p$/i/; # change type to static IP
748 $sth2 = $dbh->prepare("INSERT INTO poolips (pool,ip,city,type,custid) values ".
749 "('$pool',?,'$poolcity','$pooltype','$defcustid')");
750##fixme: need to not insert net, gateway, and bcast on "real netblock" pools (DHCPish)
751 # don't insert .0
752 $sth2->execute($cidr->addr) unless $cidr->addr =~ m|\.0$|;
753 foreach my $ip ($cidr->hostenum) {
754 $sth2->execute("$ip");
755 }
756 $cidr--;
757 # don't insert .255
758 $sth2->execute($cidr->addr) unless $cidr->addr =~ m|\.255$|;
759 } else { # done returning IPs from a block to a static DSL pool
760
761 # Now we look for larger-or-equal-sized free blocks in the same master (routed)
762 # (super)block. If there aren't any, we can't combine blocks anyway. If there
763 # are, we check to see if we can combine blocks.
764 # Execute the statement prepared in the if-else above.
765
766 $sth->execute;
767
768# NetAddr::IP->compact() attempts to produce the smallest inclusive block
769# from the caller and the passed terms.
770# EG: if you call $cidr->compact($ip1,$ip2,$ip3) when $cidr, $ip1, $ip2,
771# and $ip3 are consecutive /27's starting on .0 (.0-.31, .32-.63,
772# .64-.95, and .96-.128), you will get an array containing a single
773# /25 as element 0 (.0-.127). Order is not important; you could have
774# $cidr=.32/27, $ip1=.96/27, $ip2=.0/27, and $ip3=.64/27.
775
776 my (@together, @combinelist);
777 my $i=0;
778 while (my @data = $sth->fetchrow_array) {
779 my $testIP = new NetAddr::IP $data[0];
780 @together = $testIP->compact($cidr);
781 my $num = @together;
782 if ($num == 1) {
783 $cidr = $together[0];
784 $combinelist[$i++] = $testIP;
785 }
786 }
787
788 # Clear old freeblocks entries - if any. They should all be within
789 # the $cidr determined above.
790 $sth = $dbh->prepare("delete from freeblocks where cidr <<='$cidr'");
791 $sth->execute;
792
793 # insert "new" freeblocks entry
794 if ($type eq 'rm') {
795 $sth = $dbh->prepare("insert into freeblocks (cidr,maskbits,city)".
796 " values ('$cidr',".$cidr->masklen.",'<NULL>')");
797 } else {
798 # Magic hackery to insert "correct" data for deallocation of
799 # non-contained blocks allocated from within a container.
800 $type = 'pr' if $con_type && $con_type eq 'pc';
801
802 $sth = $dbh->prepare("insert into freeblocks (cidr,maskbits,city,routed)".
803 " values ('$cidr',".$cidr->masklen.
804 ",(select city from routed where cidr >>= '$cidr'),'".
805 (($type =~ /^(.)r$/) ? "$1" : 'y')."')");
806 }
807 $sth->execute;
808
809 } # done returning IPs to the appropriate place
810
811 # If we got here, we've succeeded. Whew!
812 $dbh->commit;
813 }; # end eval
814 if ($@) {
815 $msg = $@;
816 eval { $dbh->rollback; };
817 return ('FAIL', $msg);
818 } else {
819 return ('OK',"OK");
820 }
821
822 } # end alloctype != netblock
823
824} # end deleteBlock()
825
826
827## IPDB::getBlockData()
828# Return custid, type, city, and description for a block
829sub getBlockData {
830 my $dbh = shift;
831 my $block = shift;
832
833 my $sth = $dbh->prepare("select cidr,custid,type,city,description from searchme".
834 " where cidr='$block'");
835 $sth->execute();
836 return $sth->fetchrow_array();
837} # end getBlockData()
838
839
840## IPDB::mailNotify()
841# Sends notification mail to recipients regarding an IPDB operation
842sub mailNotify {
843 my $dbh = shift;
844 my ($action,$subj,$message) = @_;
845
846 return if $domain eq 'example.com'; # no point being obnoxious if we're still stuck with defaults.
847
848##fixme: need to redesign the breakdown/processing for $action for proper handling of all cases
849
850# split action into parts for fiddlement. nb: there are almost certainly better ways to do this.
851 my @actionbits = split //, $action;
852
853 # want to notify anyone who has specifically requested notify on *this* type ($action as passed),
854 # on "all static IP types" or "all pool types" (and other last-char-in-type groupings), on eg "all DSL types",
855 # and "all events with this action"
856 my @actionsets = ($action);
857##fixme: ick, eww. really gotta find a better way to handle this...
858 push @actionsets, ($actionbits[0].'.'.$actionbits[2],
859 $actionbits[0].$actionbits[1].'.', $actionbits[0].'a') if $action =~ /^.{3}$/;
860
861 my $mailer = Net::SMTP->new($smtphost, Hello => "ipdb.$domain");
862
863 # get recip list from db
864 my $sth = $dbh->prepare("SELECT reciplist FROM notify WHERE action=?");
865
866 my %reciplist;
867 foreach (@actionsets) {
868 $sth->execute($_);
869##fixme - need to handle db errors
870 my ($recipsub) = $sth->fetchrow_array;
871 next if !$recipsub;
872 foreach (split(/,/, $recipsub)) {
873 $reciplist{$_}++;
874 }
875 }
876
877 return if !%reciplist;
878
879 foreach my $recip (keys %reciplist) {
880 $mailer->mail("ipdb\@$domain");
881 $mailer->to($recip);
882 $mailer->data("From: \"$org_name IP Database\" <ipdb\@$domain>\n",
883 "To: $recip\n",
884 "Date: ".strftime("%a, %d %b %Y %H:%M:%S %z",localtime)."\n",
885 "Subject: {IPDB} $subj\n",
886 "X-Mailer: IPDB Notify v".sprintf("%.1d",$IPDB::VERSION)."\n",
887 "Organization: $org_name\n",
888 "\n$message\n");
889 }
890 $mailer->quit;
891}
892
893# Indicates module loaded OK. Required by Perl.
8941;
Note: See TracBrowser for help on using the repository browser.