Context Navigation

source: trunk/DNSDB.pm@ 157

Last change on this file since 157 was 157, checked in by Kris Deugau, 13 years ago

/trunk

Handle case of "id not found" in isParent(). If the requested
id can't be found, obviously the other id can't be its parent.

Property svn:keywords set to Date Rev Author Id

File size: 59.7 KB

Rev	Line
[2]	1	# dns/trunk/DNSDB.pm
	2	# Abstraction functions for DNS administration
	3	###
	4	# SVN revision info
	5	# $Date: 2011-10-28 20:56:10 +0000 (Fri, 28 Oct 2011) $
	6	# SVN revision $Rev: 157 $
	7	# Last update by $Author: kdeugau $
	8	###
	9	# Copyright (C) 2008 - Kris Deugau <kdeugau@deepnet.cx>
	10
	11	package DNSDB;
	12
	13	use strict;
	14	use warnings;
	15	use Exporter;
	16	use DBI;
[33]	17	use Net::DNS;
[65]	18	use Crypt::PasswdMD5;
[2]	19	#use Net::SMTP;
[132]	20	use NetAddr::IP;
[2]	21	#use POSIX;
	22	use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
	23
	24	$VERSION = 0.1;
	25	@ISA = qw(Exporter);
	26	@EXPORT_OK = qw(
[67]	27	&initGlobals
	28	&initPermissions &getPermissions &changePermissions &comparePermissions
[112]	29	&changeGroup
[128]	30	&loadConfig &connectDB &finish
[91]	31	&addDomain &delDomain &domainName &domainID
[22]	32	&addGroup &delGroup &getChildren &groupName
[83]	33	&addUser &updateUser &delUser &userFullName &userStatus &getUserData
[91]	34	&getSOA &getRecLine &getDomRecs &getRecCount
[22]	35	&addRec &updateRec &delRec
[117]	36	&getParents
	37	&isParent
[34]	38	&domStatus &importAXFR
[103]	39	&export
[128]	40	%typemap %reverse_typemap %config
[66]	41	%permissions @permtypes $permlist
[2]	42	);
	43
	44	@EXPORT = (); # Export nothing by default.
	45	%EXPORT_TAGS = ( ALL => [qw(
[67]	46	&initGlobals
	47	&initPermissions &getPermissions &changePermissions &comparePermissions
[112]	48	&changeGroup
[128]	49	&loadConfig &connectDB &finish
[91]	50	&addDomain &delDomain &domainName &domainID
[22]	51	&addGroup &delGroup &getChildren &groupName
[83]	52	&addUser &updateUser &delUser &userFullName &userStatus &getUserData
[91]	53	&getSOA &getRecLine &getDomRecs &getRecCount
[22]	54	&addRec &updateRec &delRec
[117]	55	&getParents
	56	&isParent
[34]	57	&domStatus &importAXFR
[103]	58	&export
[128]	59	%typemap %reverse_typemap %config
[66]	60	%permissions @permtypes $permlist
[2]	61	)]
	62	);
	63
	64	our $group = 1;
	65	our $errstr = '';
	66
	67	# Halfway sane defaults for SOA, TTL, etc.
[101]	68	# serial defaults to 0 for convenience.
	69	# value will be either YYYYMMDDNN for BIND/etc, or auto-internal for tinydns
[2]	70	our %def = qw (
	71	contact hostmaster.DOMAIN
	72	prins ns1.myserver.com
[101]	73	serial 0
[2]	74	soattl 86400
	75	refresh 10800
	76	retry 3600
	77	expire 604800
	78	minttl 10800
	79	ttl 10800
	80	);
	81
[66]	82	# Arguably defined wholly in the db, but little reason to change without supporting code changes
	83	our @permtypes = qw (
	84	group_edit group_create group_delete
	85	user_edit user_create user_delete
	86	domain_edit domain_create domain_delete
	87	record_edit record_create record_delete
	88	self_edit admin
	89	);
	90	our $permlist = join(',',@permtypes);
	91
[2]	92	# DNS record type map and reverse map.
	93	# loaded from the database, from http://www.iana.org/assignments/dns-parameters
	94	our %typemap;
	95	our %reverse_typemap;
	96
[65]	97	our %permissions;
[55]	98
[128]	99	# Prepopulate a basic config. Note some of these will cause errors if left unset.
	100	our %config = (
	101	# Database connection info
	102	dbname => 'dnsdb',
	103	dbuser => 'dnsdb',
	104	dbpass => 'secret',
	105	dbhost => '',
	106
	107	# Email notice settings
	108	mailhost => 'smtp.example.com',
	109	mailsender => 'dnsdb@example.com',
	110	mailname => 'DNS Administration',
	111
	112	# Template directory
	113	templatedir => 'templates/',
	114	# fmeh. this is a real web path, not a logical internal one. hm..
	115	# cssdir => 'templates/';
	116	);
	117
	118
[2]	119	##
	120	## Initialization and cleanup subs
	121	##
	122
[55]	123
[128]	124	## DNSDB::loadConfig()
	125	# Load the minimum required initial state (DB connect info) from a config file
	126	# Load misc other bits while we're at it.
	127	# Takes an optional basename and config path to look for
	128	# Populates the %config and %def hashes
	129	sub loadConfig {
	130	my $basename = shift \|\| ''; # this will work OK
	131
	132	my $deferr = ''; # place to put error from default config file in case we can't find either one
	133
	134	my $configroot = '/etc/dnsdb';
	135	$configroot = '' if $basename =~ m\|^/\|;
	136	$basename .= ".conf" if $basename !~ /\.conf$/;
	137	my $defconfig = "$configroot/dnsdb.conf";
	138	my $siteconfig = "$configroot/$basename";
	139
	140	# System defaults
[131]	141	__cfgload("$defconfig") or $deferr = $errstr;
[128]	142
[131]	143	# Per-site-ish settings.
	144	if ($basename ne '.conf') {
	145	unless (__cfgload("$siteconfig")) {
	146	$errstr = ($deferr ? "Error opening default config file $defconfig: $deferr\n" : '').
[128]	147	"Error opening site config file $siteconfig";
[131]	148	return;
	149	}
[128]	150	}
	151
	152	# All good, clear the error and go home.
	153	$errstr = '';
	154	return 1;
	155	} # end loadConfig()
	156
	157
	158	## DNSDB::__cfgload()
	159	# Private sub to parse a config file and load it into %config
	160	# Takes a file handle on an open config file
	161	sub __cfgload {
	162	$errstr = '';
	163	my $cfgfile = shift;
[131]	164
[128]	165	if (open CFG, "<$cfgfile") {
	166	while (<CFG>) {
	167	chomp;
	168	s/^\s*//;
	169	next if /^#/;
	170	next if /^$/;
	171	# hmm. more complex bits in this file might require [heading] headers, maybe?
	172	# $mode = $1 if /^\[(a-z)+]/;
	173	# DB connect info
	174	$config{dbname} = $1 if /^dbname\s=\s([a-z0-9_.-]+)/i;
	175	$config{dbuser} = $1 if /^dbuser\s=\s([a-z0-9_.-]+)/i;
	176	$config{dbpass} = $1 if /^dbpass\s=\s([a-z0-9_.-]+)/i;
	177	$config{dbhost} = $1 if /^dbhost\s=\s([a-z0-9_.-]+)/i;
	178	# SOA defaults
	179	$def{contact} = $1 if /^contact\s=\s([a-z0-9_.-]+)/i;
	180	$def{prins} = $1 if /^prins\s=\s([a-z0-9_.-]+)/i;
	181	$def{soattl} = $1 if /^soattl\s=\s([a-z0-9_.-]+)/i;
	182	$def{refresh} = $1 if /^refresh\s=\s([a-z0-9_.-]+)/i;
	183	$def{retry} = $1 if /^retry\s=\s([a-z0-9_.-]+)/i;
	184	$def{expire} = $1 if /^expire\s=\s([a-z0-9_.-]+)/i;
	185	$def{minttl} = $1 if /^minttl\s=\s([a-z0-9_.-]+)/i;
	186	$def{ttl} = $1 if /^ttl\s=\s([a-z0-9_.-]+)/i;
	187	# Mail settings
	188	$config{mailhost} = $1 if /^mailhost\s=\s([a-z0-9_.-]+)/i;
	189	$config{mailsender} = $1 if /^mailsender\s=\s([a-z0-9_.@-]+)/i;
	190	$config{mailname} = $1 if /^mailname\s=\s([a-z0-9\s_.-]+)/i;
	191	}
	192	close CFG;
	193	} else {
	194	$errstr = $!;
	195	return;
	196	}
	197	return 1;
	198	} # end __cfgload()
	199
	200
[2]	201	## DNSDB::connectDB()
	202	# Creates connection to DNS database.
	203	# Requires the database name, username, and password.
	204	# Returns a handle to the db.
	205	# Set up for a PostgreSQL db; could be any transactional DBMS with the
	206	# right changes.
	207	sub connectDB {
	208	$errstr = '';
[15]	209	my $dbname = shift;
	210	my $user = shift;
	211	my $pass = shift;
[2]	212	my $dbh;
	213	my $DSN = "DBI:Pg:dbname=$dbname";
	214
	215	my $host = shift;
	216	$DSN .= ";host=$host" if $host;
	217
	218	# Note that we want to autocommit by default, and we will turn it off locally as necessary.
	219	# We may not want to print gobbledygook errors; YMMV. Have to ponder that further.
	220	$dbh = DBI->connect($DSN, $user, $pass, {
	221	AutoCommit => 1,
	222	PrintError => 0
	223	})
	224	or return (undef, $DBI::errstr) if(!$dbh);
	225
	226	# Return here if we can't select. Note that this indicates a
	227	# problem executing the select.
	228	my $sth = $dbh->prepare("select group_id from groups limit 1");
	229	$sth->execute();
	230	return (undef,$DBI::errstr) if ($sth->err);
	231
	232	# See if the select returned anything (or null data). This should
	233	# succeed if the select executed, but...
	234	$sth->fetchrow();
	235	return (undef,$DBI::errstr) if ($sth->err);
	236
	237	$sth->finish;
	238
	239	# If we get here, we should be OK.
	240	return ($dbh,"DB connection OK");
	241	} # end connectDB
	242
	243
	244	## DNSDB::finish()
	245	# Cleans up after database handles and so on.
	246	# Requires a database handle
	247	sub finish {
	248	my $dbh = $_[0];
	249	$dbh->disconnect;
	250	} # end finish
	251
	252
	253	## DNSDB::initGlobals()
	254	# Initialize global variables
	255	# NB: this does NOT include web-specific session variables!
	256	# Requires a database handle
	257	sub initGlobals {
	258	my $dbh = shift;
	259
	260	# load system-wide site defaults and things from config file
[29]	261	if (open SYSDEFAULTS, "</etc/dnsdb.conf") {
[2]	262	##fixme - error check!
[29]	263	while (<SYSDEFAULTS>) {
	264	next if /^\s*#/;
	265	$def{contact} = $1 if /contact ?= ?([a-z0-9_.-]+)/i;
	266	$def{prins} = $1 if /prins ?= ?([a-z0-9_.-]+)/i;
	267	$def{soattl} = $1 if /soattl ?= ?([a-z0-9_.-]+)/i;
	268	$def{refresh} = $1 if /refresh ?= ?([a-z0-9_.-]+)/i;
	269	$def{retry} = $1 if /retry ?= ?([a-z0-9_.-]+)/i;
	270	$def{expire} = $1 if /expire ?= ?([a-z0-9_.-]+)/i;
	271	$def{minttl} = $1 if /minttl ?= ?([a-z0-9_.-]+)/i;
	272	$def{ttl} = $1 if /ttl ?= ?([a-z0-9_.-]+)/i;
[2]	273	##fixme? load DB user/pass from config file?
[29]	274	}
[2]	275	}
	276	# load from database
	277	my $sth = $dbh->prepare("select val,name from rectypes");
	278	$sth->execute;
	279	while (my ($recval,$recname) = $sth->fetchrow_array()) {
	280	$typemap{$recval} = $recname;
	281	$reverse_typemap{$recname} = $recval;
	282	}
	283	} # end initGlobals
	284
	285
