Changeset 281 for trunk

Timestamp:

03/22/12 15:31:21 (13 years ago)

Author:

Kris Deugau

Message:

/trunk

Clean up some lingering structural messes in DNSDB.pm

• Make comment headers on all utility subs consistent
• Move _log() into "utility subs" grouping. Remove commented user-info-finding code in passing.
• Add heading comment on validation subs since it would be pretty much the same for all of them.

Fix a bug in addRec() in passing as well; weight and port were
shift'ed from the argument list in the wrong order.

File:

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

trunk/DNSDB.pm

@@ -156 +156 @@
 ##
 ## utility functions
-# _rectable()
+##
+
+## DNSDB::_rectable()
 # Takes default+rdns flags, returns appropriate table name
 sub _rectable {
@@ -167 +169 @@
 } # end _rectable()
 
-# _recparent()
+## DNSDB::_recparent()
 # Takes default+rdns flags, returns appropriate parent-id column name
 sub _recparent {
@@ -178 +180 @@
 } # end _recparent()
 
+## DNSDB::_ipparent()
 # Check an IP to be added in a reverse zone to see if it's really in the requested parent.
 # Takes a database handle, default and reverse flags, IP (fragment) to check, parent zone ID,
@@ -241 +244 @@
 } # end _ipparent()
 
+## DNSDB::_hostparent()
 # A little different than _ipparent above;  this tries to *find* the parent zone of a hostname
+# Takes a database handle and hostname.
+# Returns the domain ID of the parent domain if one was found.
 sub _hostparent {
   my $dbh = shift;
@@ -258 +264 @@
 } # end _hostparent()
 
+## DNSDB::_log()
+# Log an action
+# Takes a database handle and log entry hash containing at least:
+#  user_id, group_id, log entry
+# and optionally one or more of:
+#  domain_id, rdns_id
+sub _log {
+  my $dbh = shift;
+
+  my %args = @_;
+
+  $args{rdns_id} = 0 if !$args{rdns_id};
+  $args{domain_id} = 0 if !$args{domain_id};
+
+##fixme:  farm out the actual logging to different subs for file, syslog, internal, etc based on config
+#  if ($config{log_channel} eq 'sql') {
+  $dbh->do("INSERT INTO log (domain_id,rdns_id,group_id,entry,user_id,email,name) VALUES (?,?,?,?,?,?,?)",
+        undef,
+        ($args{domain_id}, $args{rdns_id}, $args{group_id}, $args{entry},
+                $userdata{userid}, $userdata{username}, $userdata{fullname}) );
+#  } elsif ($config{log_channel} eq 'file') {
+#  } elsif ($config{log_channel} eq 'syslog') {
+#  }
+} # end _log
+
+
 ##
 ## Record validation subs.
 ##
+
+## All of these subs take substantially the same arguments:
+# a database handle
+# a hash containing at least the following keys:
+#  - defrec (default/live flag)
+#  - revrec (forward/reverse flag)
+#  - id (parent entity ID)
+#  - host (hostname)
+#  - rectype
+#  - val (IP, hostname [CNAME/MX/SRV] or text)
+#  - addr (NetAddr::IP object from val.  May be undef.)
+# MX and SRV record validation also expect distance, and SRV records expect weight and port as well.
+# host, rectype, and addr should be references as these may be modified in validation
 
 # A record
@@ -1192 +1237 @@
 
 
-## DNSDB::_log()
-# Log an action
-# Internal sub
-# Takes a database handle and log entry hash containing at least:
-# user_id, group_id, log entry
-# and optionally one or more of:
-# username/email, user full name, domain_id, rdns_id
-##fixme:  convert to trailing hash for user info
-# User info must contain a (user ID OR username)+fullname
-sub _log {
-  my $dbh = shift;
-
-  my %args = @_;
-
-  $args{rdns_id} = 0 if !$args{rdns_id};
-  $args{domain_id} = 0 if !$args{domain_id};
-
-##fixme:  need better way(s?) to snag userinfo for log entries.  don't want to have
-# to pass around yet *another* constant (already passing $dbh, shouldn't need to)
-#  my $fullname;
-#  if (!$args{user_id}) {
-#    ($args{user_id}, $fullname) = $dbh->selectrow_array("SELECT user_id, firstname || ' ' || lastname FROM users".
-#       " WHERE username=?", undef, ($args{username}));
-#  }
-#  if (!$args{username}) {
-#    ($args{username}, $fullname) = $dbh->selectrow_array("SELECT username, firstname || ' ' || lastname FROM users".
-#       " WHERE user_id=?", undef, ($args{user_id}));
-#  }
-#  if (!$args{fullname}) {
-#    ($fullname) = $dbh->selectrow_array("SELECT firstname || ' ' || lastname FROM users".
-#       " WHERE user_id=?", undef, ($args{user_id}));
-#  }
-#
-#  $args{name} = $fullname if !$args{name};
-
-##fixme:  farm out the actual logging to different subs for file, syslog, internal, etc based on config
-#  if ($config{log_channel} eq 'sql') {
-  $dbh->do("INSERT INTO log (domain_id,rdns_id,group_id,entry,user_id,email,name) VALUES (?,?,?,?,?,?,?)",
-        undef,
-        ($args{domain_id}, $args{rdns_id}, $args{group_id}, $args{entry},
-                $userdata{userid}, $userdata{username}, $userdata{fullname}) );
-#  } elsif ($config{log_channel} eq 'file') {
-#  } elsif ($config{log_channel} eq 'syslog') {
-#  }
-
-} # end _log
-
-
 ##
 ## Processing subs
@@ -2462 +2459 @@
   # Collect these even if we're only doing a simple A record so we can call *any* validation sub
   my $dist = shift;
+  my $weight = shift;
   my $port = shift;
-  my $weight = shift;
 
   my $fields;