Changeset 465 for trunk/DNSDB.pm

Timestamp:

03/12/13 11:44:32 (11 years ago)

Author:

Kris Deugau

Message:

/trunk

Object conversion of DNSDB.pm, 1 of <mumble>. See #11.

• object initialization and shutdown

File:

• trunk/DNSDB.pm (modified) (11 diffs)

trunk/DNSDB.pm

@@ -218 +218 @@
 
 ##
+## Constructor and destructor
+##
+
+sub new {
+  my $this = shift;
+  my $class = ref($this) || $this;
+  my %args = @_;
+##fixme?  to ponder:  do we do some magic if the caller sets eg dbname to prevent parsing of the config file?
+  if (!loadConfig(basename => $args{configfile})) {
+    warn "Using default configuration;  unable to load custom settings: $errstr\n";
+  }
+  my $self = \%config;
+  $self->{configfile} = $args{configfile};
+  bless $self, $class;
+  $self->{dbh} = connectDB($self->{dbname}, $self->{dbuser}, $self->{dbpass}, $self->{dbhost}) or return;
+  $self->initGlobals();
+
+  return $self;
+}
+
+sub DESTROY {
+  my $self = shift;
+  $self->{dbh}->disconnect;
+}
+
+##
 ## utility functions
 ##
@@ -1195 +1221 @@
 ##
 
-
 ## DNSDB::loadConfig()
 # Load the minimum required initial state (DB connect info) from a config file
@@ -1201 +1226 @@
 # Takes an optional hash that may contain:
 #  - basename and config path to look for
