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

# ipdb/cgi-bin/IPDB.pm
# Contains functions for IPDB - database access, subnet mangling, block allocation, etc
###
# SVN revision info
# $Date$
# SVN revision $Rev$
# Last update by $Author$
###
# Copyright (C) 2004 - Kris Deugau

package IPDB;

use strict;
use warnings;
use Exporter;
use DBI;
use Net::SMTP;
use POSIX;
use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);

$VERSION        = 2.0;
@ISA            = qw(Exporter);
@EXPORT_OK      = qw(&initIPDBGlocals &connectDB &finish &checkDBSanity &allocateBlock
                        &mailNotify);

@EXPORT         = (); # Export nothing by default.
%EXPORT_TAGS    = ( ALL => [qw( &initIPDBGlocals &connectDB &finish &checkDBSanity
                                &allocateBlock &mailNotify)]
                  );

##
## Global variables
##
our %disp_alloctypes;
our %list_alloctypes;

# Let's initialize the globals.
## IPDB::initIPDBGlobals()
# Initialize all globals.  Takes a database handle, returns a success or error code
sub initIPDBGlobals {
  my $dbh = $_[0];
  my $sth;

  $sth = $dbh->prepare("select type,dispname from alloctypes");
  $sth->execute;
  return (undef,$sth->errstr) if $sth->err;

  while (my @data = $sth->fetchrow_array) {
    $disp_alloctypes{$data[0]} = $data[1];
  }
  return (1,"OK");
} # end initIPDBGlobals


## IPDB::connectDB()
# Creates connection to IPDB.
# Requires the database name, username, and password.
# Returns a handle to the db.
# Set up for a PostgreSQL db;  could be any transactional DBMS with the
# right changes.
# This definition should be sub connectDB($$$) to be technically correct,
# but this breaks.  GRR.
sub connectDB {
  my ($dbname,$user,$pass) = @_;
  my $dbh;
  my $DSN = "DBI:Pg:dbname=$dbname";
#  my $user = 'ipdb';
#  my $pw   = 'ipdbpwd';

# Note that we want to autocommit by default, and we will turn it off locally as necessary.
# We may not want to print gobbledygook errors;  YMMV.  Have to ponder that further.
  $dbh = DBI->connect($DSN, $user, $pass, {
        AutoCommit => 1,
        PrintError => 0
        })
    or return (undef, $DBI::errstr) if(!$dbh);

# Return here if we can't select.  Note that this indicates a
# problem executing the select.
  my $sth = $dbh->prepare('select cidr from masterblocks');
  $sth->execute();
  return (undef,$DBI::errstr) if ($sth->err);

# See if the select returned anything (or null data).  This should
# succeed if the select executed, but...
  $sth->fetchrow();
  return (undef,$DBI::errstr)  if ($sth->err);

# If we get here, we should be OK.
  return ($dbh,"DB connection OK");
} # end connectDB


## IPDB::finish()
# Cleans up after database handles and so on.
# Requires a database handle
sub finish {
  my $dbh = $_[0];
  $dbh->disconnect;
} # end finish


# Quick check to see if the db is responding.  A full integrity
# check will have to be a separate tool to walk the IP allocation trees.
sub checkDBSanity {
  my $dbh = connectDB();

  if (!$dbh) {
    print "Cannot connect to the database!";
  } else {
    # it connects, try a stmt.
    my $sth = $dbh->prepare('select cidr from masterblocks');
    my $err = $sth->execute();

    if ($sth->fetchrow()) {
      # all is well.
      return 1;
    } else {
      print "Connected to the database, but could not execute test statement.  ".$sth->errstr();
    }
  }
  # Clean up after ourselves.
  $dbh->disconnect;
} # end checkDBSanity