[65]	286	## DNSDB::initPermissions()
	287	# Set up permissions global
	288	# Takes database handle and UID
	289	sub initPermissions {
	290	my $dbh = shift;
	291	my $uid = shift;
	292
	293	# %permissions = $(getPermissions($dbh,'user',$uid));
	294	getPermissions($dbh, 'user', $uid, \%permissions);
	295
	296	} # end initPermissions()
	297
	298
	299	## DNSDB::getPermissions()
	300	# Get permissions from DB
	301	# Requires DB handle, group or user flag, ID, and hashref.
	302	sub getPermissions {
	303	my $dbh = shift;
	304	my $type = shift;
	305	my $id = shift;
	306	my $hash = shift;
	307
	308	my $sql = qq(
	309	SELECT
	310	p.admin,p.self_edit,
	311	p.group_create,p.group_edit,p.group_delete,
	312	p.user_create,p.user_edit,p.user_delete,
	313	p.domain_create,p.domain_edit,p.domain_delete,
	314	p.record_create,p.record_edit,p.record_delete
	315	FROM permissions p
	316	);
	317	if ($type eq 'group') {
	318	$sql .= qq(
	319	JOIN groups g ON g.permission_id=p.permission_id
	320	WHERE g.group_id=?
	321	);
	322	} else {
	323	$sql .= qq(
	324	JOIN users u ON u.permission_id=p.permission_id
	325	WHERE u.user_id=?
	326	);
	327	}
	328
	329	my $sth = $dbh->prepare($sql);
	330
	331	$sth->execute($id) or die "argh: ".$sth->errstr;
	332
	333	# my $permref = $sth->fetchrow_hashref;
	334	# return $permref;
	335	# $hash = $permref;
	336	# Eww. Need to learn how to forcibly drop a hashref onto an existing hash.
	337	($hash->{admin},$hash->{self_edit},
	338	$hash->{group_create},$hash->{group_edit},$hash->{group_delete},
	339	$hash->{user_create},$hash->{user_edit},$hash->{user_delete},
	340	$hash->{domain_create},$hash->{domain_edit},$hash->{domain_delete},
	341	$hash->{record_create},$hash->{record_edit},$hash->{record_delete})
	342	= $sth->fetchrow_array;
	343
	344	} # end getPermissions()
	345
	346
	347	## DNSDB::changePermissions()
	348	# Update an ACL entry
	349	# Takes a db handle, type, owner-id, and hashref for the changed permissions.
	350	sub changePermissions {
	351	my $dbh = shift;
	352	my $type = shift;
	353	my $id = shift;
	354	my $newperms = shift;
[87]	355	my $inherit = shift \|\| 0;
[65]	356
[78]	357	my $failmsg = '';
[66]	358
[87]	359	# see if we're switching from inherited to custom. for bonus points,
	360	# snag the permid and parent permid anyway, since we'll need the permid
	361	# to set/alter custom perms, and both if we're switching from custom to
	362	# inherited.
	363	my $sth = $dbh->prepare("SELECT (u.permission_id=g.permission_id) AS was_inherited,u.permission_id,g.permission_id".
[65]	364	" FROM ".($type eq 'user' ? 'users' : 'groups')." u ".
[66]	365	" JOIN groups g ON u.".($type eq 'user' ? '' : 'parent_')."group_id=g.group_id ".
[65]	366	" WHERE u.".($type eq 'user' ? 'user' : 'group')."_id=?");
	367	$sth->execute($id);
	368
[87]	369	my ($wasinherited,$permid,$parpermid) = $sth->fetchrow_array;
[66]	370
[78]	371	# hack phtoui
	372	# group id 1 is "special" in that it's it's own parent (err... possibly.)
	373	# may make its parent id 0 which doesn't exist, and as a bonus is Perl-false.
	374	$wasinherited = 0 if ($type eq 'group' && $id == 1);
	375
[66]	376	local $dbh->{AutoCommit} = 0;
	377	local $dbh->{RaiseError} = 1;
	378
	379	# Wrap all the SQL in a transaction
	380	eval {
[87]	381	if ($inherit) {
	382
	383	$dbh->do("UPDATE ".($type eq 'user' ? 'users' : 'groups')." SET inherit_perm='t',permission_id=? ".
	384	"WHERE ".($type eq 'user' ? 'user' : 'group')."_id=?", undef, ($parpermid, $id) );
	385	$dbh->do("DELETE FROM permissions WHERE permission_id=?", undef, ($permid) );
	386
	387	} else {
	388
	389	if ($wasinherited) { # munge new permission entry in if we're switching from inherited perms
[66]	390	##fixme: need to add semirecursive bit to properly munge inherited permission ID on subgroups and users
[87]	391	# ... if'n'when we have groups with fully inherited permissions.
	392	# SQL is coo
	393	$dbh->do("INSERT INTO permissions ($permlist,".($type eq 'user' ? 'user' : 'group')."_id) ".
	394	"SELECT $permlist,? FROM permissions WHERE permission_id=?", undef, ($id,$permid) );
	395	($permid) = $dbh->selectrow_array("SELECT permission_id FROM permissions ".
	396	"WHERE ".($type eq 'user' ? 'user' : 'group')."_id=?", undef, ($id) );
	397	$dbh->do("UPDATE ".($type eq 'user' ? 'users' : 'groups')." SET inherit_perm='f',permission_id=? ".
	398	"WHERE ".($type eq 'user' ? 'user' : 'group')."_id=?", undef, ($permid, $id) );
[66]	399	}
[78]	400
[87]	401	# and now set the permissions we were passed
	402	foreach (@permtypes) {
	403	if (defined ($newperms->{$_})) {
	404	$dbh->do("UPDATE permissions SET $_=? WHERE permission_id=?", undef, ($newperms->{$_},$permid) );
	405	}
	406	}
	407
	408	} # (inherited->)? custom
	409
[66]	410	$dbh->commit;
	411	}; # end eval
	412	if ($@) {
	413	my $msg = $@;
	414	eval { $dbh->rollback; };
[87]	415	return ('FAIL',"$failmsg: $msg ($permid)");
[66]	416	} else {
	417	return ('OK',$permid);
	418	}
	419
[65]	420	} # end changePermissions()
	421
	422
[67]	423	## DNSDB::comparePermissions()
	424	# Compare two permission hashes
	425	# Returns '>', '<', '=', '!'
	426	sub comparePermissions {
	427	my $p1 = shift;
	428	my $p2 = shift;
	429
	430	my $retval = '='; # assume equality until proven otherwise
	431
	432	no warnings "uninitialized";
	433
	434	foreach (@permtypes) {
	435	next if $p1->{$_} == $p2->{$_}; # equal is good
	436	if ($p1->{$_} && !$p2->{$_}) {
	437	if ($retval eq '<') { # if we've already found an unequal pair where
	438	$retval = '!'; # $p2 has more access, and we now find a pair
	439	last; # where $p1 has more access, the overall access
	440	} # is neither greater or lesser, it's unequal.
	441	$retval = '>';
	442	}
	443	if (!$p1->{$_} && $p2->{$_}) {
	444	if ($retval eq '>') { # if we've already found an unequal pair where
	445	$retval = '!'; # $p1 has more access, and we now find a pair
	446	last; # where $p2 has more access, the overall access
	447	} # is neither greater or lesser, it's unequal.
	448	$retval = '<';
	449	}
	450	}
	451	return $retval;
	452	} # end comparePermissions()
	453
	454
[112]	455	## DNSDB::changeGroup()
	456	# Change group ID of an entity
	457	# Takes a database handle, entity type, entity ID, and new group ID
	458	sub changeGroup {
	459	my $dbh = shift;
	460	my $type = shift;
	461	my $id = shift;
	462	my $newgrp = shift;
	463
	464	##fixme: fail on not enough args
	465	#return ('FAIL', "Missing
	466
	467	if ($type eq 'domain') {
	468	$dbh->do("UPDATE domains SET group_id=? WHERE domain_id=?", undef, ($newgrp, $id))
	469	or return ('FAIL','Group change failed: '.$dbh->errstr);
	470	} elsif ($type eq 'user') {
	471	$dbh->do("UPDATE users SET group_id=? WHERE user_id=?", undef, ($newgrp, $id))
	472	or return ('FAIL','Group change failed: '.$dbh->errstr);
	473	} elsif ($type eq 'group') {
	474	$dbh->do("UPDATE groups SET parent_group_id=? WHERE group_id=?", undef, ($newgrp, $id))
	475	or return ('FAIL','Group change failed: '.$dbh->errstr);
	476	}
	477	return ('OK','OK');
	478	} # end changeGroup()
	479
	480
[55]	481	## DNSDB::_log()
	482	# Log an action
	483	# Internal sub
	484	# Takes a database handle, <foo>, <bar>
	485	sub _log {
	486	} # end _log
	487
	488
