source: branches/new-search-20050223/cgi-bin/IPDB.pm@ 198

Last change on this file since 198 was 167, checked in by Kris Deugau, 20 years ago

/trunk

New feature: Different "default" CustIDs depending on the allocation type
consistency-check.pl also updated to check this information.
  • Property svn:keywords set to Date Rev Author
File size: 19.0 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: 2005-02-22 19:25:58 +0000 (Tue, 22 Feb 2005) $
6# SVN revision $Rev: 167 $
7# Last update by $Author: kdeugau $
8###
9# Copyright (C) 2004,2005 - Kris Deugau
10
11package IPDB;
12
13use strict;
14use warnings;
15use Exporter;
16use DBI;
17use Net::SMTP;
18use POSIX;
19use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
20
21$VERSION = 2.0;
22@ISA = qw(Exporter);
23@EXPORT_OK = qw(
24 %disp_alloctypes %list_alloctypes %def_custids @citylist @poplist @masterblocks
25 %allocated %free %routed %bigfree
26 &initIPDBGlobals &connectDB &finish &checkDBSanity &allocateBlock &deleteBlock
27 &mailNotify
28 );
29
30@EXPORT = (); # Export nothing by default.
31%EXPORT_TAGS = ( ALL => [qw(
32 %disp_alloctypes %list_alloctypes %def_custids @citylist @poplist
33 @masterblocks %allocated %free %routed %bigfree
34 &initIPDBGlobals &connectDB &finish &checkDBSanity &allocateBlock
35 &deleteBlock &mailNotify
36 )]
37 );
38
39##
40## Global variables
41##
42our %disp_alloctypes;
43our %list_alloctypes;
44our %def_custids;
45our @citylist;
46our @poplist;
47our @masterblocks;
48our %allocated;
49our %free;
50our %routed;
51our %bigfree;
52
53# Let's initialize the globals.
54## IPDB::initIPDBGlobals()
55# Initialize all globals. Takes a database handle, returns a success or error code
56sub initIPDBGlobals {
57 my $dbh = $_[0];
58 my $sth;
59
60 # Initialize alloctypes hashes
61 $sth = $dbh->prepare("select type,listname,dispname,listorder,def_custid from alloctypes order by listorder");
62 $sth->execute;
63 while (my @data = $sth->fetchrow_array) {
64 $disp_alloctypes{$data[0]} = $data[2];
65 $def_custids{$data[0]} = $data[4];
66 if ($data[3] < 900) {
67 $list_alloctypes{$data[0]} = $data[1];
68 }
69 }
70
71 # City and POP listings
72 $sth = $dbh->prepare("select city,routing from cities order by city");
73 $sth->execute;
74 return (undef,$sth->errstr) if $sth->err;
75 while (my @data = $sth->fetchrow_array) {
76 push @citylist, $data[0];
77 if ($data[1] eq 'y') {
78 push @poplist, $data[0];
79 }
80 }
81
82 # Master block list
83 $sth = $dbh->prepare("select cidr from masterblocks order by cidr");
84 $sth->execute;
85 for (my $i=0; my @data = $sth->fetchrow_array(); $i++) {
86 $masterblocks[$i] = new NetAddr::IP $data[0];
87 $allocated{"$masterblocks[$i]"} = 0;
88 $free{"$masterblocks[$i]"} = 0;
89 $bigfree{"$masterblocks[$i]"} = 128; # Larger number means smaller block.
90 # Set to 128 to prepare for IPv6
91 $routed{"$masterblocks[$i]"} = 0;
92 }
93 return (undef,$sth->errstr) if $sth->err;
94
95 return (1,"OK");
96} # end initIPDBGlobals
97
98
99## IPDB::connectDB()
100# Creates connection to IPDB.
101# Requires the database name, username, and password.
102# Returns a handle to the db.
103# Set up for a PostgreSQL db; could be any transactional DBMS with the
104# right changes.
105# This definition should be sub connectDB($$$) to be technically correct,
106# but this breaks. GRR.
107sub connectDB {
108 my ($dbname,$user,$pass) = @_;
109 my $dbh;
110 my $DSN = "DBI:Pg:dbname=$dbname";
111# my $user = 'ipdb';
112# my $pw = 'ipdbpwd';
113
114# Note that we want to autocommit by default, and we will turn it off locally as necessary.
115# We may not want to print gobbledygook errors; YMMV. Have to ponder that further.
116 $dbh = DBI->connect($DSN, $user, $pass, {
117 AutoCommit => 1,
118 PrintError => 0
119 })
120 or return (undef, $DBI::errstr) if(!$dbh);
121
122# Return here if we can't select. Note that this indicates a
123# problem executing the select.
124 my $sth = $dbh->prepare("select cidr from masterblocks");
125 $sth->execute();
126 return (undef,$DBI::errstr) if ($sth->err);
127
128# See if the select returned anything (or null data). This should
129# succeed if the select executed, but...
130 $sth->fetchrow();
131 return (undef,$DBI::errstr) if ($sth->err);
132
133# If we get here, we should be OK.
134 return ($dbh,"DB connection OK");
135} # end connectDB
136
137
138## IPDB::finish()
139# Cleans up after database handles and so on.
140# Requires a database handle
141sub finish {
142 my $dbh = $_[0];
143 $dbh->disconnect;
144} # end finish
145
146
147## IPDB::checkDBSanity()
148# Quick check to see if the db is responding. A full integrity
149# check will have to be a separate tool to walk the IP allocation trees.
150sub checkDBSanity {
151 my ($dbh) = $_[0];
152
153 if (!$dbh) {
154 print "No database handle, or connection has been closed.";
155 return -1;
156 } else {
157 # it connects, try a stmt.
158 my $sth = $dbh->prepare("select cidr from masterblocks");
159 my $err = $sth->execute();
160
161 if ($sth->fetchrow()) {
162 # all is well.
163 return 1;
164 } else {
165 print "Connected to the database, but could not execute test statement. ".$sth->errstr();
166 return -1;
167 }
168 }
169 # Clean up after ourselves.
170# $dbh->disconnect;
171} # end checkDBSanity
172
173
174## IPDB::allocateBlock()
175# Does all of the magic of actually allocating a netblock
176# Requires database handle, block to allocate, custid, type, city,
177# description, notes, circuit ID, block to allocate from,
178# Returns a success code and optional error message.
179sub allocateBlock {
180 my ($dbh,undef,undef,$custid,$type,$city,$desc,$notes,$circid) = @_;
181
182 my $cidr = new NetAddr::IP $_[1];
183 my $alloc_from = new NetAddr::IP $_[2];
184 my $sth;
185
186 # To contain the error message, if any.
187 my $msg = "Unknown error allocating $cidr as '$type'";
188
189 # Enable transactions and error handling
190 local $dbh->{AutoCommit} = 0; # These need to be local so we don't
191 local $dbh->{RaiseError} = 1; # step on our toes by accident.
192
193 if ($type =~ /^.i$/) {
194 $msg = "Unable to assign static IP $cidr to $custid";
195 eval {
196 # We have to do this in two parts because otherwise we lose
197 # the ability to return the IP assigned. Should that change,
198 # the commented SQL statement below may become usable.
199# update poolips set custid='$custid',city='$city',available='n',
200# description='$desc',notes='$notes',circuitid='$circid'
201# where ip=(select ip from poolips where pool='$alloc_from'
202# and available='y' order by ip limit 1);
203
204 $sth = $dbh->prepare("select ip from poolips where pool='$alloc_from'".
205 " and available='y' order by ip");
206 $sth->execute;
207
208 my @data = $sth->fetchrow_array;
209 $cidr = $data[0]; # $cidr is already declared when we get here!
210
211 $sth = $dbh->prepare("update poolips set custid='$custid',".
212 "city='$city',available='n',description='$desc',notes='$notes',".
213 "circuitid='$circid'".
214 " where ip='$cidr'");
215 $sth->execute;
216 $dbh->commit;
217 };
218 if ($@) {
219 $msg .= ": '".$sth->errstr."'";
220 eval { $dbh->rollback; };
221 return ('FAIL',$msg);
222 } else {
223 return ('OK',"$cidr");
224 }
225
226 } else { # end IP-from-pool allocation
227
228 if ($cidr == $alloc_from) {
229 # Easiest case- insert in one table, delete in the other, and go home. More or less.
230 # insert into allocations values (cidr,custid,type,city,desc) and
231 # delete from freeblocks where cidr='cidr'
232 # For data safety on non-transaction DBs, we delete first.
233
234 eval {
235 $msg = "Unable to allocate $cidr as '$disp_alloctypes{$type}'";
236 if ($type eq 'rr') {
237 $sth = $dbh->prepare("update freeblocks set routed='y',city='$city'".
238 " where cidr='$cidr'");
239 $sth->execute;
240 $sth = $dbh->prepare("insert into routed (cidr,maskbits,city)".
241 " values ('$cidr',".$cidr->masklen.",'$city')");
242 $sth->execute;
243 } else {
244 # common stuff for end-use, dialup, dynDSL, pools, etc, etc.
245 $sth = $dbh->prepare("delete from freeblocks where cidr='$cidr'");
246 $sth->execute;
247
248 $sth = $dbh->prepare("insert into allocations".
249 " (cidr,custid,type,city,description,notes,maskbits,circuitid)".
250 " values ('$cidr','$custid','$type','$city','$desc','$notes',".
251 $cidr->masklen.",'$circid')");
252 $sth->execute;
253
254 # And initialize the pool, if necessary
255 # PPPoE pools (currently dialup, DSL, and WiFi) get all IPs made available
256 # "DHCP" or "real-subnet" pools have the net, gw, and bcast IPs removed.
257 if ($type =~ /^.p$/) {
258 $msg = "Could not initialize IPs in new $disp_alloctypes{$type} $cidr";
259 my ($code,$rmsg) = initPool($dbh,$cidr,$type,$city,"all");
260 die $rmsg if $code eq 'FAIL';
261 } elsif ($type =~ /^.d$/) {
262 $msg = "Could not initialize IPs in new $disp_alloctypes{$type} $cidr";
263 my ($code,$rmsg) = initPool($dbh,$cidr,$type,$city,"normal");
264 die $rmsg if $code eq 'FAIL';
265 }
266
267 } # routing vs non-routing netblock
268
269 $dbh->commit;
270 }; # end of eval
271 if ($@) {
272 $msg .= ": ".$@;
273 eval { $dbh->rollback; };
274 return ('FAIL',$msg);
275 } else {
276 return ('OK',"OK");
277 }
278
279 } else { # cidr != alloc_from
280
281 # Hard case. Allocation is smaller than free block.
282 my $wantmaskbits = $cidr->masklen;
283 my $maskbits = $alloc_from->masklen;
284
285 my @newfreeblocks; # Holds free blocks generated from splitting the source freeblock.
286
287 # This determines which blocks will be left "free" after allocation. We take the
288 # block we're allocating from, and split it in half. We see which half the wanted
289 # block is in, and repeat until the wanted block is equal to one of the halves.
290 my $i=0;
291 my $tmp_from = $alloc_from; # So we don't munge $alloc_from
292 while ($maskbits++ < $wantmaskbits) {
293 my @subblocks = $tmp_from->split($maskbits);
294 $newfreeblocks[$i++] = (($cidr->within($subblocks[0])) ? $subblocks[1] : $subblocks[0]);
295 $tmp_from = ( ($cidr->within($subblocks[0])) ? $subblocks[0] : $subblocks[1] );
296 } # while
297
298 # Begin SQL transaction block
299 eval {
300 $msg = "Unable to allocate $cidr as '$disp_alloctypes{$type}'";
301
302 # Delete old freeblocks entry
303 $sth = $dbh->prepare("delete from freeblocks where cidr='$alloc_from'");
304 $sth->execute();
305
306 # now we have to do some magic for routing blocks
307 if ($type eq 'rr') {
308
309 # Insert the new freeblocks entries
310 # Note that non-routed blocks are assigned to <NULL>
311 # and use the default value for the routed column ('n')
312 $sth = $dbh->prepare("insert into freeblocks (cidr,maskbits,city)".
313 " values (?, ?, '<NULL>')");
314 foreach my $block (@newfreeblocks) {
315 $sth->execute("$block", $block->masklen);
316 }
317
318 # Insert the entry in the routed table
319 $sth = $dbh->prepare("insert into routed (cidr,maskbits,city)".
320 " values ('$cidr',".$cidr->masklen.",'$city')");
321 $sth->execute;
322 # Insert the (almost) same entry in the freeblocks table
323 $sth = $dbh->prepare("insert into freeblocks (cidr,maskbits,city,routed)".
324 " values ('$cidr',".$cidr->masklen.",'$city','y')");
325 $sth->execute;
326
327 } else { # done with alloctype == rr
328
329 # Insert the new freeblocks entries
330 $sth = $dbh->prepare("insert into freeblocks (cidr,maskbits,city,routed)".
331 " values (?, ?, (select city from routed where cidr >>= '$cidr'),'y')");
332 foreach my $block (@newfreeblocks) {
333 $sth->execute("$block", $block->masklen);
334 }
335
336 # Insert the allocations entry
337 $sth = $dbh->prepare("insert into allocations (cidr,custid,type,city,".
338 "description,notes,maskbits,circuitid)".
339 " values ('$cidr','$custid','$type','$city','$desc','$notes',".
340 $cidr->masklen.",'$circid')");
341 $sth->execute;
342
343 # And initialize the pool, if necessary
344 # PPPoE pools (currently dialup, DSL, and WiFi) get all IPs made available
345 # "DHCP" or "real-subnet" pools have the net, gw, and bcast IPs removed.
346 if ($type =~ /^.p$/) {
347 $msg = "Could not initialize IPs in new $disp_alloctypes{$type} $cidr";
348 my ($code,$rmsg) = initPool($dbh,$cidr,$type,$city,"all");
349 die $rmsg if $code eq 'FAIL';
350 } elsif ($type =~ /^.d$/) {
351 $msg = "Could not initialize IPs in new $disp_alloctypes{$type} $cidr";
352 my ($code,$rmsg) = initPool($dbh,$cidr,$type,$city,"normal");
353 die $rmsg if $code eq 'FAIL';
354 }
355
356 } # done with netblock alloctype != rr
357
358 $dbh->commit;
359 }; # end eval
360 if ($@) {
361 eval { $dbh->rollback; };
362 return ('FAIL',$msg);
363 } else {
364 return ('OK',"OK");
365 }
366
367 } # end fullcidr != alloc_from
368
369 } # end static-IP vs netblock allocation
370
371} # end allocateBlock()
372
373
374## IPDB::initPool()
375# Initializes a pool
376# Requires a database handle, the pool CIDR, type, city, and a parameter
377# indicating whether the pool should allow allocation of literally every
378# IP, or if it should reserve network/gateway/broadcast IPs
379# Note that this is NOT done in a transaction, that's why it's a private
380# function and should ONLY EVER get called from allocateBlock()
381sub initPool {
382 my ($dbh,undef,$type,$city,$class) = @_;
383 my $pool = new NetAddr::IP $_[1];
384
385##fixme Need to just replace 2nd char of type with i rather than capturing 1st char of type
386 $type =~ s/[pd]$/i/;
387 my $sth;
388 my $msg;
389
390 # Trap errors so we can pass them back to the caller. Even if the
391 # caller is only ever supposed to be local, and therefore already
392 # trapping errors. >:(
393 local $dbh->{AutoCommit} = 0; # These need to be local so we don't
394 local $dbh->{RaiseError} = 1; # step on our toes by accident.
395
396 eval {
397 # have to insert all pool IPs into poolips table as "unallocated".
398 $sth = $dbh->prepare("insert into poolips (pool,ip,custid,city,type)".
399 " values ('$pool', ?, '6750400', '$city', '$type')");
400 my @poolip_list = $pool->hostenum;
401 if ($class eq 'all') { # (DSL-ish block - *all* IPs available
402 $sth->execute($pool->addr);
403 for (my $i=0; $i<=$#poolip_list; $i++) {
404 $sth->execute($poolip_list[$i]->addr);
405 }
406 $pool--;
407 $sth->execute($pool->addr);
408 } else { # (real netblock)
409 for (my $i=1; $i<=$#poolip_list; $i++) {
410 $sth->execute($poolip_list[$i]->addr);
411 }
412 }
413 };
414 if ($@) {
415 $msg = "'".$sth->errstr."'";
416 eval { $dbh->rollback; };
417 return ('FAIL',$msg);
418 } else {
419 return ('OK',"OK");
420 }
421} # end initPool()
422
423
424## IPDB::deleteBlock()
425# Removes an allocation from the database, including deleting IPs
426# from poolips and recombining entries in freeblocks if possible
427# Also handles "deleting" a static IP allocation, and removal of a master
428# Requires a database handle, the block to delete, and the type of block
429sub deleteBlock {
430 my ($dbh,undef,$type) = @_;
431 my $cidr = new NetAddr::IP $_[1];
432
433 my $sth;
434
435 # To contain the error message, if any.
436 my $msg = "Unknown error deallocating $type $cidr";
437 # Enable transactions and exception-on-errors... but only for this sub
438 local $dbh->{AutoCommit} = 0;
439 local $dbh->{RaiseError} = 1;
440
441 # First case. The "block" is a static IP
442 # Note that we still need some additional code in the odd case
443 # of a netblock-aligned contiguous group of static IPs
444 if ($type =~ /^.i$/) {
445
446 eval {
447 $msg = "Unable to deallocate $disp_alloctypes{$type} $cidr";
448 $sth = $dbh->prepare("update poolips set custid='6750400',available='y',".
449 "city=(select city from allocations where cidr >>= '$cidr'),".
450 "description='',notes='',circuitid='' where ip='$cidr'");
451 $sth->execute;
452 $dbh->commit;
453 };
454 if ($@) {
455 eval { $dbh->rollback; };
456 return ('FAIL',$msg);
457 } else {
458 return ('OK',"OK");
459 }
460
461 } elsif ($type eq 'mm') { # end alloctype =~ /.i/
462
463 $msg = "Unable to delete master block $cidr";
464 eval {
465 $sth = $dbh->prepare("delete from masterblocks where cidr='$cidr'");
466 $sth->execute;
467 $sth = $dbh->prepare("delete from freeblocks where cidr='$cidr'");
468 $sth->execute;
469 $dbh->commit;
470 };
471 if ($@) {
472 eval { $dbh->rollback; };
473 return ('FAIL', $msg);
474 } else {
475 return ('OK',"OK");
476 }
477
478 } else { # end alloctype master block case
479
480 ## This is a big block; but it HAS to be done in a chunk. Any removal
481 ## of a netblock allocation may result in a larger chunk of free
482 ## contiguous IP space - which may in turn be combined into a single
483 ## netblock rather than a number of smaller netblocks.
484
485 eval {
486
487 if ($type eq 'rr') {
488 $msg = "Unable to remove routing allocation $cidr";
489 $sth = $dbh->prepare("delete from routed where cidr='$cidr'");
490 $sth->execute;
491 # Make sure block getting deleted is properly accounted for.
492 $sth = $dbh->prepare("update freeblocks set routed='n',city='<NULL>'".
493 " where cidr='$cidr'");
494 $sth->execute;
495 # Set up query to start compacting free blocks.
496 $sth = $dbh->prepare("select cidr from freeblocks where ".
497 "maskbits<=".$cidr->masklen." and routed='n' order by maskbits desc");
498
499 } else { # end alloctype routing case
500
501 $sth = $dbh->prepare("delete from allocations where cidr='$cidr'");
502 $sth->execute;
503 # Special case - delete pool IPs
504 if ($type =~ /^.[pd]$/) {
505 # We have to delete the IPs from the pool listing.
506 $sth = $dbh->prepare("delete from poolips where pool='$cidr'");
507 $sth->execute;
508 }
509
510 # Set up query for compacting free blocks.
511 $sth = $dbh->prepare("select cidr from freeblocks where cidr <<= ".
512 "(select cidr from routed where cidr >>= '$cidr') ".
513 " and maskbits<=".$cidr->masklen." and routed='y' order by maskbits desc");
514
515 } # end alloctype general case
516
517 # Now we look for larger-or-equal-sized free blocks in the same master (routed)
518 # (super)block. If there aren't any, we can't combine blocks anyway. If there
519 # are, we check to see if we can combine blocks.
520 # Execute the statement prepared in the if-else above.
521
522 $sth->execute;
523
524# NetAddr::IP->compact() attempts to produce the smallest inclusive block
525# from the caller and the passed terms.
526# EG: if you call $cidr->compact($ip1,$ip2,$ip3) when $cidr, $ip1, $ip2,
527# and $ip3 are consecutive /27's starting on .0 (.0-.31, .32-.63,
528# .64-.95, and .96-.128), you will get an array containing a single
529# /25 as element 0 (.0-.127). Order is not important; you could have
530# $cidr=.32/27, $ip1=.96/27, $ip2=.0/27, and $ip3=.64/27.
531
532 my (@together, @combinelist);
533 my $i=0;
534 while (my @data = $sth->fetchrow_array) {
535 my $testIP = new NetAddr::IP $data[0];
536 @together = $testIP->compact($cidr);
537 my $num = @together;
538 if ($num == 1) {
539 $cidr = $together[0];
540 $combinelist[$i++] = $testIP;
541 }
542 }
543
544 # Clear old freeblocks entries - if any. $i==0 if not.
545 if ($i>0) {
546 $sth = $dbh->prepare("delete from freeblocks where cidr=?");
547 foreach my $block (@combinelist) {
548 $sth->execute("$block");
549 }
550 }
551
552 # insert "new" freeblocks entry
553 if ($type eq 'rr') {
554 $sth = $dbh->prepare("insert into freeblocks (cidr,maskbits,city)".
555 " values ('$cidr',".$cidr->masklen.",'<NULL>')");
556 } else {
557 $sth = $dbh->prepare("insert into freeblocks (cidr,maskbits,city,routed)".
558 " values ('$cidr',".$cidr->masklen.
559 ",(select city from routed where cidr >>= '$cidr'),'y')");
560 }
561 $sth->execute;
562
563 # If we got here, we've succeeded. Whew!
564 $dbh->commit;
565 }; # end eval
566 if ($@) {
567 eval { $dbh->rollback; };
568 return ('FAIL', $msg);
569 } else {
570 return ('OK',"OK");
571 }
572
573 } # end alloctype != netblock
574
575} # end deleteBlock()
576
577
578## IPDB::mailNotify()
579# Sends notification mail to recipients regarding an IPDB operation
580sub mailNotify ($$$) {
581 my ($recip,$subj,$message) = @_;
582 my $mailer = Net::SMTP->new("smtp.example.com", Hello => "ipdb.example.com");
583
584 $mailer->mail('ipdb@example.com');
585 $mailer->to($recip);
586 $mailer->data("From: \"IP Database\" <ipdb\@example.com>\n",
587 "To: $recip\n",
588 "Date: ".strftime("%a, %d %b %Y %H:%M:%S %z",localtime)."\n",
589 "Subject: {IPDB} $subj\n",
590 "X-Mailer: IPDB Notify v".sprintf("%.1d",$IPDB::VERSION)."\n",
591 "Organization: Example Corp\n",
592 "\n$message\n");
593 $mailer->quit;
594}
595
596# Indicates module loaded OK. Required by Perl.
5971;
Note: See TracBrowser for help on using the repository browser.