## IPDB::allocateBlock()
# Does all of the magic of actually allocating a netblock
# Requires database handle, block to allocate, custid, type, city,
#       description, notes, circuit ID, block to allocate from, 
# Returns a success code and optional error message.
sub allocateBlock {
  my ($dbh,undef,undef,$custid,$type,$city,$desc,$notes,$circid) = @_;
  
  my $cidr = new NetAddr::IP $_[1];
  my $alloc_from = new NetAddr::IP $_[2];
  my $sth;

  # To contain the error message, if any.
  my $msg = "Unknown error allocating $cidr as '$type'";

  # Enable transactions and error handling
  local $dbh->{AutoCommit} = 0; # These need to be local so we don't
  local $dbh->{RaiseError} = 1; # step on our toes by accident.

  if ($type =~ /^[cdsmw]i$/) {
    $msg = "Unable to assign static IP $cidr to $custid";
    eval {
      # We'll just have to put up with the oddities caused by SQL (un)sort order
      $sth = $dbh->prepare("select * from poolips where pool='$alloc_from'".
        " and available='y' order by ip");
      $sth->execute;

# update poolips set custid='$custid',city='$city',available='n',
#       description='$desc',notes='$notes',circuitid='$circid'
#       where ip=(select ip from poolips where pool='$alloc_from'
#       and available='y' order by ip limit 1);
##err Need better handling here;  what if there's no free IPs when this sub gets called?
      my @data = $sth->fetchrow_array;
      my $cidr = $data[1];

      $sth = $dbh->prepare("update poolips set custid='$custid',".
        "city='$city',available='n',description='$desc',notes='$notes'".
        "circuitid='$circid'".
        " where ip='$cidr'");
      $sth->execute;
      $dbh->commit;
    };
    if ($@) {
      eval { $dbh->rollback; };
      return ('FAIL',$msg);
    } else {
      return ('OK',"OK");
    }

  } else { # end IP-from-pool allocation

    if ($cidr == $alloc_from) {
      # Easiest case- insert in one table, delete in the other, and go home.  More or less.
      # insert into allocations values (cidr,custid,type,city,desc) and
      # delete from freeblocks where cidr='cidr'
      # For data safety on non-transaction DBs, we delete first.

      eval {
        $msg = "Unable to allocate $cidr as '$disp_alloctypes{$type}'";
        if ($type eq 'rr') {
          $sth = $dbh->prepare("update freeblocks set routed='y',city='$city'".
            " where cidr='$cidr'");
          $sth->execute;
          $sth = $dbh->prepare("insert into routed values ('$cidr',".
            $cidr->masklen.",'$city')");
          $sth->execute;
        } else {
          # common stuff for end-use, dialup, dynDSL, pools, etc, etc.
          $sth = $dbh->prepare("delete from freeblocks where cidr='$cidr'");
          $sth->execute;

          $sth = $dbh->prepare("insert into allocations values ('$cidr',".
                "'$custid','$type','$city','$desc','$notes',".
                $cidr->masklen.",'$circid')");
          $sth->execute;

          # And initialize the pool, if necessary
          if ($type =~ /^.p$/) {
            $msg = "Could not initialize IPs in new $disp_alloctypes{$type} pool $cidr";
            initPool($dbh,$cidr,$type,$city,($type eq 'dp' ? "all" : "normal"));
          }

        } # routing vs non-routing netblock

        $dbh->commit;
      }; # end of eval
      if ($@) {
        $msg = $@;
        eval { $dbh->rollback; };
        return ('FAIL',$@);
      } else {
        return ('OK',"OK");
      }

    } else { # cidr != alloc_from

      # Hard case.  Allocation is smaller than free block.
      my $wantmaskbits = $cidr->masklen;
      my $maskbits = $alloc_from->masklen;

      my @newfreeblocks;        # Holds free blocks generated from splitting the source freeblock.

      # This determines which blocks will be left "free" after allocation.  We take the
      # block we're allocating from, and split it in half.  We see which half the wanted
      # block is in, and repeat until the wanted block is equal to one of the halves.
      my $i=0;
      my $tmp_from = $alloc_from;       # So we don't munge $alloc_from
      while ($maskbits++ < $wantmaskbits) {
        my @subblocks = $tmp_from->split($maskbits);
        $newfreeblocks[$i++] = (($cidr->within($subblocks[0])) ? $subblocks[1] : $subblocks[0]);
        $tmp_from = ( ($cidr->within($subblocks[0])) ? $subblocks[0] : $subblocks[1] );
      } # while

      # Begin SQL transaction block
      eval {
        $msg = "Unable to allocate $cidr as '$disp_alloctypes{$type}'";

        # Delete old freeblocks entry
        $sth = $dbh->prepare("delete from freeblocks where cidr='$alloc_from'");
        $sth->execute();

        # now we have to do some magic for routing blocks
        if ($type eq 'rr') {

          # Insert the new freeblocks entries
          # Note that non-routed blocks are assigned to <NULL>
          $sth = $dbh->prepare("insert into freeblocks values (?, ?, '<NULL>','n')");
          foreach my $block (@newfreeblocks) {
            $sth->execute("$block", $block->masklen);
          }

          # Insert the entry in the routed table
          $sth = $dbh->prepare("insert into routed values ('$cidr',".
            $cidr->masklen.",'$city')");
          $sth->execute;
          # Insert the (almost) same entry in the freeblocks table
          $sth = $dbh->prepare("insert into freeblocks values ('$cidr',".
            $cidr->masklen.",'$city','y')");
          $sth->execute;

        } else { # done with alloctype == rr

          # Insert the new freeblocks entries
          $sth = $dbh->prepare("insert into freeblocks values (?, ?, ".
                "(select city from routed where cidr >>= '$cidr'),'y')");
          foreach my $block (@newfreeblocks) {
            $sth->execute("$block", $block->masklen);
          }

          # Insert the allocations entry
          $sth = $dbh->prepare("insert into allocations values ('$cidr',".
                "'$custid','$type','$city','$desc','$notes',".$cidr->masklen.
                ",'$circid')");
          $sth->execute;

          # And initialize the pool, if necessary
          if ($type =~ /^.p$/) {
            $msg = "Could not initialize IPs in new $disp_alloctypes{$type} $cidr";
            initPool($dbh,$cidr,$type,$city,($type eq 'dp' ? "all" : "normal"));
          }

        } # done with netblock alloctype != rr

        $dbh->commit;
      }; # end eval
      if ($@) {
        eval { $dbh->rollback; };
        return ('FAIL',$msg);
      } else {
        return ('OK',"OK");
      }

    } # end fullcidr != alloc_from

  } # end static-IP vs netblock allocation

} # end allocateBlock()