[2]	489	##
	490	## Processing subs
	491	##
	492
	493	## DNSDB::addDomain()
	494	# Add a domain
	495	# Takes a database handle, domain name, numeric group, and boolean(ish) state (active/inactive)
	496	# Returns a status code and message
	497	sub addDomain {
	498	$errstr = '';
	499	my $dbh = shift;
	500	return ('FAIL',"Need database handle") if !$dbh;
	501	my $domain = shift;
[91]	502	return ('FAIL',"Domain must not be blank") if !$domain;
[2]	503	my $group = shift;
	504	return ('FAIL',"Need group") if !defined($group);
	505	my $state = shift;
	506	return ('FAIL',"Need domain status") if !defined($state);
	507
[116]	508	$state = 1 if $state =~ /^active$/;
	509	$state = 1 if $state =~ /^on$/;
	510	$state = 0 if $state =~ /^inactive$/;
	511	$state = 0 if $state =~ /^off$/;
	512
	513	return ('FAIL',"Invalid domain status") if $state !~ /^\d+$/;
	514
[38]	515	my $sth = $dbh->prepare("SELECT domain_id FROM domains WHERE domain=?");
[3]	516	my $dom_id;
	517
[38]	518	# quick check to start to see if we've already got one
	519	$sth->execute($domain);
	520	($dom_id) = $sth->fetchrow_array;
	521
	522	return ('FAIL', "Domain already exists") if $dom_id;
	523
[2]	524	# Allow transactions, and raise an exception on errors so we can catch it later.
	525	# Use local to make sure these get "reset" properly on exiting this block
	526	local $dbh->{AutoCommit} = 0;
	527	local $dbh->{RaiseError} = 1;
	528
	529	# Wrap all the SQL in a transaction
	530	eval {
	531	# insert the domain...
	532	my $sth = $dbh->prepare("insert into domains (domain,group_id,status) values (?,?,?)");
	533	$sth->execute($domain,$group,$state);
	534
	535	# get the ID...
	536	$sth = $dbh->prepare("select domain_id from domains where domain='$domain'");
	537	$sth->execute;
[3]	538	($dom_id) = $sth->fetchrow_array();
[2]	539
	540	# ... and now we construct the standard records from the default set. NB: group should be variable.
[3]	541	$sth = $dbh->prepare("select host,type,val,distance,weight,port,ttl from default_records where group_id=$group");
	542	my $sth_in = $dbh->prepare("insert into records (domain_id,host,type,val,distance,weight,port,ttl)".
	543	" values ($dom_id,?,?,?,?,?,?,?)");
[2]	544	$sth->execute;
[3]	545	while (my ($host,$type,$val,$dist,$weight,$port,$ttl) = $sth->fetchrow_array()) {
[2]	546	$host =~ s/DOMAIN/$domain/g;
[37]	547	$val =~ s/DOMAIN/$domain/g;
[3]	548	$sth_in->execute($host,$type,$val,$dist,$weight,$port,$ttl);
[2]	549	}
	550
	551	# once we get here, we should have suceeded.
	552	$dbh->commit;
	553	}; # end eval
	554
	555	if ($@) {
	556	my $msg = $@;
	557	eval { $dbh->rollback; };
	558	return ('FAIL',$msg);
	559	} else {
[3]	560	return ('OK',$dom_id);
[2]	561	}
	562	} # end addDomain
	563
	564
[3]	565	## DNSDB::delDomain()
	566	# Delete a domain.
	567	# for now, just delete the records, then the domain.
	568	# later we may want to archive it in some way instead (status code 2, for example?)
	569	sub delDomain {
	570	my $dbh = shift;
[5]	571	my $domid = shift;
[3]	572
	573	# Allow transactions, and raise an exception on errors so we can catch it later.
	574	# Use local to make sure these get "reset" properly on exiting this block
	575	local $dbh->{AutoCommit} = 0;
	576	local $dbh->{RaiseError} = 1;
	577
[23]	578	my $failmsg = '';
	579
[3]	580	# Wrap all the SQL in a transaction
	581	eval {
[5]	582	my $sth = $dbh->prepare("delete from records where domain_id=?");
[23]	583	$failmsg = "Failure removing domain records";
[5]	584	$sth->execute($domid);
	585	$sth = $dbh->prepare("delete from domains where domain_id=?");
[23]	586	$failmsg = "Failure removing domain";
[5]	587	$sth->execute($domid);
[3]	588
	589	# once we get here, we should have suceeded.
[23]	590	$dbh->commit;
[3]	591	}; # end eval
	592
	593	if ($@) {
	594	my $msg = $@;
	595	eval { $dbh->rollback; };
[23]	596	return ('FAIL',"$failmsg: $msg");
[3]	597	} else {
	598	return ('OK','OK');
	599	}
	600
	601	} # end delDomain()
	602
	603
[2]	604	## DNSDB::domainName()
	605	# Return the domain name based on a domain ID
	606	# Takes a database handle and the domain ID
	607	# Returns the domain name or undef on failure
	608	sub domainName {
	609	$errstr = '';
	610	my $dbh = shift;
	611	my $domid = shift;
[91]	612	my ($domname) = $dbh->selectrow_array("SELECT domain FROM domains WHERE domain_id=?", undef, ($domid) );
[2]	613	$errstr = $DBI::errstr if !$domname;
	614	return $domname if $domname;
[91]	615	} # end domainName()
[2]	616
	617
[91]	618	## DNSDB::domainID()
	619	# Takes a database handle and domain name
	620	# Returns the domain ID number
	621	sub domainID {
	622	$errstr = '';
	623	my $dbh = shift;
	624	my $domain = shift;
	625	my ($domid) = $dbh->selectrow_array("SELECT domain_id FROM domains WHERE domain=?", undef, ($domain) );
	626	$errstr = $DBI::errstr if !$domid;
	627	return $domid if $domid;
	628	} # end domainID()
	629
	630
[18]	631	## DNSDB::addGroup()
	632	# Add a group
[66]	633	# Takes a database handle, group name, parent group, hashref for permissions,
	634	# and optional template-vs-cloneme flag