-#  - RPC flag (saves parsing the more complex RPC bits if not needed)
 # Populates the %config and %def hashes
 sub loadConfig {
   my %args = @_;
-  $args{basename} = '' if !$args{basename};
-  $args{rpcflag} = '' if !$args{rpcflag};
-##fixme  $args{basename} isn't doing what I think I thought I was trying to do.
+  $args{configfile} = '' if !$args{configfile};
+
+##fixme  this is *intended* to load a system-default config template, and allow
+# overriding on a per-tool or per-web-UI-instance basis with a secondary config
+# file.  The "default" config file can't be deleted in the current form.
 
   my $deferr = '';      # place to put error from default config file in case we can't find either one
 
   my $configroot = "/etc/dnsdb";        ##CFG_LEAF##
-  $configroot = '' if $args{basename} =~ m|^/|;
-  $args{basename} .= ".conf" if $args{basename} !~ /\.conf$/;
+  $configroot = '' if $args{configfile} =~ m|^/|;  # allow passed siteconfig to specify an arbitrary absolute path
+  $args{configfile} .= ".conf" if $args{configfile} !~ /\.conf$/;
   my $defconfig = "$configroot/dnsdb.conf";
-  my $siteconfig = "$configroot/$args{basename}";
+  my $siteconfig = "$configroot/$args{configfile}";
 
   # System defaults
-  __cfgload("$defconfig", $args{rpcflag}) or $deferr = $errstr;
+  __cfgload("$defconfig") or $deferr = $errstr;
 
   # Per-site-ish settings.
-  if ($args{basename} ne '.conf') {
-    unless (__cfgload("$siteconfig"), $args{rpcflag}) {
+  if ($args{configfile} ne '.conf') {
+    unless (__cfgload("$siteconfig")) {
       $errstr = ($deferr ? "Error opening default config file $defconfig: $deferr\n" : '').
         "Error opening site config file $siteconfig";
@@ -1254 +1280 @@
 ## DNSDB::__cfgload()
 # Private sub to parse a config file and load it into %config
-# Takes a file handle on an open config file
+# Takes a filename
 sub __cfgload {
   $errstr = '';
   my $cfgfile = shift;
-  my $rpcflag = shift;
 
   if (open CFG, "<$cfgfile") {
@@ -1297 +1322 @@
       $config{exportcache}      = $1 if m{^exportcache\s*=\s*([a-z0-9/_.-]+)}i;
       # RPC options
-      if ($rpcflag && /^rpc/) {
-        if (my ($tmp) = /^rpc_iplist\s*=\s*(.+)/i) {
-          my @ips = split /[,\s]+/, $tmp;
-          my $rpcsys = shift @ips;
-          push @{$config{rpcacl}{$rpcsys}}, @ips;
-        }
-        $config{rpcmode} = $1 if /^rpc_mode\s*=\s*(socket|HTTP|XMLRPC)\s*$/i;
+      $config{rpcmode}          = $1 if /^rpc_mode\s*=\s*(socket|HTTP|XMLRPC)\s*$/i;
+      if (my ($tmp) = /^rpc_iplist\s*=\s*(.+)/i) {
+        my @ips = split /[,\s]+/, $tmp;
+        my $rpcsys = shift @ips;
+        push @{$config{rpcacl}{$rpcsys}}, @ips;
       }
     }
@@ -1318 +1341 @@
 # Creates connection to DNS database.
 # Requires the database name, username, and password.
-# Returns a handle to the db.
+# Returns a handle to the db or undef on failure.
 # Set up for a PostgreSQL db;  could be any transactional DBMS with the
 # right changes.
+# Called by new();  not intended to be called publicly.
 sub connectDB {
   $errstr = '';
@@ -1337 +1361 @@
         AutoCommit => 1,
         PrintError => 0
-        })
-    or return (undef, $DBI::errstr) if(!$dbh);
-
+        });
+  if (!$dbh) {
+    $errstr = $DBI::errstr;
+    return;
+  }
+#) if(!$dbh);
+
+  local $dbh->{RaiseError} = 1;
+
+  eval {
 ##fixme:  initialize the DB if we can't find the table (since, by definition, there's
 # nothing there if we can't select from it...)
-  my $tblsth = $dbh->prepare("SELECT count(*) FROM pg_catalog.pg_class WHERE relkind='r' AND relname=?");
-  my ($tblcount) = $dbh->selectrow_array($tblsth, undef, ('misc'));
-  return (undef,$DBI::errstr) if $dbh->err;
+    my $tblsth = $dbh->prepare("SELECT count(*) FROM pg_catalog.pg_class WHERE relkind='r' AND relname=?");
+    my ($tblcount) = $dbh->selectrow_array($tblsth, undef, ('misc'));
+#  return (undef,$DBI::errstr) if $dbh->err;
 
 #if ($tblcount == 0) {
@@ -1351 +1382 @@
 #}
 
-
 # Return here if we can't select.
 # This should retrieve the dbversion key.
-  my $sth = $dbh->prepare("SELECT key,value FROM misc WHERE misc_id=1");
-  $sth->execute();
-  return (undef,$DBI::errstr) if ($sth->err);
+    my $sth = $dbh->prepare("SELECT key,value FROM misc WHERE misc_id=1");
+    $sth->execute();
+#  return (undef,$DBI::errstr) if ($sth->err);
 
 ##fixme:  do stuff to the DB on version mismatch
@@ -1365 +1395 @@
 # 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);
-
-  $sth->finish;
+    $sth->fetchrow();
+#  return (undef,$DBI::errstr)  if ($sth->err);
+
+    $sth->finish;
+
+  }; # wrapped DB checks
+  if ($@) {
+    $errstr = $@;
+    return;
+  }
 
 # If we get here, we should be OK.
-  return ($dbh,"DB connection OK");
+  return $dbh;
 } # end connectDB
 
@@ -1379 +1415 @@
 # Requires a database handle
 sub finish {
-  my $dbh = $_[0];
-  $dbh->disconnect;
+  my $self = shift;
+  $self->{dbh}->disconnect;
 } # end finish
 
@@ -1387 +1423 @@
 # Initialize global variables
 # NB: this does NOT include web-specific session variables!
-# Requires a database handle
 sub initGlobals {
-  my $dbh = shift;
+  my $self = shift;
+  my $dbh = $self->{dbh};
 
 # load record types from database