## IPDB::initPool()
# Initializes a pool
# Requires a database handle, the pool CIDR, type, city, and a parameter
# indicating whether the pool should allow allocation of literally every
# IP, or if it should reserve network/gateway/broadcast IPs
# Note that this is NOT done in a transaction, that's why it's a private
# function and should ONLY EVER get called from allocateBlock()
sub initPool {
  my ($dbh,undef,$type,$city,$class) = @_;
  my $pool = new NetAddr::IP $_[1];

  my ($pooltype) = ($type =~ /^(.)p$/);
  my $sth;

  # have to insert all pool IPs into poolips table as "unallocated".
  $sth = $dbh->prepare("insert into poolips values ('$pool',".
        " ?, '6750400', '$city', '$pooltype', 'y', '', '', '')");
  my @poolip_list = $pool->hostenum;
  if ($class eq 'all') { # (DSL-ish block - *all* IPs available
    $sth->execute($pool->addr);
    for (my $i=0; $i<=$#poolip_list; $i++) {
      $sth->execute($poolip_list[$i]->addr);
    }
    $pool--;
    $sth->execute($pool->addr);
  } else { # (real netblock)
    for (my $i=1; $i<=$#poolip_list; $i++) {
      $sth->execute($poolip_list[$i]->addr);
    }
  }
} # end initPool()


## IPDB::mailNotify()
# Sends notification mail to recipients regarding an IPDB operation
sub mailNotify ($$$) {
  my ($recip,$subj,$message) = @_;
  my $mailer = Net::SMTP->new("smtp.example.com", Hello => "ipdb.example.com");

  $mailer->mail('ipdb@example.com');
  $mailer->to($recip);
  $mailer->data("From: \"IP Database\" <ipdb\@example.com>\n",
        "Date: ".strftime("%a, %d %b %Y %H:%M:%S %z",localtime)."\n",
        "Subject: {IPDB} $subj\n",
        "X-Mailer: IPDB Notify v".sprintf("%.1d",$IPDB::VERSION)."\n",
        "Organization: Example Corp\n",
        "\n$message\n");
  $mailer->quit;
}

# Indicates module loaded OK.  Required by Perl.
1;