[18]	635	# Returns a status code and message
	636	sub addGroup {
	637	$errstr = '';
	638	my $dbh = shift;
[20]	639	my $groupname = shift;
	640	my $pargroup = shift;
[66]	641	my $permissions = shift;
[18]	642
[66]	643	# 0 indicates "custom", hardcoded.
[18]	644	# Any other value clones that group's default records, if it exists.
[66]	645	my $inherit = shift \|\| 0;
	646	##fixme: need a flag to indicate clone records or <?> ?
[18]	647
	648	# Allow transactions, and raise an exception on errors so we can catch it later.
	649	# Use local to make sure these get "reset" properly on exiting this block
	650	local $dbh->{AutoCommit} = 0;
	651	local $dbh->{RaiseError} = 1;
	652
[38]	653	my $sth = $dbh->prepare("SELECT group_id FROM groups WHERE group_name=?");
	654	my $group_id;
	655
	656	# quick check to start to see if we've already got one
	657	$sth->execute($groupname);
	658	($group_id) = $sth->fetchrow_array;
	659
	660	return ('FAIL', "Group already exists") if $group_id;
	661
[18]	662	# Wrap all the SQL in a transaction
	663	eval {
[38]	664	$sth = $dbh->prepare("INSERT INTO groups (parent_group_id,group_name) VALUES (?,?)");
[20]	665	$sth->execute($pargroup,$groupname);
[18]	666
	667	$sth = $dbh->prepare("SELECT group_id FROM groups WHERE group_name=?");
[20]	668	$sth->execute($groupname);
	669	my ($groupid) = $sth->fetchrow_array();
[18]	670
[66]	671	# Permissions
	672	if ($inherit) {
	673	} else {
	674	my @permvals;
	675	foreach (@permtypes) {
	676	if (!defined ($permissions->{$_})) {
	677	push @permvals, 0;
	678	} else {
	679	push @permvals, $permissions->{$_};
	680	}
	681	}
	682
	683	$sth = $dbh->prepare("INSERT INTO permissions (group_id,$permlist) values (?".',?'x($#permtypes+1).")");
	684	$sth->execute($groupid,@permvals);
	685
	686	$sth = $dbh->prepare("SELECT permission_id FROM permissions WHERE group_id=?");
	687	$sth->execute($groupid);
	688	my ($permid) = $sth->fetchrow_array();
	689
	690	$dbh->do("UPDATE groups SET permission_id=$permid WHERE group_id=$groupid");
	691	} # done permission fiddling
	692
	693	# Default records
[18]	694	$sth = $dbh->prepare("INSERT INTO default_records (group_id,host,type,val,distance,weight,port,ttl) ".
[20]	695	"VALUES ($groupid,?,?,?,?,?,?,?)");
[66]	696	if ($inherit) {
[87]	697	# Duplicate records from parent. Actually relying on inherited records feels
	698	# very fragile, and it would be problematic to roll over at a later time.
[18]	699	my $sth2 = $dbh->prepare("SELECT host,type,val,distance,weight,port,ttl FROM default_records WHERE group_id=?");
[87]	700	$sth2->execute($pargroup);
[18]	701	while (my @clonedata = $sth2->fetchrow_array) {
	702	$sth->execute(@clonedata);
	703	}
	704	} else {
[66]	705	##fixme: Hardcoding is Bad, mmmmkaaaay?
[18]	706	# reasonable basic defaults for SOA, MX, NS, and minimal hosting
	707	# could load from a config file, but somewhere along the line we need hardcoded bits.
	708	$sth->execute('ns1.example.com:hostmaster.example.com', 6, '10800:3600:604800:10800', 0, 0, 0, 86400);
	709	$sth->execute('DOMAIN', 1, '192.168.4.2', 0, 0, 0, 7200);
	710	$sth->execute('DOMAIN', 15, 'mx.example.com', 10, 0, 0, 7200);
	711	$sth->execute('DOMAIN', 2, 'ns1.example.com', 0, 0, 0, 7200);
	712	$sth->execute('DOMAIN', 2, 'ns2.example.com', 0, 0, 0, 7200);
	713	$sth->execute('www.DOMAIN', 5, 'DOMAIN', 0, 0, 0, 7200);
	714	}
	715
	716	# once we get here, we should have suceeded.
	717	$dbh->commit;
	718	}; # end eval
	719
	720	if ($@) {
	721	my $msg = $@;
	722	eval { $dbh->rollback; };
	723	return ('FAIL',$msg);
	724	} else {
	725	return ('OK','OK');
	726	}
	727
	728	} # end addGroup()
	729
	730
[22]	731	## DNSDB::delGroup()
	732	# Delete a group.
	733	# Takes a group ID
	734	# Returns a status code and message
	735	sub delGroup {
	736	my $dbh = shift;
	737	my $groupid = shift;
	738
	739	# Allow transactions, and raise an exception on errors so we can catch it later.
	740	# Use local to make sure these get "reset" properly on exiting this block
	741	local $dbh->{AutoCommit} = 0;
	742	local $dbh->{RaiseError} = 1;
	743
	744	##fixme: locate "knowable" error conditions and deal with them before the eval
[23]	745	# ... or inside, whatever.
[22]	746	# -> domains still exist in group
	747	# -> ...
[23]	748	my $failmsg = '';
[22]	749
	750	# Wrap all the SQL in a transaction
	751	eval {
[23]	752	my $sth = $dbh->prepare("SELECT count(*) FROM domains WHERE group_id=?");
[22]	753	$sth->execute($groupid);
[23]	754	my ($domcnt) = $sth->fetchrow_array;
	755	$failmsg = "Can't remove group ".groupName($dbh,$groupid);
	756	die "$domcnt domains still in group\n" if $domcnt;
	757
	758	$sth = $dbh->prepare("delete from default_records where group_id=?");
	759	$failmsg = "Failed to delete default records for ".groupName($dbh,$groupid);
	760	$sth->execute($groupid);
[22]	761	$sth = $dbh->prepare("delete from groups where group_id=?");
[23]	762	$failmsg = "Failed to remove group ".groupName($dbh,$groupid);
[22]	763	$sth->execute($groupid);
	764
	765	# once we get here, we should have suceeded.
	766	$dbh->commit;
	767	}; # end eval
	768
	769	if ($@) {
	770	my $msg = $@;
	771	eval { $dbh->rollback; };
[23]	772	return ('FAIL',"$failmsg: $msg");
[22]	773	} else {
	774	return ('OK','OK');
	775	}
	776	} # end delGroup()
	777
	778
[19]	779	## DNSDB::getChildren()
	780	# Get a list of all groups whose parent^n is group <n>
[24]	781	# Takes a database handle, group ID, reference to an array to put the group IDs in,
	782	# and an optional flag to return only immediate children or all children-of-children
	783	# default to returning all children
[19]	784	# Calls itself
	785	sub getChildren {
	786	$errstr = '';
	787	my $dbh = shift;
[20]	788	my $rootgroup = shift;
	789	my $groupdest = shift;
[24]	790	my $immed = shift \|\| 'all';
[19]	791
	792	# special break for default group; otherwise we get stuck.
[20]	793	if ($rootgroup == 1) {
[19]	794	# by definition, group 1 is the Root Of All Groups
[24]	795	my $sth = $dbh->prepare("SELECT group_id FROM groups WHERE NOT (group_id=1)".
	796	($immed ne 'all' ? " AND parent_group_id=1" : ''));
[19]	797	$sth->execute;
	798	while (my @this = $sth->fetchrow_array) {
[20]	799	push @$groupdest, @this;
[19]	800	}
	801	} else {
	802	my $sth = $dbh->prepare("SELECT group_id FROM groups WHERE parent_group_id=?");
[20]	803	$sth->execute($rootgroup);
[19]	804	return if $sth->rows == 0;
[20]	805	my @grouplist;
	806	while (my ($group) = $sth->fetchrow_array) {
	807	push @$groupdest, $group;
[24]	808	getChildren($dbh,$group,$groupdest) if $immed eq 'all';
[19]	809	}
	810	}
	811	} # end getChildren()
	812
	813
[20]	814	## DNSDB::groupName()
[17]	815	# Return the group name based on a group ID
	816	# Takes a database handle and the group ID
	817	# Returns the group name or undef on failure
[20]	818	sub groupName {
[13]	819	$errstr = '';
	820	my $dbh = shift;
[20]	821	my $groupid = shift;
	822	my $sth = $dbh->prepare("SELECT group_name FROM groups WHERE group_id=?");
	823	$sth->execute($groupid);
	824	my ($groupname) = $sth->fetchrow_array();
	825	$errstr = $DBI::errstr if !$groupname;
	826	return $groupname if $groupname;
	827	} # end groupName
[13]	828
	829
[118]	830	## DNSDB::groupID()
	831	# Return the group ID based on the group name
	832	# Takes a database handle and the group name
	833	# Returns the group ID or undef on failure
	834	sub groupID {
	835	$errstr = '';
	836	my $dbh = shift;
	837	my $group = shift;
	838	my ($grpid) = $dbh->selectrow_array("SELECT group_id FROM groups WHERE group=?", undef, ($group) );
	839	$errstr = $DBI::errstr if !$grpid;
	840	return $grpid if $grpid;
	841	} # end groupID()
	842
	843
[24]	844	## DNSDB::addUser()
[87]	845	# Add a user.
	846	# Takes a DB handle, username, group ID, password, state (active/inactive).
	847	# Optionally accepts:
	848	# user type (user/admin) - defaults to user
	849	# permissions string - defaults to inherit from group
	850	# three valid forms:
	851	# i - Inherit permissions
	852	# c:<user_id> - Clone permissions from <user_id>
	853	# C:<permission list> - Set these specific permissions
	854	# first name - defaults to username
	855	# last name - defaults to blank
	856	# phone - defaults to blank (could put other data within column def)
[90]	857	# Returns (OK,<uid>) on success, (FAIL,<message>) on failure
[24]	858	sub addUser {
	859	$errstr = '';
	860	my $dbh = shift;
	861	my $username = shift;
	862	my $group = shift;
	863	my $pass = shift;
	864	my $state = shift;
[25]	865
[90]	866	return ('FAIL', "Missing one or more required entries") if !defined($state);
	867	return ('FAIL', "Username must not be blank") if !$username;
[87]	868
[25]	869	my $type = shift \|\| 'u'; # create limited users by default - fwiw, not sure yet how this will interact with ACLs
	870
[67]	871	my $permstring = shift \|\| 'i'; # default is to inhert permissions from group
	872
[25]	873	my $fname = shift \|\| $username;
[24]	874	my $lname = shift \|\| '';
[25]	875	my $phone = shift \|\| ''; # not going format-check
[24]	876
[38]	877	my $sth = $dbh->prepare("SELECT user_id FROM users WHERE username=?");
[24]	878	my $user_id;
	879
[38]	880	# quick check to start to see if we've already got one
	881	$sth->execute($username);
	882	($user_id) = $sth->fetchrow_array;
	883
	884	return ('FAIL', "User already exists") if $user_id;
	885
[24]	886	# Allow transactions, and raise an exception on errors so we can catch it later.
	887	# Use local to make sure these get "reset" properly on exiting this block
	888	local $dbh->{AutoCommit} = 0;
	889	local $dbh->{RaiseError} = 1;
	890
[94]	891	my $failmsg = '';
	892
[24]	893	# Wrap all the SQL in a transaction
	894	eval {
[87]	895	# insert the user... note we set inherited perms by default since
	896	# it's simple and cleans up some other bits of state
	897	my $sth = $dbh->prepare("INSERT INTO users ".
	898	"(group_id,username,password,firstname,lastname,phone,type,status,permission_id,inherit_perm) ".
	899	"VALUES (?,?,?,?,?,?,?,?,(SELECT permission_id FROM permissions WHERE group_id=?),'t')");
	900	$sth->execute($group,$username,unix_md5_crypt($pass),$fname,$lname,$phone,$type,$state,$group);
[24]	901
	902	# get the ID...
[94]	903	($user_id) = $dbh->selectrow_array("SELECT currval('users_user_id_seq')");
[24]	904
[87]	905	# Permissions! Gotta set'em all!
	906	die "Invalid permission string $permstring"
	907	if $permstring !~ /^(?:
	908	i # inherit
	909	\|c:\d+ # clone
	910	# custom. no, the leading , is not a typo
[111]	911	\|C:(?:,(?:group\|user\|domain\|record\|self)_(?:edit\|create\|delete))*
[87]	912	)$/x;
	913	# bleh. I'd call another function to do my dirty work, but we're in the middle of a transaction already.
	914	if ($permstring ne 'i') {
	915	# for cloned or custom permissions, we have to create a new permissions entry.
	916	my $clonesrc = $group;
	917	if ($permstring =~ /^c:(\d+)/) { $clonesrc = $1; }
	918	$dbh->do("INSERT INTO permissions ($permlist,user_id) ".
	919	"SELECT $permlist,? FROM permissions WHERE permission_id=".
	920	"(SELECT permission_id FROM permissions WHERE ".($permstring =~ /^c:/ ? 'user' : 'group')."_id=?)",
	921	undef, ($user_id,$clonesrc) );
	922	$dbh->do("UPDATE users SET permission_id=".
	923	"(SELECT permission_id FROM permissions WHERE user_id=?) ".
	924	"WHERE user_id=?", undef, ($user_id, $user_id) );
	925	}
	926	if ($permstring =~ /^C:/) {
	927	# finally for custom permissions, we set the passed-in permissions (and unset
	928	# any that might have been brought in by the clone operation above)
	929	my ($permid) = $dbh->selectrow_array("SELECT permission_id FROM permissions WHERE user_id=?",
	930	undef, ($user_id) );
	931	foreach (@permtypes) {
	932	if ($permstring =~ /,$_/) {
	933	$dbh->do("UPDATE permissions SET $_='t' WHERE permission_id=?", undef, ($permid) );
	934	} else {
	935	$dbh->do("UPDATE permissions SET $_='f' WHERE permission_id=?", undef, ($permid) );
	936	}
	937	}
	938	}
	939
	940	$dbh->do("UPDATE users SET inherit_perm='n' WHERE user_id=?", undef, ($user_id) );
	941
[25]	942	##fixme: add another table to hold name/email for log table?
	943
[24]	944	# once we get here, we should have suceeded.
	945	$dbh->commit;
	946	}; # end eval
	947
	948	if ($@) {
	949	my $msg = $@;
	950	eval { $dbh->rollback; };
[87]	951	return ('FAIL',$msg." $failmsg");
[24]	952	} else {
	953	return ('OK',$user_id);
	954	}
	955	} # end addUser
	956
	957
[55]	958	## DNSDB::checkUser()
	959	# Check user/pass combo on login
	960	sub checkUser {
	961	my $dbh = shift;
	962	my $user = shift;
[56]	963	my $inpass = shift;
[55]	964
	965	my $sth = $dbh->prepare("SELECT user_id,group_id,password,firstname,lastname FROM users WHERE username=?");
	966	$sth->execute($user);
	967	my ($uid,$gid,$pass,$fname,$lname) = $sth->fetchrow_array;
	968	my $loginfailed = 1 if !defined($uid);
	969
	970	if ($pass =~ m\|^\$1\$([A-Za-z0-9/.]+)\$\|) {
[56]	971	$loginfailed = 1 if $pass ne unix_md5_crypt($inpass,$1);
[55]	972	} else {
[56]	973	$loginfailed = 1 if $pass ne $inpass;
[55]	974	}
	975
	976	# nnnngggg
	977	return ($uid, $gid);
	978	} # end checkUser
	979
	980
[83]	981	## DNSDB:: updateUser()
[90]	982	# Update general data about user
[83]	983	sub updateUser {
	984	my $dbh = shift;
[118]	985
	986	##fixme: tweak calling convention so that we can update any given bit of data
[83]	987	my $uid = shift;
	988	my $username = shift;
	989	my $group = shift;
	990	my $pass = shift;
	991	my $state = shift;
[87]	992	my $type = shift \|\| 'u';
[83]	993	my $fname = shift \|\| $username;
	994	my $lname = shift \|\| '';
	995	my $phone = shift \|\| ''; # not going format-check
	996
	997	my $failmsg = '';
	998
	999	# Allow transactions, and raise an exception on errors so we can catch it later.
	1000	# Use local to make sure these get "reset" properly on exiting this block
	1001	local $dbh->{AutoCommit} = 0;
	1002	local $dbh->{RaiseError} = 1;
	1003
	1004	my $sth;
	1005
	1006	# Password can be left blank; if so we assume there's one on file.
	1007	# Actual blank passwords are bad, mm'kay?
	1008	if (!$pass) {
	1009	$sth = $dbh->prepare("SELECT password FROM users WHERE user_id=?");
	1010	$sth->execute($uid);
	1011	($pass) = $sth->fetchrow_array;
	1012	} else {
	1013	$pass = unix_md5_crypt($pass);
	1014	}
	1015
	1016	eval {
	1017	my $sth = $dbh->prepare(q(
	1018	UPDATE users
	1019	SET username=?, password=?, firstname=?, lastname=?, phone=?, type=?, status=?
	1020	WHERE user_id=?
	1021	)
	1022	);
	1023	$sth->execute($username, $pass, $fname, $lname, $phone, $type, $state, $uid);
	1024	$dbh->commit;
	1025	};
	1026	if ($@) {
	1027	my $msg = $@;
	1028	eval { $dbh->rollback; };
	1029	return ('FAIL',"$failmsg: $msg");
	1030	} else {
	1031	return ('OK','OK');
	1032	}
	1033	} # end updateUser()
	1034
	1035
[24]	1036	## DNSDB::delUser()
	1037	#
	1038	sub delUser {
[25]	1039	my $dbh = shift;
	1040	return ('FAIL',"Need database handle") if !$dbh;
	1041	my $userid = shift;
	1042	return ('FAIL',"Missing userid") if !defined($userid);
	1043
	1044	my $sth = $dbh->prepare("delete from users where user_id=?");
	1045	$sth->execute($userid);
	1046
	1047	return ('FAIL',"Couldn't remove user: ".$sth->errstr) if $sth->err;
	1048
	1049	return ('OK','OK');
	1050
[24]	1051	} # end delUser
	1052
	1053
[25]	1054	## DNSDB::userFullName()
	1055	# Return a pretty string!
	1056	# Takes a user_id and optional printf-ish string to indicate which pieces where:
	1057	# %u for the username
	1058	# %f for the first name
	1059	# %l for the last name
	1060	# All other text in the passed string will be left as-is.
	1061	##fixme: need a "smart" option too, so that missing/null/blank first/last names don't give funky output
	1062	sub userFullName {
	1063	$errstr = '';
	1064	my $dbh = shift;
	1065	my $userid = shift;
	1066	my $fullformat = shift \|\| '%f %l (%u)';
	1067	my $sth = $dbh->prepare("select username,firstname,lastname from users where user_id=?");
	1068	$sth->execute($userid);
	1069	my ($uname,$fname,$lname) = $sth->fetchrow_array();
	1070	$errstr = $DBI::errstr if !$uname;
	1071
	1072	$fullformat =~ s/\%u/$uname/g;
	1073	$fullformat =~ s/\%f/$fname/g;
	1074	$fullformat =~ s/\%l/$lname/g;
	1075
	1076	return $fullformat;
	1077	} # end userFullName
	1078
	1079
[51]	1080	## DNSDB::userStatus()
	1081	# Sets and/or returns a user's status
	1082	# Takes a database handle, user ID and optionally a status argument
	1083	# Returns undef on errors.
	1084	sub userStatus {
	1085	my $dbh = shift;
	1086	my $id = shift;
	1087	my $newstatus = shift;
	1088
	1089	return undef if $id !~ /^\d+$/;
	1090
	1091	my $sth;
	1092
	1093	# ooo, fun! let's see what we were passed for status
	1094	if ($newstatus) {
	1095	$sth = $dbh->prepare("update users set status=? where user_id=?");
	1096	# ass-u-me caller knows what's going on in full
	1097	if ($newstatus =~ /^[01]$/) { # only two valid for now.
	1098	$sth->execute($newstatus,$id);
	1099	} elsif ($newstatus =~ /^usero(?:n\|ff)$/) {
	1100	$sth->execute(($newstatus eq 'useron' ? 1 : 0),$id);
	1101	}
	1102	}
	1103
	1104	$sth = $dbh->prepare("select status from users where user_id=?");
	1105	$sth->execute($id);
	1106	my ($status) = $sth->fetchrow_array;
	1107	return $status;
	1108	} # end userStatus()
	1109
	1110
[83]	1111	## DNSDB::getUserData()
	1112	# Get misc user data for display
	1113	sub getUserData {
	1114	my $dbh = shift;
	1115	my $uid = shift;
	1116
	1117	my $sth = $dbh->prepare("SELECT group_id,username,firstname,lastname,phone,type,status,inherit_perm ".
	1118	"FROM users WHERE user_id=?");
	1119	$sth->execute($uid);
	1120	return $sth->fetchrow_hashref();
	1121
	1122	} # end getUserData()
	1123
	1124
[2]	1125	## DNSDB::getSOA()
	1126	# Return all suitable fields from an SOA record in separate elements of a hash
	1127	# Takes a database handle, default/live flag, and group (default) or domain (live) ID
	1128	sub getSOA {
	1129	$errstr = '';
	1130	my $dbh = shift;
	1131	my $def = shift;
	1132	my $id = shift;
	1133	my %ret;
	1134
[101]	1135	# (ab)use distance and weight columns to store SOA data
	1136
	1137	my $sql = "SELECT record_id,host,val,ttl,distance from";
[2]	1138	if ($def eq 'def' or $def eq 'y') {
[101]	1139	$sql .= " default_records WHERE group_id=? AND type=$reverse_typemap{SOA}";
[2]	1140	} else {
	1141	# we're editing a live SOA record; find based on domain
[101]	1142	$sql .= " records WHERE domain_id=? AND type=$reverse_typemap{SOA}";
[2]	1143	}
	1144	my $sth = $dbh->prepare($sql);
[101]	1145	$sth->execute($id);
[2]	1146
[121]	1147	my ($recid,$host,$val,$ttl,$serial) = $sth->fetchrow_array() or return;
[2]	1148	my ($prins,$contact) = split /:/, $host;
	1149	my ($refresh,$retry,$expire,$minttl) = split /:/, $val;
	1150
	1151	$ret{recid} = $recid;
	1152	$ret{ttl} = $ttl;
[101]	1153	$ret{serial} = $serial;
[2]	1154	$ret{prins} = $prins;
	1155	$ret{contact} = $contact;
	1156	$ret{refresh} = $refresh;
	1157	$ret{retry} = $retry;
	1158	$ret{expire} = $expire;
	1159	$ret{minttl} = $minttl;
	1160
	1161	return %ret;
	1162	} # end getSOA()
	1163
	1164
	1165	## DNSDB::getRecLine()
	1166	# Return all data fields for a zone record in separate elements of a hash
	1167	# Takes a database handle, default/live flag, and record ID
	1168	sub getRecLine {
	1169	$errstr = '';
	1170	my $dbh = shift;
	1171	my $def = shift;
	1172	my $id = shift;
	1173
[130]	1174	my $sql = "SELECT record_id,host,type,val,distance,weight,port,ttl".
	1175	(($def eq 'def' or $def eq 'y') ? ',group_id FROM default_' : ',domain_id FROM ').
	1176	"records WHERE record_id=?";
[123]	1177	my $ret = $dbh->selectrow_hashref($sql, undef, ($id) );
[2]	1178
[90]	1179	if ($dbh->err) {
[2]	1180	$errstr = $DBI::errstr;
	1181	return undef;
	1182	}
	1183
[123]	1184	if (!$ret) {
	1185	$errstr = "No such record";
	1186	return undef;
	1187	}
	1188
[107]	1189	$ret->{parid} = (($def eq 'def' or $def eq 'y') ? $ret->{group_id} : $ret->{domain_id});
[90]	1190
	1191	return $ret;
[2]	1192	}
	1193
	1194
	1195	##fixme: should use above (getRecLine()) to get lines for below?
	1196	## DNSDB::getDomRecs()
	1197	# Return records for a domain
	1198	# Takes a database handle, default/live flag, group/domain ID, start,
	1199	# number of records, sort field, and sort order
	1200	# Returns a reference to an array of hashes
	1201	sub getDomRecs {
	1202	$errstr = '';
	1203	my $dbh = shift;
	1204	my $type = shift;
	1205	my $id = shift;
[4]	1206	my $nrecs = shift \|\| 'all';
	1207	my $nstart = shift \|\| 0;
[2]	1208
[4]	1209	## for order, need to map input to column names
	1210	my $order = shift \|\| 'host';
[72]	1211	my $direction = shift \|\| 'ASC';
[4]	1212
[135]	1213	my $filter = shift \|\| '';
	1214	# keep the nasties down, since we can't ?-sub this bit. :/
	1215	# note this is chars allowed in DNS hostnames
	1216	$filter =~ s/[^a-zA-Z0-9_.:-]//g;
	1217
[90]	1218	$type = 'y' if $type eq 'def';
	1219
[130]	1220	my $sql = "SELECT r.record_id,r.host,r.type,r.val,r.distance,r.weight,r.port,r.ttl FROM ";
[90]	1221	$sql .= "default_" if $type eq 'y';
	1222	$sql .= "records r ";
[104]	1223	$sql .= "INNER JOIN rectypes t ON r.type=t.val "; # for sorting by type alphabetically
[90]	1224	if ($type eq 'y') {
	1225	$sql .= "WHERE r.group_id=?";
[2]	1226	} else {
[90]	1227	$sql .= "WHERE r.domain_id=?";
[2]	1228	}
[104]	1229	$sql .= " AND NOT r.type=$reverse_typemap{SOA}";
[135]	1230	$sql .= " AND host ILIKE '%$filter%'" if $filter;
[104]	1231	# use alphaorder column for "correct" ordering of sort-by-type instead of DNS RR type number
	1232	$sql .= " ORDER BY ".($order eq 'type' ? 't.alphaorder' : "r.$order")." $direction";
[90]	1233	$sql .= " LIMIT $nrecs OFFSET ".($nstart*$nrecs) if $nstart ne 'all';
[4]	1234
[90]	1235	my $sth = $dbh->prepare($sql) or warn $dbh->errstr;
	1236	$sth->execute($id) or warn "$sql: ".$sth->errstr;
[2]	1237
	1238	my @retbase;
	1239	while (my $ref = $sth->fetchrow_hashref()) {
	1240	push @retbase, $ref;
	1241	}
	1242
	1243	my $ret = \@retbase;
	1244	return $ret;
	1245	} # end getDomRecs()
	1246
	1247
[91]	1248	## DNSDB::getRecCount()
	1249	# Return count of non-SOA records in domain (or default records in a group)
[135]	1250	# Takes a database handle, default/live flag, group/domain ID, and optional filtering modifier
[91]	1251	# Returns the count
	1252	sub getRecCount {
	1253	my $dbh = shift;
	1254	my $defrec = shift;
	1255	my $id = shift;
[135]	1256	my $filter = shift \|\| '';
[91]	1257
[135]	1258	# keep the nasties down, since we can't ?-sub this bit. :/
	1259	# note this is chars allowed in DNS hostnames
	1260	$filter =~ s/[^a-zA-Z0-9_.:-]//g;
	1261
[91]	1262	my ($count) = $dbh->selectrow_array("SELECT count(*) FROM ".
	1263	($defrec eq 'y' ? 'default_' : '')."records ".
	1264	"WHERE ".($defrec eq 'y' ? 'group' : 'domain')."_id=? ".
[135]	1265	"AND NOT type=$reverse_typemap{SOA}".
	1266	($filter ? " AND host ILIKE '%$filter%'" : ''),
	1267	undef, ($id) );
[91]	1268
	1269	return $count;
	1270
	1271	} # end getRecCount()
	1272
	1273
[3]	1274	## DNSDB::addRec()
[2]	1275	# Add a new record to a domain or a group's default records
	1276	# Takes a database handle, default/live flag, group/domain ID,
	1277	# host, type, value, and TTL
	1278	# Some types require additional detail: "distance" for MX and SRV,
	1279	# and weight/port for SRV
	1280	# Returns a status code and detail message in case of error
	1281	sub addRec {
	1282	$errstr = '';
	1283	my $dbh = shift;
	1284	my $defrec = shift;
	1285	my $id = shift;
	1286
	1287	my $host = shift;
	1288	my $rectype = shift;
	1289	my $val = shift;
	1290	my $ttl = shift;
	1291
[129]	1292	# Validation
	1293	if ($rectype == $reverse_typemap{A} or $rectype == $reverse_typemap{AAAA}) {
	1294	my $tmpip = new NetAddr::IP $val or
	1295	return ("FAIL", "Address must be a valid IP address");
	1296	}
	1297
[2]	1298	my $fields = ($defrec eq 'y' ? 'group_id' : 'domain_id').",host,type,val,ttl";
[24]	1299	my $vallen = "?,?,?,?,?";
	1300	my @vallist = ($id,$host,$rectype,$val,$ttl);
[2]	1301
	1302	my $dist;
	1303	if ($rectype == $reverse_typemap{MX} or $rectype == $reverse_typemap{SRV}) {
	1304	$dist = shift;
	1305	return ('FAIL',"Need distance for $typemap{$rectype} record") if !defined($dist);
	1306	$fields .= ",distance";
[24]	1307	$vallen .= ",?";
	1308	push @vallist, $dist;
[2]	1309	}
	1310	my $weight;
	1311	my $port;
	1312	if ($rectype == $reverse_typemap{SRV}) {
[24]	1313	# check for _service._protocol. NB: RFC2782 does not say "MUST"... nor "SHOULD"...
	1314	# it just says (paraphrased) "... is prepended with _ to prevent DNS collisions"
	1315	return ('FAIL',"SRV records must begin with _service._protocol")
	1316	if $host !~ /^_[A-Za-z]+\._[A-Za-z]+\.[a-z0-9-]+/;
[2]	1317	$weight = shift;
	1318	$port = shift;
	1319	return ('FAIL',"Need weight and port for SRV record") if !defined($weight) or !defined($port);
	1320	$fields .= ",weight,port";
[24]	1321	$vallen .= ",?,?";
	1322	push @vallist, ($weight,$port);
[2]	1323	}
	1324
[90]	1325	# Allow transactions, and raise an exception on errors so we can catch it later.
	1326	# Use local to make sure these get "reset" properly on exiting this block
	1327	local $dbh->{AutoCommit} = 0;
	1328	local $dbh->{RaiseError} = 1;
[2]	1329
[90]	1330	eval {
	1331	$dbh->do("INSERT INTO ".($defrec eq 'y' ? 'default_' : '')."records ($fields) VALUES ($vallen)",
	1332	undef, @vallist);
	1333	$dbh->commit;
	1334	};
	1335	if ($@) {
	1336	my $msg = $@;
	1337	eval { $dbh->rollback; };
	1338	return ('FAIL',$msg);
	1339	}
[2]	1340
	1341	return ('OK','OK');
[90]	1342
[2]	1343	} # end addRec()
	1344
	1345
[16]	1346	## DNSDB::updateRec()
	1347	# Update a record
	1348	sub updateRec {
	1349	$errstr = '';
[17]	1350
[16]	1351	my $dbh = shift;
	1352	my $defrec = shift;
	1353	my $id = shift;
	1354
	1355	# all records have these
	1356	my $host = shift;
	1357	my $type = shift;
	1358	my $val = shift;
	1359	my $ttl = shift;
	1360
	1361	return('FAIL',"Missing standard argument(s)") if !defined($ttl);
	1362
	1363	# only MX and SRV will use these
	1364	my $dist = 0;
	1365	my $weight = 0;
	1366	my $port = 0;
	1367
	1368	if ($type == $reverse_typemap{MX} \|\| $type == $reverse_typemap{SRV}) {
[17]	1369	$dist = shift;
	1370	return ('FAIL',"MX or SRV requires distance") if !defined($dist);
[16]	1371	if ($type == $reverse_typemap{SRV}) {
[17]	1372	$weight = shift;
	1373	return ('FAIL',"SRV requires weight") if !defined($weight);
	1374	$port = shift;
	1375	return ('FAIL',"SRV requires port") if !defined($port);
[16]	1376	}
	1377	}
	1378
[90]	1379	local $dbh->{AutoCommit} = 0;
	1380	local $dbh->{RaiseError} = 1;
	1381
	1382	eval {
	1383	$dbh->do("UPDATE ".($defrec eq 'y' ? 'default_' : '')."records ".
[130]	1384	"SET host=?,val=?,type=?,ttl=?,distance=?,weight=?,port=? ".
	1385	"WHERE record_id=?", undef, ($host, $val, $type, $ttl, $dist, $weight, $port, $id) );
	1386	$dbh->commit;
[90]	1387	};
	1388	if ($@) {
	1389	my $msg = $@;
	1390	$dbh->rollback;
	1391	return ('FAIL', $msg);
	1392	}
	1393
[16]	1394	return ('OK','OK');
	1395	} # end updateRec()
	1396
	1397
[3]	1398	## DNSDB::delRec()
	1399	# Delete a record.
	1400	sub delRec {
	1401	$errstr = '';
	1402	my $dbh = shift;
	1403	my $defrec = shift;
	1404	my $id = shift;
	1405
[62]	1406	my $sth = $dbh->prepare("DELETE FROM ".($defrec eq 'y' ? 'default_' : '')."records WHERE record_id=?");
[3]	1407	$sth->execute($id);
	1408
[23]	1409	return ('FAIL',"Couldn't remove record: ".$sth->errstr) if $sth->err;
[3]	1410
	1411	return ('OK','OK');
	1412	} # end delRec()
	1413
	1414
[117]	1415	# Reference hashes.
	1416	my %par_tbl = (
	1417	group => 'groups',
	1418	user => 'users',
	1419	defrec => 'default_records',
	1420	domain => 'domains',
	1421	record => 'records'
	1422	);
	1423	my %id_col = (
	1424	group => 'group_id',
	1425	user => 'user_id',
	1426	defrec => 'record_id',
	1427	domain => 'domain_id',
	1428	record => 'record_id'
	1429	);
	1430	my %par_col = (
	1431	group => 'parent_group_id',
	1432	user => 'group_id',
	1433	defrec => 'group_id',
	1434	domain => 'group_id',
	1435	record => 'domain_id'
	1436	);
	1437	my %par_type = (
	1438	group => 'group',
	1439	user => 'group',
	1440	defrec => 'group',
	1441	domain => 'group',
	1442	record => 'domain'
	1443	);
	1444
[116]	1445	## DNSDB::getParents()
	1446	# Find out which entities are parent to the requested id
	1447	# Returns arrayref containing hash pairs of id/type
	1448	sub getParents {
	1449	my $dbh = shift;
	1450	my $id = shift;
	1451	my $type = shift;
[117]	1452	my $depth = shift \|\| 'all'; # valid values: 'all', 'immed', <int> (stop at this group ID)
[116]	1453
[117]	1454	my @parlist;
[116]	1455
[117]	1456	while (1) {
	1457	my $result = $dbh->selectrow_hashref("SELECT $par_col{$type} FROM $par_tbl{$type} WHERE $id_col{$type} = ?",
	1458	undef, ($id) );
[152]	1459	my %tmp = ($result->{$par_col{$type}} => $par_type{$type});
	1460	unshift @parlist, \%tmp;
[117]	1461	last if $result->{$par_col{$type}} == 1; # group 1 is its own parent
[152]	1462	$id = $result->{$par_col{$type}};
[117]	1463	$type = $par_type{$type};
[116]	1464	}
	1465
[117]	1466	return \@parlist;
[116]	1467
	1468	} # end getParents()
	1469
	1470
[117]	1471	## DNSDB::isParent()
	1472	# Returns true if $id1 is a parent of $id2, false otherwise
	1473	sub isParent {
	1474	my $dbh = shift;
	1475	my $id1 = shift;
	1476	my $type1 = shift;
	1477	my $id2 = shift;
	1478	my $type2 = shift;
	1479	##todo: immediate, secondary, full (default)
	1480
[157]	1481	# Return false on invalid types
	1482	return 0 if !grep /^$type1$/, ('record','defrec','user','domain','group');
	1483	return 0 if !grep /^$type2$/, ('record','defrec','user','domain','group');
	1484
[117]	1485	# Return false on impossible relations
	1486	return 0 if $type1 eq 'record'; # nothing may be a child of a record
	1487	return 0 if $type1 eq 'defrec'; # nothing may be a child of a record
	1488	return 0 if $type1 eq 'user'; # nothing may be child of a user
	1489	return 0 if $type1 eq 'domain' && $type2 ne 'record'; # domain may not be a parent of anything other than a record
	1490
	1491	# group 1 is the ultimate root parent
	1492	return 1 if $type1 eq 'group' && $id1 == 1;
	1493
[155]	1494	# groups are always (a) parent of themselves
	1495	return 1 if $type1 eq 'group' && $type2 eq 'group' && $id1 == $id2;
	1496
[117]	1497	# almost the same loop as getParents() above
	1498	my $id = $id2;
	1499	my $type = $type2;
	1500	my $foundparent = 0;
[155]	1501
[117]	1502	while (1) {
[155]	1503	my $sql = "SELECT $par_col{$type} FROM $par_tbl{$type} WHERE $id_col{$type} = ?";
[117]	1504	my $result = $dbh->selectrow_hashref($sql,
[157]	1505	undef, ($id) );
	1506	if ($result && $result->{$par_col{$type}} == $id1) {
[117]	1507	$foundparent = 1;
	1508	last;
[157]	1509	} else {
	1510	##fixme: do we care about trying to return a "no such record/domain/user/group" error?
	1511	warn $dbh->errstr." $sql, $id" if $dbh->errstr;
	1512	last;
[117]	1513	}
	1514	# group 1 is its own parent. need this here more to break strange loops than for detecting a parent
	1515	last if $result->{$par_col{$type}} == 1;
[152]	1516	$id = $result->{$par_col{$type}};
[117]	1517	$type = $par_type{$type};
	1518	}
	1519
	1520	return $foundparent;
	1521	} # end isParent()
	1522
	1523
[3]	1524	## DNSDB::domStatus()
	1525	# Sets and/or returns a domain's status
	1526	# Takes a database handle, domain ID and optionally a status argument
	1527	# Returns undef on errors.
	1528	sub domStatus {
	1529	my $dbh = shift;
	1530	my $id = shift;
	1531	my $newstatus = shift;
	1532
	1533	return undef if $id !~ /^\d+$/;
	1534
	1535	my $sth;
	1536
	1537	# ooo, fun! let's see what we were passed for status
	1538	if ($newstatus) {
	1539	$sth = $dbh->prepare("update domains set status=? where domain_id=?");
	1540	# ass-u-me caller knows what's going on in full
	1541	if ($newstatus =~ /^[01]$/) { # only two valid for now.
	1542	$sth->execute($newstatus,$id);
	1543	} elsif ($newstatus =~ /^domo(?:n\|ff)$/) {
	1544	$sth->execute(($newstatus eq 'domon' ? 1 : 0),$id);
	1545	}
	1546	}
	1547
	1548	$sth = $dbh->prepare("select status from domains where domain_id=?");
	1549	$sth->execute($id);
	1550	my ($status) = $sth->fetchrow_array;
	1551	return $status;
	1552	} # end domStatus()
	1553
	1554
[33]	1555	## DNSDB::importAXFR
	1556	# Import a domain via AXFR
[37]	1557	# Takes AXFR host, domain to transfer, group to put the domain in,
	1558	# and optionally:
	1559	# - active/inactive state flag (defaults to active)
	1560	# - overwrite-SOA flag (defaults to off)
	1561	# - overwrite-NS flag (defaults to off, doesn't affect subdomain NS records)
	1562	# Returns a status code (OK, WARN, or FAIL) and message - message should be blank
	1563	# if status is OK, but WARN includes conditions that are not fatal but should
	1564	# really be reported.
[33]	1565	sub importAXFR {
	1566	my $dbh = shift;
[35]	1567	my $ifrom_in = shift;
[33]	1568	my $domain = shift;
	1569	my $group = shift;
	1570	my $status = shift \|\| 1;
	1571	my $rwsoa = shift \|\| 0;
	1572	my $rwns = shift \|\| 0;
[37]	1573
[33]	1574	##fixme: add mode to delete&replace, merge+overwrite, merge new?
	1575
[37]	1576	my $nrecs = 0;
	1577	my $soaflag = 0;
	1578	my $nsflag = 0;
	1579	my $warnmsg = '';
	1580	my $ifrom;
[33]	1581
[35]	1582	# choke on possible bad setting in ifrom
[37]	1583	# IPv4 and v6, and valid hostnames!
[35]	1584	($ifrom) = ($ifrom_in =~ /^([0-9a-f\:.]+\|[0-9a-z_.-]+)$/i);
	1585	return ('FAIL', "Bad AXFR source host $ifrom")
	1586	unless ($ifrom) = ($ifrom_in =~ /^([0-9a-f\:.]+\|[0-9a-z_.-]+)$/i);
	1587
[33]	1588	# Allow transactions, and raise an exception on errors so we can catch it later.
	1589	# Use local to make sure these get "reset" properly on exiting this block
	1590	local $dbh->{AutoCommit} = 0;
	1591	local $dbh->{RaiseError} = 1;
	1592
[37]	1593	my $sth = $dbh->prepare("SELECT domain_id FROM domains WHERE domain=?");
[34]	1594	my $dom_id;
	1595
[35]	1596	# quick check to start to see if we've already got one
[37]	1597	$sth->execute($domain);
	1598	($dom_id) = $sth->fetchrow_array;
[35]	1599
	1600	return ('FAIL', "Domain already exists") if $dom_id;
	1601
[33]	1602	eval {
	1603	# can't do this, can't nest transactions. sigh.
[35]	1604	#my ($dcode, $dmsg) = addDomain(dbh, domain, group, status);
[33]	1605
	1606	##fixme: serial
[37]	1607	my $sth = $dbh->prepare("INSERT INTO domains (domain,group_id,status) VALUES (?,?,?)");
	1608	$sth->execute($domain,$group,$status);
[33]	1609
[35]	1610	## bizarre DBI<->Net::DNS interaction bug:
	1611	## sometimes a zone will cause an immediate commit-and-exit (sort of) of the while()
[37]	1612	## fixed, apparently I was doing something odd, but not certain what it was that
	1613	## caused a commit instead of barfing
[35]	1614
[33]	1615	# get domain id so we can do the records
[37]	1616	$sth = $dbh->prepare("SELECT domain_id FROM domains WHERE domain=?");
	1617	$sth->execute($domain);
	1618	($dom_id) = $sth->fetchrow_array();
[33]	1619
[34]	1620	my $res = Net::DNS::Resolver->new;
[35]	1621	$res->nameservers($ifrom);
	1622	$res->axfr_start($domain)
	1623	or die "Couldn't begin AXFR\n";
[34]	1624
[35]	1625	while (my $rr = $res->axfr_next()) {
[33]	1626	my $type = $rr->type;
[35]	1627
[34]	1628	my $sql = "INSERT INTO records (domain_id,host,type,ttl,val";
[33]	1629	my $vallen = "?,?,?,?,?";
	1630
[37]	1631	$soaflag = 1 if $type eq 'SOA';
	1632	$nsflag = 1 if $type eq 'NS';
[35]	1633
	1634	my @vallist = ($dom_id, $rr->name, $reverse_typemap{$type}, $rr->ttl);
[34]	1635
	1636	# "Primary" types:
	1637	# A, NS, CNAME, SOA, PTR(warn in forward), MX, TXT, AAAA, SRV, A6(ob), SPF
	1638	# maybe KEY
	1639
[35]	1640	# nasty big ugly case-like thing here, since we have to do some different
	1641	# processing depending on the record. le sigh.
	1642
[105]	1643	##fixme: what record types other than TXT can/will have >255-byte payloads?
	1644
[34]	1645	if ($type eq 'A') {
	1646	push @vallist, $rr->address;
	1647	} elsif ($type eq 'NS') {
[37]	1648	# hmm. should we warn here if subdomain NS'es are left alone?
	1649	next if ($rwns && ($rr->name eq $domain));
[34]	1650	push @vallist, $rr->nsdname;
[35]	1651	$nsflag = 1;
[34]	1652	} elsif ($type eq 'CNAME') {
	1653	push @vallist, $rr->cname;
	1654	} elsif ($type eq 'SOA') {
[37]	1655	next if $rwsoa;
[34]	1656	$vallist[1] = $rr->mname.":".$rr->rname;
	1657	push @vallist, ($rr->refresh.":".$rr->retry.":".$rr->expire.":".$rr->minimum);
[35]	1658	$soaflag = 1;
[34]	1659	} elsif ($type eq 'PTR') {
[105]	1660	push @vallist, $rr->ptrdname;
[34]	1661	# hmm. PTR records should not be in forward zones.
	1662	} elsif ($type eq 'MX') {
[33]	1663	$sql .= ",distance";
	1664	$vallen .= ",?";
[34]	1665	push @vallist, $rr->exchange;
	1666	push @vallist, $rr->preference;
	1667	} elsif ($type eq 'TXT') {
	1668	##fixme: Net::DNS docs say this should be deprecated for rdatastr() or char_str_list(),
	1669	## but don't really seem enthusiastic about it.
[105]	1670	my $rrdata = $rr->txtdata;
[130]	1671	push @vallist, $rrdata;
[34]	1672	} elsif ($type eq 'SPF') {
	1673	##fixme: and the same caveat here, since it is apparently a clone of ::TXT
[105]	1674	my $rrdata = $rr->txtdata;
[130]	1675	push @vallist, $rrdata;
[34]	1676	} elsif ($type eq 'AAAA') {
	1677	push @vallist, $rr->address;
	1678	} elsif ($type eq 'SRV') {
	1679	$sql .= ",distance,weight,port" if $type eq 'SRV';
	1680	$vallen .= ",?,?,?" if $type eq 'SRV';
[37]	1681	push @vallist, $rr->target;
[34]	1682	push @vallist, $rr->priority;
	1683	push @vallist, $rr->weight;
	1684	push @vallist, $rr->port;
	1685	} elsif ($type eq 'KEY') {
[35]	1686	# we don't actually know what to do with these...
[34]	1687	push @vallist, ($rr->flags.":".$rr->protocol.":".$rr->algorithm.":".$rr->key.":".$rr->keytag.":".$rr->privatekeyname);
[35]	1688	} else {
[105]	1689	my $rrdata = $rr->rdatastr;
[130]	1690	push @vallist, $rrdata;
[35]	1691	# Finding a different record type is not fatal.... just problematic.
[37]	1692	# We may not be able to export it correctly.
[35]	1693	$warnmsg .= "Unusual record ".$rr->name." ($type) found\n";
[33]	1694	}
	1695
[34]	1696	# BIND supports:
	1697	# A CNAME HINFO MB(ex) MD(ob) MF(ob) MG(ex) MINFO(ex) MR(ex) MX NS NULL
	1698	# PTR SOA TXT WKS AFSDB(ex) ISDN(ex) RP(ex) RT(ex) X25(ex) PX
	1699	# ... if one can ever find the right magic to format them correctly
	1700
	1701	# Net::DNS supports:
	1702	# RRSIG SIG NSAP NS NIMLOC NAPTR MX MR MINFO MG MB LOC ISDN IPSECKEY HINFO
	1703	# EID DNAME CNAME CERT APL AFSDB AAAA A DS NXT NSEC3PARAM NSEC3 NSEC KEY
	1704	# DNSKEY DLV X25 TXT TSIG TKEY SSHFP SRV SPF SOA RT RP PX PTR NULL APL::AplItem
	1705
[37]	1706	$sth = $dbh->prepare($sql.") VALUES (".$vallen.")") or die "problem preparing record insert SQL\n";
	1707	$sth->execute(@vallist) or die "failed to insert ".$rr->string.": ".$sth->errstr."\n";
[34]	1708
[37]	1709	$nrecs++;
[34]	1710
[37]	1711	} # while axfr_next
	1712
	1713	# Overwrite SOA record
	1714	if ($rwsoa) {
	1715	$soaflag = 1;
	1716	my $sthgetsoa = $dbh->prepare("SELECT host,val,ttl FROM default_records WHERE group_id=? AND type=?");
	1717	my $sthputsoa = $dbh->prepare("INSERT INTO records (domain_id,host,type,val,ttl) VALUES (?,?,?,?,?)");
	1718	$sthgetsoa->execute($group,$reverse_typemap{SOA});
	1719	while (my ($host,$val,$ttl) = $sthgetsoa->fetchrow_array()) {
	1720	$host =~ s/DOMAIN/$domain/g;
	1721	$val =~ s/DOMAIN/$domain/g;
	1722	$sthputsoa->execute($dom_id,$host,$reverse_typemap{SOA},$val,$ttl);
[34]	1723	}
[37]	1724	}
[34]	1725
[37]	1726	# Overwrite NS records
	1727	if ($rwns) {
	1728	$nsflag = 1;
	1729	my $sthgetns = $dbh->prepare("SELECT host,val,ttl FROM default_records WHERE group_id=? AND type=?");
	1730	my $sthputns = $dbh->prepare("INSERT INTO records (domain_id,host,type,val,ttl) VALUES (?,?,?,?,?)");
	1731	$sthgetns->execute($group,$reverse_typemap{NS});
	1732	while (my ($host,$val,$ttl) = $sthgetns->fetchrow_array()) {
	1733	$host =~ s/DOMAIN/$domain/g;
	1734	$val =~ s/DOMAIN/$domain/g;
	1735	$sthputns->execute($dom_id,$host,$reverse_typemap{NS},$val,$ttl);
	1736	}
	1737	}
[34]	1738
[35]	1739	die "No records found; either $ifrom is not authoritative or doesn't allow transfers\n" if !$nrecs;
	1740	die "Bad zone: No SOA record!\n" if !$soaflag;
	1741	die "Bad zone: No NS records!\n" if !$nsflag;
	1742
[37]	1743	$dbh->commit;
[35]	1744
[33]	1745	};
	1746
	1747	if ($@) {
	1748	my $msg = $@;
	1749	eval { $dbh->rollback; };
[34]	1750	return ('FAIL',$msg." $warnmsg");
[33]	1751	} else {
[35]	1752	return ('WARN', $warnmsg) if $warnmsg;
[91]	1753	return ('OK',"Imported OK");
[33]	1754	}
	1755
[37]	1756	# it should be impossible to get here.
[34]	1757	return ('WARN',"OOOK!");
[33]	1758	} # end importAXFR()
	1759
	1760
[103]	1761	## DNSDB::export()
	1762	# Export the DNS database, or a part of it
	1763	# Takes database handle, export type, optional arguments depending on type
	1764	# Writes zone data to targets as appropriate for type
	1765	sub export {
	1766	my $dbh = shift;
	1767	my $target = shift;
	1768
	1769	if ($target eq 'tiny') {
	1770	__export_tiny($dbh,@_);
	1771	}
	1772	# elsif ($target eq 'foo') {
	1773	# __export_foo($dbh,@_);
	1774	#}
	1775	# etc
	1776
	1777	} # end export()
	1778
	1779
	1780	## DNSDB::__export_tiny
	1781	# Internal sub to implement tinyDNS (compatible) export
	1782	# Takes database handle, filehandle to write export to, optional argument(s)
	1783	# to determine which data gets exported
	1784	sub __export_tiny {
	1785	my $dbh = shift;
	1786	my $datafile = shift;
	1787
	1788	##fixme: slurp up further options to specify particular zone(s) to export
	1789
	1790	## Convert a bare number into an octal-coded pair of octets.
	1791	# Take optional arg to indicate a decimal or hex input. Defaults to hex.
	1792	sub octalize {
	1793	my $tmp = shift;
	1794	my $srctype = shift \|\| 'h'; # default assumes hex string
	1795	$tmp = sprintf "%0.4x", hex($tmp) if $srctype eq 'h'; # 0-pad hex to 4 digits
	1796	$tmp = sprintf "%0.4x", $tmp if $srctype eq 'd'; # 0-pad decimal to 4 hex digits
	1797	my @o = ($tmp =~ /^(..)(..)$/); # split into octets
	1798	return sprintf "\\%0.3o\\%0.3o", hex($o[0]), hex($o[1]);;
	1799	}
	1800
	1801	##fixme: fail if $datafile isn't an open, writable file
	1802
	1803	# easy case - export all evarything
	1804	# not-so-easy case - export item(s) specified
	1805	# todo: figure out what kind of list we use to export items
	1806
	1807	my $domsth = $dbh->prepare("SELECT domain_id,domain,status FROM domains WHERE status=1");
[130]	1808	my $recsth = $dbh->prepare("SELECT host,type,val,distance,weight,port,ttl ".
	1809	"FROM records WHERE domain_id=?");
[103]	1810	$domsth->execute();
	1811	while (my ($domid,$dom,$domstat) = $domsth->fetchrow_array) {
	1812	$recsth->execute($domid);
[130]	1813	while (my ($host,$type,$val,$dist,$weight,$port,$ttl) = $recsth->fetchrow_array) {
[108]	1814	##fixme: need to store location in the db, and retrieve it here.
	1815	# temporarily hardcoded to empty so we can include it further down.
	1816	my $loc = '';
	1817
	1818	##fixme: record validity timestamp. tinydns supports fiddling with timestamps.
	1819	# note $ttl must be set to 0 if we want to use tinydns's auto-expiring timestamps.
	1820	# timestamps are TAI64
	1821	# ~~ 2^62 + time()
	1822	my $stamp = '';
	1823
[103]	1824	# raw packet in unknown format: first byte indicates length
	1825	# of remaining data, allows up to 255 raw bytes
	1826
	1827	##fixme? append . to all host/val hostnames
	1828	if ($typemap{$type} eq 'SOA') {
	1829
	1830	# host contains pri-ns:responsible
	1831	# val is abused to contain refresh:retry:expire:minttl
	1832	##fixme: "manual" serial vs tinydns-autoserial
[108]	1833	print $datafile "Z$host"."::$val:$ttl:$stamp:$loc\n";
[103]	1834
	1835	} elsif ($typemap{$type} eq 'A') {
	1836
[108]	1837	print $datafile "+$host:$val:$ttl:$stamp:$loc\n";
[103]	1838
	1839	} elsif ($typemap{$type} eq 'NS') {
	1840
[108]	1841	print $datafile "\&$host"."::$val:$ttl:$stamp:$loc\n";
[103]	1842
	1843	} elsif ($typemap{$type} eq 'AAAA') {
	1844
	1845	print $datafile ":$host:28:";
	1846	my $altgrp = 0;
	1847	my @altconv;
[108]	1848	# Split in to up to 8 groups of hex digits (allows for IPv6 :: 0-collapsing)
[103]	1849	foreach (split /:/, $val) {
	1850	if (/^$/) {
	1851	# flag blank entry; this is a series of 0's of (currently) unknown length
	1852	$altconv[$altgrp++] = 's';
	1853	} else {
	1854	# call sub to convert 1-4 hex digits to 2 string-rep octal bytes
	1855	$altconv[$altgrp++] = octalize($_)
	1856	}
	1857	}
	1858	foreach my $octet (@altconv) {
	1859	# if not 's', output
	1860	print $datafile $octet unless $octet =~ /^s$/;
	1861	# if 's', output (9-array length)x literal '\000\000'
	1862	print $datafile '\000\000'x(9-$altgrp) if $octet =~ /^s$/;
	1863	}
[108]	1864	print $datafile ":$ttl:$stamp:$loc\n";
[103]	1865
	1866	} elsif ($typemap{$type} eq 'MX') {
	1867
[108]	1868	print $datafile "\@$host"."::$val:$dist:$ttl:$stamp:$loc\n";
[103]	1869
	1870	} elsif ($typemap{$type} eq 'TXT') {
	1871
	1872	##fixme: split v-e-r-y long TXT strings? will need to do so for BIND export, at least
	1873	$val =~ s/:/\\072/g; # may need to replace other symbols
[108]	1874	print $datafile "'$host:$val:$ttl:$stamp:$loc\n";
[103]	1875
	1876	# by-hand TXT
	1877	#:deepnet.cx:16:2v\075spf1\040a\040a\072bacon.deepnet.cx\040a\072home.deepnet.cx\040-all:3600
	1878	#@ IN TXT "v=spf1 a a:bacon.deepnet.cx a:home.deepnet.cx -all"
	1879	#'deepnet.cx:v=spf1 a a\072bacon.deepnet.cx a\072home.deepnet.cx -all:3600
	1880
	1881	#txttest IN TXT "v=foo bar:bob kn;ob' \" !@#$%^&*()-=_+[]{}<>?"
	1882	#:txttest.deepnet.cx:16:\054v\075foo\040bar\072bob\040kn\073ob\047\040\042\040\041\100\043\044\045\136\046\052\050\051-\075\137\053\133\135\173\175\074\076\077:3600
	1883
	1884	# very long TXT record as brought in by axfr-get
	1885	# note tinydns does not support >512-byte RR data, need axfr-dns (for TCP support) for that
	1886	# also note, tinydns does not seem to support <512, >256-byte RRdata from axfr-get either. :/
	1887	#:longtxt.deepnet.cx:16:
	1888	#\170this is a very long txt record. it is really long. long. very long. really very long. this is a very long txt record.
	1889	#\263 it is really long. long. very long. really very long. this is a very long txt record. it is really long. long. very long. really very long. this is a very long txt record.
	1890	#\351 it is really long. long. very long. really very long.this is a very long txt record. it is really long. long. very long. really very long. this is a very long txt record. it is really long. long. very long. really very long.
	1891	#:3600
	1892
	1893	} elsif ($typemap{$type} eq 'CNAME') {
	1894
[108]	1895	print $datafile "C$host:$val:$ttl:$stamp:$loc\n";
[103]	1896
	1897	} elsif ($typemap{$type} eq 'SRV') {
	1898
	1899	# data is two-byte values for priority, weight, port, in that order,
	1900	# followed by length/string data
	1901
	1902	print $datafile ":$host:33:".octalize($dist,'d').octalize($weight,'d').octalize($port,'d');
	1903
	1904	$val .= '.' if $val !~ /\.$/;
	1905	foreach (split /\./, $val) {
	1906	printf $datafile "\\%0.3o%s", length($_), $_;
	1907	}
[108]	1908	print $datafile "\\000:$ttl:$stamp:$loc\n";
[103]	1909
	1910	} elsif ($typemap{$type} eq 'RP') {
	1911
	1912	# RP consists of two mostly free-form strings.
	1913	# The first is supposed to be an email address with @ replaced by . (as with the SOA contact)
	1914	# The second is the "hostname" of a TXT record with more info.
	1915	print $datafile ":$host:17:";
	1916	my ($who,$what) = split /\s/, $val;
	1917	foreach (split /\./, $who) {
	1918	printf $datafile "\\%0.3o%s", length($_), $_;
	1919	}
	1920	print $datafile '\000';
	1921	foreach (split /\./, $what) {
	1922	printf $datafile "\\%0.3o%s", length($_), $_;
	1923	}
[108]	1924	print $datafile "\\000:$ttl:$stamp:$loc\n";
[103]	1925
	1926	} elsif ($typemap{$type} eq 'PTR') {
	1927
	1928	# must handle both IPv4 and IPv6
	1929	##work
[108]	1930	# data should already be in suitable reverse order.
	1931	print $datafile "^$host:$val:$ttl:$stamp:$loc\n";
[103]	1932
[108]	1933	} else {
	1934	# raw record. we don't know what's in here, so we ASS-U-ME the user has
	1935	# put it in correctly, since either the user is messing directly with the
	1936	# database, or the record was imported via AXFR
	1937	# <split by char>
	1938	# convert anything not a-zA-Z0-9.- to octal coding
	1939
	1940	##fixme: add flag to export "unknown" record types - note we'll probably end up
	1941	# mangling them since they were written to the DB from Net::DNS::RR::<type>->rdatastr.
	1942	#print $datafile ":$host:$type:$val:$ttl:$stamp:$loc\n";
	1943
[103]	1944	} # record type if-else
	1945
	1946	} # while ($recsth)
	1947	} # while ($domsth)
	1948	} # end __export_tiny()
	1949
	1950
[2]	1951	# shut Perl up
	1952	1;

Note: See TracBrowser for help on using the repository browser.

Download in other formats: