source: trunk/DNSDB.pm@ 625

Last change on this file since 625 was 625, checked in by Kris Deugau, 10 years ago

/trunk

Fine-tuning in _check_hostname_form()
  • Property svn:keywords set to Date Rev Author Id
File size: 222.2 KB
Line 
1# dns/trunk/DNSDB.pm
2# Abstraction functions for DNS administration
3##
4# $Id: DNSDB.pm 625 2014-04-29 20:56:52Z kdeugau $
5# Copyright 2008-2013 Kris Deugau <kdeugau@deepnet.cx>
6#
7# This program is free software: you can redistribute it and/or modify
8# it under the terms of the GNU General Public License as published by
9# the Free Software Foundation, either version 3 of the License, or
10# (at your option) any later version.
11#
12# This program is distributed in the hope that it will be useful,
13# but WITHOUT ANY WARRANTY; without even the implied warranty of
14# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15# GNU General Public License for more details.
16#
17# You should have received a copy of the GNU General Public License
18# along with this program. If not, see <http://www.gnu.org/licenses/>.
19##
20
21package DNSDB;
22
23use strict;
24use warnings;
25use Exporter;
26use DBI;
27use Net::DNS;
28use Crypt::PasswdMD5;
29use Digest::MD5 qw(md5_hex);
30use Net::SMTP;
31use NetAddr::IP 4.027 qw(:lower);
32use POSIX;
33use Fcntl qw(:flock);
34use Time::TAI64 qw(:tai64);
35
36use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
37
38$VERSION = 1.3; ##VERSION##
39@ISA = qw(Exporter);
40@EXPORT_OK = qw(
41 &initGlobals &login &initActionLog
42 &getPermissions &changePermissions &comparePermissions
43 &changeGroup
44 &connectDB &finish
45 &addDomain &delZone &domainName &revName &domainID &revID &addRDNS
46 &getZoneCount &getZoneList &getZoneLocation
47 &addGroup &delGroup &getChildren &groupName
48 &getGroupCount &getGroupList
49 &addUser &updateUser &delUser &userFullName &userStatus &getUserData
50 &getUserCount &getUserList &getUserDropdown
51 &addLoc &updateLoc &delLoc &getLoc
52 &getLocCount &getLocList &getLocDropdown
53 &getSOA &updateSOA &getRecLine &getRecList &getRecCount
54 &addRec &updateRec &delRec
55 &getLogCount &getLogEntries
56 &getRevPattern
57 &getTypelist
58 &parentID
59 &isParent
60 &zoneStatus &getZonesByCIDR &importAXFR
61 &export
62 &mailNotify
63 %typemap %reverse_typemap
64 @permtypes $permlist %permchains
65 );
66
67@EXPORT = qw(%typemap %reverse_typemap @permtypes $permlist %permchains);
68%EXPORT_TAGS = ( ALL => [qw(
69 &initGlobals &login &initActionLog
70 &getPermissions &changePermissions &comparePermissions
71 &changeGroup
72 &connectDB &finish
73 &addDomain &delZone &domainName &revName &domainID &revID &addRDNS
74 &getZoneCount &getZoneList &getZoneLocation
75 &addGroup &delGroup &getChildren &groupName
76 &getGroupCount &getGroupList
77 &addUser &updateUser &delUser &userFullName &userStatus &getUserData
78 &getUserCount &getUserList &getUserDropdown
79 &addLoc &updateLoc &delLoc &getLoc
80 &getLocCount &getLocList &getLocDropdown
81 &getSOA &updateSOA &getRecLine &getRecList &getRecCount
82 &addRec &updateRec &delRec
83 &getLogCount &getLogEntries
84 &getRevPattern
85 &getTypelist
86 &parentID
87 &isParent
88 &zoneStatus &getZonesByCIDR &importAXFR
89 &export
90 &mailNotify
91 %typemap %reverse_typemap
92 @permtypes $permlist %permchains
93 )]
94 );
95
96our $errstr = '';
97our $resultstr = '';
98
99# Arguably defined wholly in the db, but little reason to change without supporting code changes
100# group_view, user_view permissions? separate rDNS permission(s)?
101our @permtypes = qw (
102 group_edit group_create group_delete
103 user_edit user_create user_delete
104 domain_edit domain_create domain_delete
105 record_edit record_create record_delete record_locchg
106 location_edit location_create location_delete location_view
107 self_edit admin
108);
109our $permlist = join(',',@permtypes);
110
111# Some permissions more or less require certain others.
112our %permchains = (
113 user_edit => 'self_edit',
114 location_edit => 'location_view',
115 location_create => 'location_view',
116 location_delete => 'location_view',
117 record_locchg => 'location_view',
118);
119
120# DNS record type map and reverse map.
121# loaded from the database, from http://www.iana.org/assignments/dns-parameters
122our %typemap;
123our %reverse_typemap;
124
125## (Semi)private variables
126
127# Hash of functions for validating record types. Filled in initGlobals() since
128# it relies on visibility flags from the rectypes table in the DB
129my %validators;
130
131# Entity-relationship reference hashes.
132my %par_tbl = (
133 group => 'groups',
134 user => 'users',
135 defrec => 'default_records',
136 defrevrec => 'default_rev_records',
137 domain => 'domains',
138 revzone => 'revzones',
139 record => 'records'
140 );
141my %id_col = (
142 group => 'group_id',
143 user => 'user_id',
144 defrec => 'record_id',
145 defrevrec => 'record_id',
146 domain => 'domain_id',
147 revzone => 'rdns_id',
148 record => 'record_id'
149 );
150my %par_col = (
151 group => 'parent_group_id',
152 user => 'group_id',
153 defrec => 'group_id',
154 defrevrec => 'group_id',
155 domain => 'group_id',
156 revzone => 'group_id',
157 record => 'domain_id'
158 );
159my %par_type = (
160 group => 'group',
161 user => 'group',
162 defrec => 'group',
163 defrevrec => 'group',
164 domain => 'group',
165 revzone => 'group',
166 record => 'domain'
167 );
168
169##
170## Constructor and destructor
171##
172
173sub new {
174 my $this = shift;
175 my $class = ref($this) || $this;
176 my %args = @_;
177
178 # Prepopulate a basic config. Note some of these *will* cause errors if left unset.
179 # note: add appropriate stanzas in __cfgload() to parse these
180 my %defconfig = (
181 # The only configuration options not loadable from a config file.
182 configfile => "/etc/dnsdb/dnsdb.conf", ##CFG_LEAF##
183
184 # Database connection info
185 dbname => 'dnsdb',
186 dbuser => 'dnsdb',
187 dbpass => 'secret',
188 dbhost => '',
189
190 # Email notice settings
191 mailhost => 'smtp.example.com',
192 mailnotify => 'dnsdb@example.com', # to
193 mailsender => 'dnsdb@example.com', # from
194 mailname => 'DNS Administration',
195 orgname => 'Example Corp',
196 domain => 'example.com',
197
198 # Template directory
199 templatedir => 'templates/',
200# fmeh. this is a real web path, not a logical internal one. hm..
201# cssdir => 'templates/',
202 sessiondir => 'session/',
203 exportcache => 'cache/',
204 usecache => 1, # do we bother using the cache above?
205
206 # Session params
207 timeout => '1h', # passed as-is to CGI::Session
208
209 # Other miscellanea
210 log_failures => 1, # log all evarthing by default
211 perpage => 15,
212 maxfcgi => 10, # reasonable default?
213 force_refresh => 1,
214 lowercase => 0, # mangle as little as possible by default
215 # show IPs and CIDR blocks as-is for reverse zones. valid values are
216 # 'none' (default, show natural IP or CIDR)
217 # 'zone' (zone name, wherever used)
218 # 'record' (IP or CIDR values in reverse record lists)
219 # 'all' (all IP values in any reverse zone view)
220 showrev_arpa => 'none',
221 );
222
223 # Config file parse calls.
224 # If we are passed a blank argument for $args{configfile},
225 # we should NOT parse the default config file - we will
226 # rely on hardcoded defaults OR caller-specified values.
227 # If we are passed a non-blank argument, parse that file.
228 # If no config file is specified, parse the default one.
229 my %siteconfig;
230 if (defined($args{configfile})) {
231 if ($args{configfile}) {
232 return if !__cfgload($args{configfile}, \%siteconfig);
233 }
234 } else {
235 return if !__cfgload($defconfig{configfile}, \%siteconfig);
236 }
237
238 # Assemble the object. Apply configuration hashes in order of precedence.
239 my $self = {
240 # Hardcoded defaults
241 %defconfig,
242 # Default config file OR caller-specified one, loaded above
243 %siteconfig,
244 # Caller-specified arguments
245 %args
246 };
247 bless $self, $class;
248
249 # Several settings are booleans. Handle multiple possible ways of setting them.
250 for my $boolopt ('log_failures', 'force_refresh', 'lowercase', 'usecache') {
251 if ($self->{$boolopt} ne '1' && $self->{$boolopt} ne '0') {
252 # true/false, on/off, yes/no all valid.
253 if ($self->{$boolopt} =~ /^(?:true|false|t|f|on|off|yes|no)$/) {
254 if ($self->{$boolopt} =~ /(?:true|t|on|yes)/) {
255 $self->{$boolopt} = 1;
256 } else {
257 $self->{$boolopt} = 0;
258 }
259 } else {
260 warn "Bad $boolopt setting $self->{$boolopt}, using default\n";
261 $self->{$boolopt} = $defconfig{$boolopt};
262 }
263 }
264 }
265
266 # Enum-ish option(s)
267 if (!grep /$self->{showrev_arpa}/, ('none','zone','record','all')) {
268 warn "Bad showrev_arpa setting $self->{showrev_arpa}, using default\n";
269 $self->{showrev_arpa} = 'none';
270 }
271
272 # Try to connect to the DB, and initialize a number of handy globals.
273 $self->{dbh} = connectDB($self->{dbname}, $self->{dbuser}, $self->{dbpass}, $self->{dbhost}) or return;
274 $self->initGlobals();
275
276 return $self;
277}
278
279sub DESTROY {
280 my $self = shift;
281 $self->{dbh}->disconnect if $self->{dbh};
282}
283
284sub errstr { $DNSDB::errstr; }
285
286##
287## utility functions
288##
289
290## DNSDB::_rectable()
291# Takes default+rdns flags, returns appropriate table name
292sub _rectable {
293 my $def = shift;
294 my $rev = shift;
295
296 return 'records' if $def ne 'y';
297 return 'default_records' if $rev ne 'y';
298 return 'default_rev_records';
299} # end _rectable()
300
301## DNSDB::_recparent()
302# Takes default+rdns flags, returns appropriate parent-id column name
303sub _recparent {
304 my $def = shift;
305 my $rev = shift;
306
307 return 'group_id' if $def eq 'y';
308 return 'rdns_id' if $rev eq 'y';
309 return 'domain_id';
310} # end _recparent()
311
312## DNSDB::_ipparent()
313# Check an IP to be added in a reverse zone to see if it's really in the requested parent.
314# Takes default and reverse flags, IP (fragment) to check, parent zone ID,
315# and a reference to a NetAddr::IP object (also used to pass back a fully-reconstructed IP for
316# database insertion)
317sub _ipparent {
318 my $self = shift;
319 my $dbh = $self->{dbh};
320 my $defrec = shift;
321 my $revrec = shift;
322 my $val = shift;
323 my $id = shift;
324 my $addr = shift;
325
326 return if $revrec ne 'y'; # this sub not useful in forward zones
327
328 $$addr = NetAddr::IP->new($$val); #necessary?
329
330 # subsub to split, reverse, and overlay an IP fragment on a netblock
331 sub __rev_overlay {
332 my $splitme = shift; # ':' or '.', m'lud?
333 my $parnet = shift;
334 my $val = shift;
335 my $addr = shift;
336
337 my $joinme = $splitme;
338 $splitme = '\.' if $splitme eq '.';
339 my @working = reverse(split($splitme, $parnet->addr));
340 my @parts = reverse(split($splitme, $$val));
341 for (my $i = 0; $i <= $#parts; $i++) {
342 $working[$i] = $parts[$i];
343 }
344 my $checkme = NetAddr::IP->new(join($joinme, reverse(@working))) or return 0;
345 return 0 unless $checkme->within($parnet);
346 $$addr = $checkme; # force "correct" IP to be recorded.
347 return 1;
348 }
349
350 my ($parstr) = $dbh->selectrow_array("SELECT revnet FROM revzones WHERE rdns_id = ?", undef, ($id));
351 my $parnet = NetAddr::IP->new($parstr);
352
353 # Fail early on v6-in-v4 or v4-in-v6. We're not accepting these ATM.
354 return 0 if $parnet->addr =~ /\./ && $$val =~ /:/;
355 return 0 if $parnet->addr =~ /:/ && $$val =~ /\./;
356
357 if ($$addr && ($$val =~ /^[\da-fA-F][\da-fA-F:]+[\da-fA-F]$/ || $$val =~ m|/\d+$|)) {
358 # the only case where NetAddr::IP's acceptance of legitimate IPs is "correct" is for a proper IPv6 address,
359 # or a netblock (only expected on templates)
360 # the rest we have to restructure before fiddling. *sigh*
361 return 1 if $$addr->within($parnet);
362 } else {
363 # We don't have a complete IP in $$val (yet)... unless we have a netblock
364 if ($parnet->addr =~ /:/) {
365 $$val =~ s/^:+//; # gotta strip'em all...
366 return __rev_overlay(':', $parnet, $val, $addr);
367 }
368 if ($parnet->addr =~ /\./) {
369 $$val =~ s/^\.+//;
370 return __rev_overlay('.', $parnet, $val, $addr);
371 }
372 # should be impossible to get here...
373 }
374 # ... and here.
375 # can't do nuttin' in forward zones
376} # end _ipparent()
377
378## DNSDB::_maybeip()
379# Wrapper for quick "does this look like an IP address?" regex, so we don't make dumb copy-paste mistakes
380sub _maybeip {
381 my $izzit = shift; # reference
382 return 1 if $$izzit =~ m,^(?:[\d\./]+|[0-9a-fA-F:/]+)$,;
383}
384
385## DNSDB::_inrev()
386# Check if a given "hostname" is within a given reverse zone
387# Takes a reference to the "hostname" and the reverse zone CIDR as a NetAddr::IP
388# Returns true/false. Sets $errstr on errors.
389sub _inrev {
390 my $self = shift;
391 my $dbh = $self->{dbh};
392 # References, since we might munge them
393 my $fq = shift;
394 my $zone = shift;
395
396 # set default error
397 $errstr = "$$fq not within $zone";
398
399 # Unlike forward zones, we will not coerce the data into the reverse zone - an A record
400 # in a reverse zone is already silly enough without appending a mess of 1.2.3.in-addr.arpa
401 # (or worse, 1.2.3.4.5.6.7.8.ip6.arpa) on the end of the nominal "hostname".
402 # We're also going to allow the "hostname" to be stored as .arpa or IP, because of
403 # non-IP FQDNs in .arpa
404 if ($$fq =~ /\.arpa$/) {
405 # "FQDN" could be any syntactically legitimate string, but it must be within the formal
406 # .arpa zone. Note we're not validating these for correct reverse-IP values.
407 # yes, we really need the v6 branch on the end here.
408 $zone = _ZONE($zone, 'ZONE', 'r', '.').($zone->{isv6} ? '.ip6.arpa' : '.in-addr.arpa');
409 return unless $$fq =~ /$zone$/;
410 } else {
411 # in most cases we should be getting a real IP as the "FQDN" to test
412 my $addr = new NetAddr::IP $$fq if _maybeip($fq);
413
414 # "FQDN" should be a valid IP address. Normalize formatting if so.
415 if (!$addr) {
416 $errstr = "$$fq is not a valid IP address";
417 return;
418 }
419 return if !$zone->contains($addr);
420 ($$fq = $addr) =~ s{/(?:32|128)$}{};
421 }
422 return 1;
423} # end _inrev()
424
425## DNSDB::_hostparent()
426# A little different than _ipparent above; this tries to *find* the parent zone of a hostname
427# Takes a hostname.
428# Returns the domain ID of the parent domain if one was found.
429sub _hostparent {
430 my $self = shift;
431 my $dbh = $self->{dbh};
432 my $hname = shift;
433
434 $hname =~ s/^\*\.//; # this should be impossible to find in the domains table.
435 my @hostbits = split /\./, $hname;
436 my $sth = $dbh->prepare("SELECT count(*),domain_id FROM domains WHERE lower(domain) = lower(?) GROUP BY domain_id");
437 foreach (@hostbits) {
438 $sth->execute($hname);
439 my ($found, $parid) = $sth->fetchrow_array;
440 if ($found) {
441 return $parid;
442 }
443 $hname =~ s/^$_\.//;
444 }
445} # end _hostparent()
446
447## DNSDB::_log()
448# Log an action
449# Takes a log entry hash containing at least:
450# group_id, log entry
451# and optionally one or more of:
452# domain_id, rdns_id
453# The %userdata hash provides the user ID, username, and fullname
454sub _log {
455 my $self = shift;
456 my $dbh = $self->{dbh};
457
458 my %args = @_;
459
460 $args{rdns_id} = 0 if !$args{rdns_id};
461 $args{domain_id} = 0 if !$args{domain_id};
462
463##fixme: farm out the actual logging to different subs for file, syslog, internal, etc based on config
464# if ($self->{log_channel} eq 'sql') {
465 $dbh->do("INSERT INTO log (domain_id,rdns_id,group_id,entry,user_id,email,name) VALUES (?,?,?,?,?,?,?)",
466 undef,
467 ($args{domain_id}, $args{rdns_id}, $args{group_id}, $args{entry},
468 $self->{loguserid}, $self->{logusername}, $self->{logfullname}) );
469# } elsif ($self->{log_channel} eq 'file') {
470# } elsif ($self->{log_channel} eq 'syslog') {
471# }
472} # end _log
473
474
475##
476## Record validation subs.
477##
478
479## All of these subs take substantially the same arguments:
480# a hash containing at least the following keys:
481# - defrec (default/live flag)
482# - revrec (forward/reverse flag)
483# - id (parent entity ID)
484# - host (hostname)
485# - rectype
486# - val (IP, hostname [CNAME/MX/SRV] or text)
487# - addr (NetAddr::IP object from val. May be undef.)
488# MX and SRV record validation also expect distance, and SRV records expect weight and port as well.
489# host, rectype, and addr should be references as these may be modified in validation
490
491# A record
492sub _validate_1 {
493 my $self = shift;
494 my $dbh = $self->{dbh};
495
496 my %args = @_;
497
498# only for strict type restrictions
499# return ('FAIL', 'Reverse zones cannot contain A records') if $args{revrec} eq 'y';
500
501 if ($args{revrec} eq 'y') {
502 # Get the revzone, so we can see if ${$args{val}} is in that zone
503 my $revzone = new NetAddr::IP $self->revName($args{id}, 'y');
504
505 return ('FAIL', $errstr) if !$self->_inrev($args{val}, $revzone);
506
507 # ${$args{val}} is either a valid IP or a string ending with the .arpa zone name;
508 # now check if it's a well-formed FQDN
509 return ('FAIL', $errstr) if ! _check_hostname_form(${$args{val}}, ${$args{rectype}}, $args{defrec}, $args{revrec}) &&
510 ${$args{val}} =~ /\.arpa$/;
511
512 # Check IP is well-formed, and that it's a v4 address
513 # Fail on "compact" IPv4 variants, because they are not consistent and predictable.
514 return ('FAIL',"A record must be a valid IPv4 address")
515 unless ${$args{host}} =~ /^\d+\.\d+\.\d+\.\d+$/;
516 $args{addr} = new NetAddr::IP ${$args{host}};
517 return ('FAIL',"A record must be a valid IPv4 address")
518 unless $args{addr} && !$args{addr}->{isv6};
519 # coerce IP/value to normalized form for storage
520 ${$args{host}} = $args{addr}->addr;
521
522 # I'm just going to ignore the utterly barmy idea of an A record in the *default*
523 # records for a reverse zone; it's bad enough to find one in funky legacy data.
524
525 } else {
526 # revrec ne 'y'
527
528 # Coerce all hostnames to end in ".DOMAIN" for group/default records,
529 # or the intended parent domain for live records.
530 my $pname = ($args{defrec} eq 'y' ? 'DOMAIN' : $self->domainName($args{id}));
531 ${$args{host}} =~ s/\.*$/\.$pname/ if (${$args{host}} ne '@' && ${$args{host}} !~ /$pname$/);
532
533 # Check if it's a proper formal .arpa name for an IP, and renormalize it to the IP
534 # value if so. Done mainly for symmetry with PTR/A+PTR, and saves a conversion on export.
535 if (${$args{val}} =~ /\.arpa$/) {
536 my ($code,$tmp) = _zone2cidr(${$args{val}});
537 if ($code ne 'FAIL') {
538 ${$args{val}} = $tmp->addr;
539 $args{addr} = $tmp;
540 }
541 }
542 # Check IP is well-formed, and that it's a v4 address
543 # Fail on "compact" IPv4 variants, because they are not consistent and predictable.
544 return ('FAIL',"A record must be a valid IPv4 address")
545 unless ${$args{val}} =~ /^\d+\.\d+\.\d+\.\d+$/;
546 return ('FAIL',"A record must be a valid IPv4 address")
547 unless $args{addr} && !$args{addr}->{isv6};
548 # coerce IP/value to normalized form for storage
549 ${$args{val}} = $args{addr}->addr;
550 }
551
552 return ('OK','OK');
553} # done A record
554
555# NS record
556sub _validate_2 {
557 my $self = shift;
558 my $dbh = $self->{dbh};
559
560 my %args = @_;
561
562 # NS target check - IP addresses not allowed. Must be a more or less well-formed hostname.
563 if ($args{revrec} eq 'y') {
564 return ('FAIL', "NS records cannot point directly to an IP address")
565 if ${$args{host}} =~ /^(?:[\d.]+|[0-9a-fA-F:]+)$/;
566##enhance: Look up the passed value to see if it exists. Ooo, fancy.
567 return ('FAIL', $errstr) if ! _check_hostname_form(${$args{host}}, ${$args{rectype}}, $args{defrec}, $args{revrec});
568 } else {
569 return ('FAIL', "NS records cannot point directly to an IP address")
570 if ${$args{val}} =~ /^(?:[\d.]+|[0-9a-fA-F:]+)$/;
571##enhance: Look up the passed value to see if it exists. Ooo, fancy.
572 return ('FAIL', $errstr) if ! _check_hostname_form(${$args{val}}, ${$args{rectype}}, $args{defrec}, $args{revrec});
573 }
574
575 # Check that the target of the record is within the parent.
576 if ($args{defrec} eq 'n') {
577 # Check if IP/address/zone/"subzone" is within the parent
578 if ($args{revrec} eq 'y') {
579 # Get the revzone, so we can see if ${$args{val}} is in that zone
580 my $revzone = new NetAddr::IP $self->revName($args{id}, 'y');
581
582 # Note the NS record may or may not be for the zone itself, it may be a pointer for a subzone
583 return ('FAIL', $errstr) if !$self->_inrev($args{val}, $revzone);
584
585 # ${$args{val}} is either a valid IP or a string ending with the .arpa zone name;
586 # now check if it's a well-formed FQDN
587##enhance or ##fixme
588# convert well-formed .arpa names to IP addresses to match old "strict" validation design
589 return ('FAIL', $errstr) if ! _check_hostname_form(${$args{val}}, ${$args{rectype}}, $args{defrec}, $args{revrec}) &&
590 ${$args{val}} =~ /\.arpa$/;
591 } else {
592 # Forcibly append the domain name if the hostname being added does not end with the current domain name
593 my $pname = $self->domainName($args{id});
594 ${$args{host}} =~ s/\.*$/\.$pname/ if ${$args{host}} !~ /$pname$/;
595 }
596 } else {
597 # Default reverse NS records should always refer to the implied parent.
598 if ($args{revrec} eq 'y') {
599 ${$args{val}} = 'ZONE';
600 } else {
601 ${$args{host}} = 'DOMAIN';
602 }
603 }
604
605 return ('OK','OK');
606} # done NS record
607
608# CNAME record
609sub _validate_5 {
610 my $self = shift;
611 my $dbh = $self->{dbh};
612
613 my %args = @_;
614
615 # CNAMEs in reverse zones shouldn't be handled manually, they should be generated on
616 # export by use of the "delegation" type. For the masochistic, and those importing
617 # legacy data from $deity-knows-where, we'll support them.
618
619 if ($args{revrec} eq 'y') {
620 # CNAME target check - IP addresses not allowed. Must be a more or less well-formed hostname.
621 return ('FAIL', "CNAME records cannot point directly to an IP address")
622 if ${$args{host}} =~ /^(?:[\d.]+|[0-9a-fA-F:]+)$/;
623
624 if ($args{defrec} eq 'n') {
625 # Get the revzone, so we can see if ${$args{val}} is in that zone
626 my $revzone = new NetAddr::IP $self->revName($args{id}, 'y');
627 return ('FAIL', $errstr) if !$self->_inrev($args{val}, $revzone);
628 }
629
630##enhance or ##fixme
631# convert well-formed .arpa names to IP addresses to match old "strict" validation design
632 return ('FAIL', $errstr) if ! _check_hostname_form(${$args{val}}, ${$args{rectype}}, $args{defrec}, $args{revrec}) &&
633 ${$args{val}} =~ /\.arpa$/;
634
635##enhance: Look up the passed value to see if it exists. Ooo, fancy.
636 return ('FAIL', $errstr) if ! _check_hostname_form(${$args{host}}, ${$args{rectype}}, $args{defrec}, $args{revrec});
637 } else {
638 # CNAME target check - IP addresses not allowed. Must be a more or less well-formed hostname.
639 return ('FAIL', "CNAME records cannot point directly to an IP address")
640 if ${$args{val}} =~ /^(?:[\d.]+|[0-9a-fA-F:]+)$/;
641
642 # Forcibly append the domain name if the hostname being added does not end with the current domain name
643 my $pname = ($args{defrec} eq 'y' ? 'DOMAIN' : $self->domainName($args{id}));
644 ${$args{host}} =~ s/\.*$/\.$pname/ if ${$args{host}} !~ /$pname$/;
645
646##enhance: Look up the passed value to see if it exists. Ooo, fancy.
647 return ('FAIL', $errstr) if ! _check_hostname_form(${$args{val}}, ${$args{rectype}}, $args{defrec}, $args{revrec});
648 }
649
650 return ('OK','OK');
651} # done CNAME record
652
653# SOA record
654sub _validate_6 {
655 # Smart monkeys won't stick their fingers in here; we have
656 # separate dedicated routines to deal with SOA records.
657 return ('OK','OK');
658} # done SOA record
659
660# PTR record
661sub _validate_12 {
662 my $self = shift;
663 my $dbh = $self->{dbh};
664
665 my %args = @_;
666 my $warnflag = '';
667
668 if ($args{defrec} eq 'y') {
669 if ($args{revrec} eq 'y') {
670 if (${$args{val}} =~ /^[\d.]+$/) {
671 # v4 or bare number
672 if (${$args{val}} =~ /^\d+\.\d+\.\d+\.\d+$/) {
673 # probable full IP. pointless but harmless. validate/normalize.
674 my $tmp = NetAddr::IP->new(${$args{val}})->addr
675 or return ('FAIL', "${$args{val}} is not a valid IP address");
676 ${$args{val}} = $tmp;
677 $warnflag = "${$args{val}} will only be added to a small number of zones\n";
678 } elsif (${$args{val}} =~ /^\d+$/) {
679 # bare number. This can be expanded to either a v4 or v6 zone
680 ${$args{val}} =~ s/^\.*/ZONE./ unless ${$args{val}} =~ /^ZONE/;
681 } else {
682 # $deity-only-knows what kind of gibberish we've been given. Only usable as a formal .arpa name.
683 # Append ARPAZONE to be replaced with the formal .arpa zone name when converted to a live record.
684 ${$args{val}} =~ s/\.*$/.ARPAZONE/ unless ${$args{val}} =~ /ARPAZONE$/;
685 }
686 } elsif (${$args{val}} =~ /^[a-fA-F0-9:]+$/) {
687 # v6 or fragment; pray it's not complete gibberish
688 ${$args{val}} =~ s/^:*/ZONE::/ unless ${$args{val}} =~ /^ZONE/;
689 } else {
690 # $deity-only-knows what kind of gibberish we've been given. Only usable as a formal .arpa name.
691 # Append ARPAZONE to be replaced with the formal .arpa zone name when converted to a live record.
692 ${$args{val}} .= ".ARPAZONE" unless ${$args{val}} =~ /ARPAZONE$/;
693 }
694 } else {
695 return ('FAIL', "PTR records are not supported in default record sets for forward zones (domains)");
696 }
697 } else {
698 if ($args{revrec} eq 'y') {
699 # Get the revzone, so we can see if ${$args{val}} is in that zone
700 my $revzone = new NetAddr::IP $self->revName($args{id}, 'y');
701
702 return ('FAIL', $errstr) if !$self->_inrev($args{val}, $revzone);
703
704 if (${$args{val}} =~ /\.arpa$/) {
705 # Check that it's well-formed
706 return ('FAIL', $errstr) if ! _check_hostname_form(${$args{val}}, ${$args{rectype}}, $args{defrec}, $args{revrec});
707
708 # Check if it's a proper formal .arpa name for an IP, and renormalize it to the IP
709 # value if so. I can't see why someone would voluntarily work with those instead of
710 # the natural IP values but what the hey.
711 my ($code,$tmp) = _zone2cidr(${$args{val}});
712 ${$args{val}} = $tmp->addr if $code ne 'FAIL';
713 } else {
714 # not a formal .arpa name, so it should be an IP value. Validate...
715 return ('FAIL', "${$args{val}} is not a valid IP value")
716 unless ${$args{val}} =~ /^(?:\d+\.\d+\.\d+\.\d+|[a-fA-F0-9:]+)$/;
717 $args{addr} = NetAddr::IP->new(${$args{val}})
718 or return ('FAIL', "IP/value looks like an IP address but isn't valid");
719 # ... and normalize.
720 ${$args{val}} = $args{addr}->addr;
721 }
722 # Validate PTR target for form.
723 return ('FAIL', $errstr) if ! _check_hostname_form(${$args{host}}, ${$args{rectype}}, $args{defrec}, $args{revrec});
724 } else { # revrec ne 'y'
725 # Fetch the domain and append if the passed hostname isn't within it.
726 my $pname = ($args{defrec} eq 'y' ? 'DOMAIN' : $self->domainName($args{id}));
727 ${$args{host}} =~ s/\.*$/\.$pname/ if ${$args{host}} !~ /$pname$/;
728 # Validate hostname and target for form
729 return ('FAIL', $errstr) if ! _check_hostname_form(${$args{host}}, ${$args{rectype}}, $args{defrec}, $args{revrec});
730 return ('FAIL', $errstr) if ! _check_hostname_form(${$args{val}}, ${$args{rectype}}, $args{defrec}, $args{revrec});
731 }
732 }
733
734# Multiple PTR records do NOT generally do what most people believe they do,
735# and tend to fail in the most awkward way possible. Check and warn.
736
737 my $chkbase = ${$args{val}};;
738 my $hostcol = 'val'; # Reverse zone hostnames are stored "backwards"
739 if ($args{revrec} eq 'n') { # PTRs in forward zones should be rare.
740 $chkbase = ${$args{host}};
741 $hostcol = 'host';
742 }
743 my @checkvals = ($chkbase);
744 if ($chkbase =~ /,/) {
745 # push . and :: variants into checkvals if $chkbase has ,
746 my $tmp;
747 ($tmp = $chkbase) =~ s/,/./;
748 push @checkvals, $tmp;
749 ($tmp = $chkbase) =~ s/,/::/;
750 push @checkvals, $tmp;
751 }
752
753 my $pcsth = $dbh->prepare("SELECT count(*) FROM "._rectable($args{defrec},$args{revrec})." WHERE $hostcol = ?");
754 foreach my $checkme (@checkvals) {
755 if ($args{update}) {
756 # $args{update} contains the ID of the record being updated. If the list of records that matches
757 # the new hostname specification doesn't include this, the change effectively adds a new PTR that's
758 # the same as one or more existing ones.
759 my @ptrs = @{ $dbh->selectcol_arrayref("SELECT record_id FROM "._rectable($args{defrec},$args{revrec}).
760 " WHERE val = ?", undef, ($checkme)) };
761 $warnflag .= "PTR record for $checkme already exists; adding another will probably not do what you want"
762 if @ptrs && (!grep /^$args{update}$/, @ptrs);
763 } else {
764 # New record. Always warn if a PTR exists
765 my ($ptrcount) = $dbh->selectrow_array("SELECT count(*) FROM "._rectable($args{defrec},$args{revrec}).
766 " WHERE $hostcol = ?", undef, ($checkme));
767 $warnflag .= "PTR record for $checkme already exists; adding another will probably not do what you want"
768 if $ptrcount;
769 }
770 }
771
772 return ('WARN',$warnflag) if $warnflag;
773
774 return ('OK','OK');
775} # done PTR record
776
777# MX record
778sub _validate_15 {
779 my $self = shift;
780 my $dbh = $self->{dbh};
781
782 my %args = @_;
783
784# only for strict type restrictions
785# return ('FAIL', 'Reverse zones cannot contain MX records') if $args{revrec} eq 'y';
786
787 return ('FAIL', "Distance is required for MX records") unless defined(${$args{dist}});
788 ${$args{dist}} =~ s/\s*//g;
789 return ('FAIL',"Distance is required, and must be numeric") unless ${$args{dist}} =~ /^\d+$/;
790
791 ${$args{fields}} = "distance,";
792 push @{$args{vallist}}, ${$args{dist}};
793
794 if ($args{revrec} eq 'n') {
795 # MX target check - IP addresses not allowed. Must be a more or less well-formed hostname.
796 return ('FAIL', "MX records cannot point directly to an IP address")
797 if ${$args{val}} =~ /^(?:[\d.]+|[0-9a-fA-F:]+)$/;
798
799 # Coerce all hostnames to end in ".DOMAIN" for group/default records,
800 # or the intended parent domain for live records.
801 my $pname = ($args{defrec} eq 'y' ? 'DOMAIN' : $self->domainName($args{id}));
802 ${$args{host}} =~ s/\.*$/\.$pname/ if ${$args{host}} !~ /$pname$/;
803 } else {
804 # MX target check - IP addresses not allowed. Must be a more or less well-formed hostname.
805 return ('FAIL', "MX records cannot point directly to an IP address")
806 if ${$args{val}} =~ /^(?:[\d.]+|[0-9a-fA-F:]+)$/;
807
808 # MX records in reverse zones get stricter treatment. The UI bars adding them in
809 # reverse record sets, but we "need" to allow editing existing ones. And we'll allow
810 # editing them if some loon manually munges one into a default reverse record set.
811 if ($args{defrec} eq 'n') {
812 # Get the revzone, so we can see if ${$args{val}} is in that zone
813 my $revzone = new NetAddr::IP $self->revName($args{id}, 'y');
814 return ('FAIL', $errstr) if !$self->_inrev($args{val}, $revzone);
815 }
816
817##enhance or ##fixme
818# convert well-formed .arpa names to IP addresses to match old "strict" validation design
819 return ('FAIL', $errstr) if ! _check_hostname_form(${$args{val}}, ${$args{rectype}}, $args{defrec}, $args{revrec}) &&
820 ${$args{val}} =~ /\.arpa$/;
821
822##enhance: Look up the passed value to see if it exists. Ooo, fancy.
823 return ('FAIL', $errstr) if ! _check_hostname_form(${$args{host}}, ${$args{rectype}}, $args{defrec}, $args{revrec});
824
825 }
826
827 return ('OK','OK');
828} # done MX record
829
830# TXT record
831sub _validate_16 {
832 my $self = shift;
833
834 my %args = @_;
835
836 if ($args{revrec} eq 'n') {
837 # Coerce all hostnames to end in ".DOMAIN" for group/default records,
838 # or the intended parent domain for live records.
839 my $pname = ($args{defrec} eq 'y' ? 'DOMAIN' : $self->domainName($args{id}));
840 ${$args{host}} =~ s/\.*$/\.$pname/ if ${$args{host}} !~ /$pname$/;
841 return ('FAIL', $errstr) if ! _check_hostname_form(${$args{host}}, ${$args{rectype}}, $args{defrec}, $args{revrec});
842 } else {
843 # We don't coerce reverse "hostnames" into the zone, mainly because we store most sane
844 # records as IP values, not .arpa names.
845 if ($args{defrec} eq 'n') {
846 # Get the revzone, so we can see if ${$args{val}} is in that zone
847 my $revzone = new NetAddr::IP $self->revName($args{id}, 'y');
848 return ('FAIL', $errstr) if !$self->_inrev($args{val}, $revzone);
849 }
850
851##enhance or ##fixme
852# convert well-formed .arpa names to IP addresses to match old "strict" validation design
853 return ('FAIL', $errstr) if ! _check_hostname_form(${$args{val}}, ${$args{rectype}}, $args{defrec}, $args{revrec}) &&
854 ${$args{val}} =~ /\.arpa$/;
855 }
856
857 # Could arguably put a WARN return here on very long (>512) records
858 return ('OK','OK');
859} # done TXT record
860
861# RP record
862sub _validate_17 {
863 # Probably have to validate these separately some day. Call _validate_16() above since
864 # they're otherwise very similar
865 return _validate_16(@_);
866} # done RP record
867
868# AAAA record
869sub _validate_28 {
870 my $self = shift;
871 my $dbh = $self->{dbh};
872
873 my %args = @_;
874
875 return ('FAIL', 'Reverse zones cannot contain AAAA records') if $args{revrec} eq 'y';
876
877 # Coerce all hostnames to end in ".DOMAIN" for group/default records,
878 # or the intended parent domain for live records.
879 my $pname = ($args{defrec} eq 'y' ? 'DOMAIN' : $self->domainName($args{id}));
880 ${$args{host}} =~ s/\.*$/\.$pname/ if ${$args{host}} !~ /$pname$/;
881
882 # Check IP is well-formed, and that it's a v6 address
883 return ('FAIL',"$typemap{${$args{rectype}}} record must be a valid IPv6 address")
884 unless $args{addr} && $args{addr}->{isv6};
885 # coerce IP/value to normalized form for storage
886 ${$args{val}} = $args{addr}->addr;
887
888 return ('OK','OK');
889} # done AAAA record
890
891# SRV record
892sub _validate_33 {
893 my $self = shift;
894 my $dbh = $self->{dbh};
895
896 my %args = @_;
897
898# Not absolutely true but WTF use is an SRV record for a reverse zone?
899 return ('FAIL', 'Reverse zones cannot contain SRV records') if $args{revrec} eq 'y';
900
901 return ('FAIL', "Distance is required for SRV records") unless defined(${$args{dist}});
902 ${$args{dist}} =~ s/\s*//g;
903 return ('FAIL',"Distance is required, and must be numeric") unless ${$args{dist}} =~ /^\d+$/;
904
905 # Coerce all hostnames to end in ".DOMAIN" for group/default records,
906 # or the intended parent domain for live records.
907 my $pname = ($args{defrec} eq 'y' ? 'DOMAIN' : $self->domainName($args{id}));
908 ${$args{host}} =~ s/\.*$/\.$pname/ if ${$args{host}} !~ /$pname$/;
909
910 return ('FAIL',"SRV records must begin with _service._protocol [${$args{host}}]")
911 unless ${$args{host}} =~ /^_[A-Za-z]+\._[A-Za-z]+\.[a-zA-Z0-9-]+/;
912 return ('FAIL',"Port and weight are required for SRV records")
913 unless defined(${$args{weight}}) && defined(${$args{port}});
914 ${$args{weight}} =~ s/\s*//g;
915 ${$args{port}} =~ s/\s*//g;
916
917 return ('FAIL',"Port and weight are required, and must be numeric")
918 unless ${$args{weight}} =~ /^\d+$/ && ${$args{port}} =~ /^\d+$/;
919
920 ${$args{fields}} = "distance,weight,port,";
921 push @{$args{vallist}}, (${$args{dist}}, ${$args{weight}}, ${$args{port}});
922
923 return ('OK','OK');
924} # done SRV record
925
926# Now the custom types
927
928# A+PTR record. With a very little bit of magic we can also use this sub to validate AAAA+PTR. Whee!
929sub _validate_65280 {
930 my $self = shift;
931 my $dbh = $self->{dbh};
932
933 my %args = @_;
934
935 my $code = 'OK';
936 my $msg = 'OK';
937
938 if ($args{defrec} eq 'n') {
939 # live record; revrec determines whether we validate the PTR or A component first.
940
941 if ($args{revrec} eq 'y') {
942 ($code,$msg) = $self->_validate_12(%args);
943 return ($code,$msg) if $code eq 'FAIL';
944
945 # check A+PTR is really v4
946 return ('FAIL',"$typemap{${$args{rectype}}} record must be a valid IPv4 address")
947 if ${$args{rectype}} == 65280 && $args{addr}->{isv6};
948 # check AAAA+PTR is really v6
949 return ('FAIL',"$typemap{${$args{rectype}}} record must be a valid IPv6 address")
950 if ${$args{rectype}} == 65281 && !$args{addr}->{isv6};
951
952 # Check if the reqested domain exists. If not, coerce the type down to PTR and warn.
953 if (!(${$args{domid}} = $self->_hostparent(${$args{host}}))) {
954 my $addmsg = "Record ".($args{update} ? 'updated' : 'added').
955 " as PTR instead of $typemap{${$args{rectype}}}; domain not found for ${$args{host}}";
956 $msg .= "\n$addmsg" if $code eq 'WARN';
957 $msg = $addmsg if $code eq 'OK';
958 ${$args{rectype}} = $reverse_typemap{PTR};
959 return ('WARN', $msg);
960 }
961
962 # Add domain ID to field list and values
963 ${$args{fields}} .= "domain_id,";
964 push @{$args{vallist}}, ${$args{domid}};
965
966 } else {
967 ($code,$msg) = $self->_validate_1(%args) if ${$args{rectype}} == 65280;
968 ($code,$msg) = $self->_validate_28(%args) if ${$args{rectype}} == 65281;
969 return ($code,$msg) if $code eq 'FAIL';
970
971 # Check if the requested reverse zone exists - note, an IP fragment won't
972 # work here since we don't *know* which parent to put it in.
973 # ${$args{val}} has been validated as a valid IP by now, in one of the above calls.
974 my ($revid) = $dbh->selectrow_array("SELECT rdns_id FROM revzones WHERE revnet >> ?".
975 " ORDER BY masklen(revnet) DESC", undef, (${$args{val}}));
976 if (!$revid) {
977 $msg = "Record ".($args{update} ? 'updated' : 'added')." as ".(${$args{rectype}} == 65280 ? 'A' : 'AAAA').
978 " instead of $typemap{${$args{rectype}}}; reverse zone not found for ${$args{val}}";
979 ${$args{rectype}} = (${$args{rectype}} == 65280 ? $reverse_typemap{A} : $reverse_typemap{AAAA});
980 return ('WARN', $msg);
981 }
982
983 # Check for duplicate PTRs. Note we don't have to play games with $code and $msg, because
984 # by definition there can't be duplicate PTRs if the reverse zone isn't managed here.
985 if ($args{update}) {
986 # Record update. There should usually be an existing PTR (the record being updated)
987 my @ptrs = @{ $dbh->selectcol_arrayref("SELECT record_id FROM "._rectable($args{defrec},$args{revrec}).
988 " WHERE val = ?", undef, (${$args{val}})) };
989 if (@ptrs && (!grep /^$args{update}$/, @ptrs)) {
990 $msg = "PTR record for ${$args{val}} already exists; adding another will probably not do what you want";
991 $code = 'WARN';
992 }
993 } else {
994 # New record. Always warn if a PTR exists
995 my ($ptrcount) = $dbh->selectrow_array("SELECT count(*) FROM "._rectable($args{defrec},$args{revrec}).
996 " WHERE val = ?", undef, (${$args{val}}));
997 $msg = "PTR record for ${$args{val}} already exists; adding another will probably not do what you want"
998 if $ptrcount;
999 $code = 'WARN' if $ptrcount;
1000 }
1001
1002# my ($ptrcount) = $dbh->selectrow_array("SELECT count(*) FROM "._rectable($args{defrec},$args{revrec}).
1003# " WHERE val = ?", undef, ${$args{val}});
1004# if ($ptrcount) {
1005# my $curid = $dbh->selectrow_array("SELECT record_id FROM "._rectable($args{defrec},$args{revrec}).
1006# " WHERE val = ?
1007# $msg = "PTR record for ${$args{val}} already exists; adding another will probably not do what you want";
1008# $code = 'WARN';
1009# }
1010
1011 ${$args{fields}} .= "rdns_id,";
1012 push @{$args{vallist}}, $revid;
1013 }
1014
1015 } else { # defrec eq 'y'
1016 if ($args{revrec} eq 'y') {
1017 ($code,$msg) = $self->_validate_12(%args);
1018 return ($code,$msg) if $code eq 'FAIL';
1019 if (${$args{rectype}} == 65280) {
1020 return ('FAIL',"A+PTR record must be a valid IPv4 address or fragment")
1021 if ${$args{val}} =~ /:/;
1022 ${$args{val}} =~ s/^ZONE,/ZONE./; # Clean up after uncertain IP-fragment-type from _validate_12
1023 } elsif (${$args{rectype}} == 65281) {
1024 return ('FAIL',"AAAA+PTR record must be a valid IPv6 address or fragment")
1025 if ${$args{val}} =~ /\./;
1026 ${$args{val}} =~ s/^ZONE,/ZONE::/; # Clean up after uncertain IP-fragment-type from _validate_12
1027 }
1028 } else {
1029 # This is easy. I also can't see a real use-case for A/AAAA+PTR in *all* forward
1030 # domains, since you wouldn't be able to substitute both domain and reverse zone
1031 # sanely, and you'd end up with guaranteed over-replicated PTR records that would
1032 # confuse the hell out of pretty much anything that uses them.
1033##fixme: make this a config flag?
1034 return ('FAIL', "$typemap{${$args{rectype}}} records not allowed in default domains");
1035 }
1036 }
1037
1038 return ($code, $msg);
1039} # done A+PTR record
1040
1041# AAAA+PTR record
1042# A+PTR above has been magicked to handle AAAA+PTR as well.
1043sub _validate_65281 {
1044 return _validate_65280(@_);
1045} # done AAAA+PTR record
1046
1047# PTR template record
1048sub _validate_65282 {
1049 my $self = shift;
1050 my $dbh = $self->{dbh};
1051
1052 my %args = @_;
1053
1054 # we're *this* >.< close to being able to just call _validate_12... unfortunately we can't, quite.
1055 if ($args{revrec} eq 'y') {
1056 if ($args{defrec} eq 'n') {
1057 return ('FAIL', "Template block ${$args{val}} is not within ".$self->revName($args{id}))
1058 unless $self->_ipparent($args{defrec}, $args{revrec}, $args{val}, $args{id}, \$args{addr});
1059##fixme: warn if $args{val} is not /31 or larger block?
1060 ${$args{val}} = "$args{addr}";
1061 } else {
1062 if (${$args{val}} =~ /\./) {
1063 # looks like a v4 or fragment
1064 if (${$args{val}} =~ m|^\d+\.\d+\.\d+\.\d+(?:/\d+)?$|) {
1065 # woo! a complete IP! validate it and normalize, or fail.
1066 $args{addr} = NetAddr::IP->new(${$args{val}})
1067 or return ('FAIL', "IP/value looks like IPv4 but isn't valid");
1068 ${$args{val}} = "$args{addr}";
1069 } else {
1070 ${$args{val}} =~ s/^\.*/ZONE./ unless ${$args{val}} =~ /^ZONE/;
1071 }
1072 } elsif (${$args{val}} =~ /[a-f:]/) {
1073 # looks like a v6 or fragment
1074 ${$args{val}} =~ s/^:*/ZONE::/ if !$args{addr} && ${$args{val}} !~ /^ZONE/;
1075 if ($args{addr}) {
1076 if ($args{addr}->addr =~ /^0/) {
1077 ${$args{val}} =~ s/^:*/ZONE::/ unless ${$args{val}} =~ /^ZONE/;
1078 } else {
1079 ${$args{val}} = "$args{addr}";
1080 }
1081 }
1082 } else {
1083 # bare number (probably). These could be v4 or v6, so we'll
1084 # expand on these on creation of a reverse zone.
1085 ${$args{val}} = "ZONE,${$args{val}}" unless ${$args{val}} =~ /^ZONE/;
1086 }
1087 }
1088##fixme: validate %-patterns?
1089
1090# Unlike single PTR records, there is absolutely no way to sanely support multiple
1091# PTR templates for the same block, since they expect to expand to all the individual
1092# IPs on export. Nested templates should be supported though.
1093
1094 my @checkvals = (${$args{val}});
1095 if (${$args{val}} =~ /,/) {
1096 # push . and :: variants into checkvals if val has ,
1097 my $tmp;
1098 ($tmp = ${$args{val}}) =~ s/,/./;
1099 push @checkvals, $tmp;
1100 ($tmp = ${$args{val}}) =~ s/,/::/;
1101 push @checkvals, $tmp;
1102 }
1103##fixme: this feels wrong still - need to restrict template pseudorecords to One Of Each
1104# Per Netblock such that they don't conflict on export
1105 my $typeck;
1106# type 65282 -> ptr template -> look for any of 65282, 65283, 65284
1107 $typeck = 'type=65283 OR type=65284' if ${$args{rectype}} == 65282;
1108# type 65283 -> a+ptr template -> v4 -> look for 65282 or 65283
1109 $typeck = 'type=65283' if ${$args{rectype}} == 65282;
1110# type 65284 -> aaaa+ptr template -> v6 -> look for 65282 or 65284
1111 $typeck = 'type=65284' if ${$args{rectype}} == 65282;
1112 my $pcsth = $dbh->prepare("SELECT count(*) FROM "._rectable($args{defrec},$args{revrec})." WHERE val = ? ".
1113 "AND (type=65282 OR $typeck)");
1114 foreach my $checkme (@checkvals) {
1115 $pcsth->execute($checkme);
1116 my ($rc) = $pcsth->fetchrow_array;
1117 return ('FAIL', "Only one template pseudorecord may exist for a given IP block") if $rc > 1;
1118 }
1119
1120 } else {
1121 return ('FAIL', "Forward zones cannot contain PTR records");
1122 }
1123
1124 return ('OK','OK');
1125} # done PTR template record
1126
1127# A+PTR template record
1128sub _validate_65283 {
1129 my $self = shift;
1130 my $dbh = $self->{dbh};
1131
1132 my %args = @_;
1133
1134 my ($code,$msg) = ('OK','OK');
1135
1136##fixme: need to fiddle things since A+PTR templates are acceptable in live
1137# forward zones but not default records
1138 if ($args{defrec} eq 'n') {
1139 if ($args{revrec} eq 'n') {
1140 ($code,$msg) = $self->_validate_1(%args) if ${$args{rectype}} == 65280;
1141 ($code,$msg) = $self->_validate_28(%args) if ${$args{rectype}} == 65281;
1142 return ($code,$msg) if $code eq 'FAIL';
1143
1144 # Check if the requested reverse zone exists - note, an IP fragment won't
1145 # work here since we don't *know* which parent to put it in.
1146 # ${$args{val}} has been validated as a valid IP by now, in one of the above calls.
1147 my ($revid) = $dbh->selectrow_array("SELECT rdns_id FROM revzones WHERE revnet >> ?".
1148 " ORDER BY masklen(revnet) DESC", undef, (${$args{val}}));
1149 # Fail if no match; we can't coerce a PTR-template type down to not include the PTR bit currently.
1150 if (!$revid) {
1151 $msg = "Can't ".($args{update} ? 'update' : 'add')." ${$args{host}}/${$args{val}} as ".
1152 "$typemap{${$args{rectype}}}: reverse zone not found for ${$args{val}}";
1153##fixme: add A template, AAAA template types?
1154# ${$args{rectype}} = (${$args{rectype}} == 65280 ? $reverse_typemap{A} : $reverse_typemap{AAAA});
1155 return ('FAIL', $msg);
1156 }
1157
1158 # Add reverse zone ID to field list and values
1159 ${$args{fields}} .= "rdns_id,";
1160 push @{$args{vallist}}, $revid;
1161
1162 } else {
1163 return ('FAIL', "IP or IP fragment ${$args{val}} is not within ".$self->revName($args{id}))
1164 unless $self->_ipparent($args{defrec}, $args{revrec}, $args{val}, $args{id}, \$args{addr});
1165 ${$args{val}} = "$args{addr}";
1166
1167 if (!(${$args{domid}} = $self->_hostparent(${$args{host}}))) {
1168 my $addmsg = "Record ".($args{update} ? 'updated' : 'added').
1169 " as PTR template instead of $typemap{${$args{rectype}}}; domain not found for ${$args{host}}";
1170 $msg .= "\n$addmsg" if $code eq 'WARN';
1171 $msg = $addmsg if $code eq 'OK';
1172 ${$args{rectype}} = 65282;
1173 return ('WARN', $msg);
1174 }
1175
1176 # Add domain ID to field list and values
1177 ${$args{fields}} .= "domain_id,";
1178 push @{$args{vallist}}, ${$args{domid}};
1179 }
1180
1181 } else {
1182 my ($code,$msg) = $self->_validate_65282(%args);
1183 return ($code, $msg) if $code eq 'FAIL';
1184 # get domain, check against ${$args{name}}
1185 }
1186
1187 return ('OK','OK');
1188} # done A+PTR template record
1189
1190# AAAA+PTR template record
1191# Not sure this can be handled sanely due to the size of IPv6 address space
1192sub _validate_65284 {
1193 return ('OK','OK');
1194} # done AAAA+PTR template record
1195
1196# Delegation record
1197# This is essentially a specialized clone of the NS record, primarily useful
1198# for delegating IPv4 sub-/24 reverse blocks
1199sub _validate_65285 {
1200 my $self = shift;
1201 my $dbh = $self->{dbh};
1202
1203 my %args = @_;
1204
1205# Almost, but not quite, identical to NS record validation.
1206
1207 # Check that the target of the record is within the parent.
1208 # Yes, host<->val are mixed up here; can't see a way to avoid it. :(
1209 if ($args{defrec} eq 'n') {
1210 # Check if IP/address/zone/"subzone" is within the parent
1211 if ($args{revrec} eq 'y') {
1212 my $tmpip = NetAddr::IP->new(${$args{val}});
1213 my $pname = $self->revName($args{id});
1214 return ('FAIL',"${$args{val}} not within $pname")
1215 unless $self->_ipparent($args{defrec}, $args{revrec}, $args{val}, $args{id}, \$tmpip);
1216 # Normalize
1217 ${$args{val}} = "$tmpip";
1218 } else {
1219 my $pname = $self->domainName($args{id});
1220 ${$args{host}} =~ s/\.*$/\.$pname/ if ${$args{host}} !~ /$pname$/;
1221 }
1222 } else {
1223 return ('FAIL',"Delegation records are not permitted in default record sets");
1224 }
1225 return ('OK','OK');
1226}
1227
1228# Subs not specific to a particular record type
1229
1230# Convert $$host and/or $$val to lowercase as appropriate.
1231# Should only be called if $self->{lowercase} is true.
1232# $rectype is also a reference for caller convenience
1233sub _caseclean {
1234 my ($rectype, $host, $val, $defrec, $revrec) = @_;
1235
1236 # Can't case-squash default records, due to DOMAIN, ZONE, and ADMINDOMAIN templating
1237 return if $defrec eq 'y';
1238
1239 if ($typemap{$$rectype} eq 'TXT' || $typemap{$$rectype} eq 'SPF') {
1240 # TXT records should preserve user entry in the string.
1241 # SPF records are a duplicate of TXT with a new record type value (99)
1242 $$host = lc($$host) if $revrec eq 'n'; # only lowercase $$host on live forward TXT; preserve TXT content
1243 $$val = lc($$val) if $revrec eq 'y'; # only lowercase $$val on live reverse TXT; preserve TXT content
1244 } else {
1245 # Non-TXT, live records, are fully case-insensitive
1246 $$host = lc($$host);
1247 $$val = lc($$val);
1248 } # $typemap{$$rectype} else
1249
1250} # _caseclean()
1251
1252
1253##
1254## Record data substitution subs
1255##
1256
1257# Replace ZONE in hostname, or create (most of) the actual proper zone name
1258sub _ZONE {
1259 my $zone = shift;
1260 my $string = shift;
1261 my $fr = shift || 'f'; # flag for forward/reverse order? nb: ignored for IP
1262 my $sep = shift || '-'; # Separator character - unlikely we'll ever need more than . or -
1263
1264 my $prefix;
1265
1266 $string =~ s/,/./ if !$zone->{isv6};
1267 $string =~ s/,/::/ if $zone->{isv6};
1268
1269 # Subbing ZONE in the host. We need to properly ID the netblock range
1270 # The subbed text should have "network IP with trailing zeros stripped" for
1271 # blocks lined up on octet (for v4) or hex-quad (for v6) boundaries
1272 # For blocks that do NOT line up on these boundaries, we take the most
1273 # significant octet or 16-bit chunk of the "broadcast" IP and append it
1274 # after a double-dash
1275 # ie:
1276 # 8.0.0.0/6 -> 8.0.0.0 -> 11.255.255.255; sub should be 8--11
1277 # 10.0.0.0/12 -> 10.0.0.0 -> 10.0.0.0 -> 10.15.255.255; sub should be 10-0--15
1278 # 192.168.4.0/22 -> 192.168.4.0 -> 192.168.7.255; sub should be 192-168-4--7
1279 # 192.168.0.8/29 -> 192.168.0.8 -> 192.168.0.15; sub should be 192-168-0-8--15
1280 # Similar for v6
1281
1282 if (!$zone->{isv6}) { # IPv4
1283
1284 $prefix = $zone->network->addr; # Just In Case someone managed to slip in
1285 # a funky subnet that had host bits set.
1286 my $bc = $zone->broadcast->addr;
1287
1288 if ($zone->masklen > 24) {
1289 $bc =~ s/^\d+\.\d+\.\d+\.//;
1290 } elsif ($zone->masklen > 16) {
1291 $prefix =~ s/\.0$//;
1292 $bc =~ s/^\d+\.\d+\.//;
1293 } elsif ($zone->masklen > 8) {
1294 $bc =~ s/^\d+\.//;
1295 $prefix =~ s/\.0\.0$//;
1296 } else {
1297 $prefix =~ s/\.0\.0\.0$//;
1298 }
1299 if ($zone->masklen % 8) {
1300 $bc =~ s/(\.255)+$//;
1301 $prefix .= "--$bc"; #"--".zone->masklen; # use range or mask length?
1302 }
1303 if ($fr eq 'f') {
1304 $prefix =~ s/\.+/$sep/g;
1305 } else {
1306 $prefix = join($sep, reverse(split(/\./, $prefix)));
1307 }
1308
1309 } else { # IPv6
1310
1311 if ($fr eq 'f') {
1312
1313 $prefix = $zone->network->addr; # Just In Case someone managed to slip in
1314 # a funky subnet that had host bits set.
1315 my $bc = $zone->broadcast->addr;
1316 if (($zone->masklen % 16) != 0) {
1317 # Strip trailing :0 off $prefix, and :ffff off the broadcast IP
1318 for (my $i=0; $i<(7-int($zone->masklen / 16)); $i++) {
1319 $prefix =~ s/:0$//;
1320 $bc =~ s/:ffff$//;
1321 }
1322 # Strip the leading 16-bit chunks off the front of the broadcast IP
1323 $bc =~ s/^([a-f0-9]+:)+//;
1324 # Append the remaining 16-bit chunk to the prefix after "--"
1325 $prefix .= "--$bc";
1326 } else {
1327 # Strip off :0 from the end until we reach the netblock length.
1328 for (my $i=0; $i<(8-$zone->masklen / 16); $i++) {
1329 $prefix =~ s/:0$//;
1330 }
1331 }
1332 # Actually deal with the separator
1333 $prefix =~ s/:/$sep/g;
1334
1335 } else { # $fr eq 'f'
1336
1337 $prefix = $zone->network->full; # Just In Case someone managed to slip in
1338 # a funky subnet that had host bits set.
1339 my $bc = $zone->broadcast->full;
1340 $prefix =~ s/://g; # clean these out since they're not spaced right for this case
1341 $bc =~ s/://g;
1342 # Strip trailing 0 off $prefix, and f off the broadcast IP, to match the mask length
1343 for (my $i=0; $i<(31-int($zone->masklen / 4)); $i++) {
1344 $prefix =~ s/0$//;
1345 $bc =~ s/f$//;
1346 }
1347 # Split and reverse the order of the nibbles in the network/broadcast IPs
1348 # trim another 0 for nibble-aligned blocks first, but only if we really have a block, not an IP
1349 $prefix =~ s/0$// if $zone->masklen % 4 == 0 && $zone->masklen != 128;
1350 my @nbits = reverse split //, $prefix;
1351 my @bbits = reverse split //, $bc;
1352 # Handle the sub-nibble case. Eww. I feel dirty supporting this...
1353 $nbits[0] = "$nbits[0]-$bbits[0]" if ($zone->masklen % 4) != 0;
1354 # Glue it back together
1355 $prefix = join($sep, @nbits);
1356
1357 } # $fr ne 'f'
1358
1359 } # $zone->{isv6}
1360
1361 # Do the substitution, finally
1362 $string =~ s/ZONE/$prefix/;
1363 $string =~ s/--/-/ if $sep ne '-'; # - as separator needs extra help for sub-octet v4 netblocks
1364 return $string;
1365} # done _ZONE()
1366
1367# Not quite a substitution sub, but placed here as it's basically the inverse of above;
1368# given the .arpa zone name, return the CIDR netblock the zone is for.
1369# Supports v4 non-octet/non-classful netblocks as per the method outlined in the Grasshopper Book (2nd Ed p217-218)
1370# Does NOT support non-quad v6 netblocks via the same scheme; it shouldn't ever be necessary.
1371# Takes a nominal .arpa zone name, returns a success code and NetAddr::IP, or a fail code and message
1372sub _zone2cidr {
1373 my $zone = shift;
1374
1375 my $cidr;
1376 my $tmpcidr;
1377 my $warnmsg = '';
1378
1379 if ($zone =~ /\.in-addr\.arpa\.?$/) {
1380 # v4 revzone, formal zone name type
1381 my $tmpzone = $zone;
1382 return ('FAIL', "Non-numerics in apparent IPv4 reverse zone name [$tmpzone]")
1383 if $tmpzone !~ m{^(?:\d+[/-])?[\d\.]+\.in-addr\.arpa\.?$};
1384 $tmpzone =~ s/\.in-addr\.arpa\.?//;
1385
1386 # Snag the octet pieces
1387 my @octs = split /\./, $tmpzone;
1388
1389 # Map result of a range manipulation to a mask length change. Cheaper than finding the 2-root of $octets[0]+1.
1390 # Note we will not support /31 blocks, mostly due to issues telling "24-31" -> .24/29 apart from
1391 # "24-31" -> .24/31", with a litte bit of "/31 is icky".
1392 my %maskmap = ( 3 => 2, 7 => 3, 15 => 4, 31 => 5, 63 => 6, 127 => 7,
1393 30 => 2, 29 => 3, 28 => 4, 27 => 5, 26 => 6, 25 => 7
1394 );
1395
1396 # Handle "range" blocks, eg, 80-83.168.192.in-addr.arpa (192.168.80.0/22)
1397 # Need to take the size of the range to offset the basic octet-based mask length,
1398 # and make sure the first number in the range gets used as the network address for the block
1399 # Alternate form: The second number is actually the real netmask, not the end of the range.
1400 my $masklen = 0;
1401 if ($octs[0] =~ m{^((\d+)[/-](\d+))$}) { # take the range...
1402 if (24 < $3 && $3 < 31) {
1403 # we have a real netmask
1404 $masklen = -$maskmap{$3};
1405 } else {
1406 # we have a range. NB: only real CIDR ranges are supported
1407 $masklen -= $maskmap{-(eval $1)}; # find the mask base...
1408 }
1409 $octs[0] = $2; # set the base octet of the range...
1410 }
1411 @octs = reverse @octs; # We can reverse the octet pieces now that we've extracted and munged any ranges
1412
1413# arguably we should only allow sub-octet range/mask in-addr.arpa
1414# specifications in the least significant octet, but the code is
1415# simpler if we deal with sub-octet delegations at any level.
1416
1417 # Now we find the "true" mask with the aid of the "base" calculated above
1418 if ($#octs == 0) {
1419 $masklen += 8;
1420 $tmpcidr = "$octs[0].0.0.0/$masklen"; # really hope we don't see one of these very often.
1421 } elsif ($#octs == 1) {
1422 $masklen += 16;
1423 $tmpcidr = "$octs[0].$octs[1].0.0/$masklen";
1424 } elsif ($#octs == 2) {
1425 $masklen += 24;
1426 $tmpcidr = "$octs[0].$octs[1].$octs[2].0/$masklen";
1427 } else {
1428 $masklen += 32;
1429 $tmpcidr = "$octs[0].$octs[1].$octs[2].$octs[3]/$masklen";
1430 }
1431
1432 } elsif ($zone =~ /\.ip6\.arpa\.?$/) {
1433 # v6 revzone, formal zone name type
1434 my $tmpzone = $zone;
1435##fixme: if-n-when we decide we can support sub-nibble v6 zone names, we'll need to change this segment
1436 return ('FAIL', "Non-hexadecimals in apparent IPv6 reverse zone name [$tmpzone]")
1437 if $tmpzone !~ /^[a-fA-F\d\.]+\.ip6\.arpa\.?$/;
1438 $tmpzone =~ s/\.ip6\.arpa\.?//;
1439 my @quads = reverse(split(/\./, $tmpzone));
1440 $warnmsg .= "Apparent sub-/64 IPv6 reverse zone\n" if $#quads > 15;
1441 my $nc;
1442 foreach (@quads) {
1443 $tmpcidr .= $_;
1444 $tmpcidr .= ":" if ++$nc % 4 == 0 && $nc < $#quads;
1445 }
1446 my $nq = 1 if $nc % 4 != 0;
1447 my $mask = $nc * 4; # need to do this here because we probably increment it below
1448 while ($nc++ % 4 != 0) {
1449 $tmpcidr .= "0";
1450 }
1451 # polish it off with trailing ::/mask if this is a CIDR block instead of an IP
1452 $tmpcidr .= "::/$mask" if $mask != 128;
1453 }
1454
1455 # Just to be sure, use NetAddr::IP to validate. Saves a lot of nasty regex watching for valid octet values.
1456 return ('FAIL', "Invalid zone $zone (apparent netblock $tmpcidr)")
1457 unless $cidr = NetAddr::IP->new($tmpcidr);
1458
1459 if ($warnmsg) {
1460 $errstr = $warnmsg;
1461 return ('WARN', $cidr);
1462 }
1463 return ('OK', $cidr);
1464##fixme: use wantarray() to decide what to return?
1465} # done _zone2cidr()
1466
1467# Record template %-parameter expansion, IPv4. Note that IPv6 doesn't
1468# really have a sane way to handle this type of expansion at the moment
1469# due to the size of the address space.
1470# Takes a reference to a template string to be expanded, and an IP to use in the replacement.
1471sub _template4_expand {
1472 my $tmpl = shift;
1473 my $ip = shift;
1474
1475 my @ipparts = split /\./, $ip;
1476 my @iphex;
1477 my @ippad;
1478 for (@ipparts) {
1479 push @iphex, sprintf("%x", $_);
1480 push @ippad, sprintf("%0.3u", $_);
1481 }
1482
1483 # IP substitutions in template records:
1484 #major patterns:
1485 #dashed IP, forward and reverse
1486 #underscoreed IP, forward and reverse
1487 #dotted IP, forward and reverse (even if forward is... dumb)
1488 # -> %r for reverse, %i for forward, leading -, _, or . to indicate separator, defaults to -
1489 # %r or %-r => %4d-%3d-%2d-%1d
1490 # %_r => %4d_%3d_%2d_%1d
1491 # %.r => %4d.%3d.%2d.%1d
1492 # %i or %-i => %1d-%2d-%3d-%4d
1493 # %_i => %1d_%2d_%3d_%4d
1494 # %.i => %1d.%2d.%3d.%4d
1495 $$tmpl =~ s/\%r/\%4d-\%3d-\%2d-\%1d/g;
1496 $$tmpl =~ s/\%([-._])r/\%4d$1\%3d$1\%2d$1\%1d/g;
1497 $$tmpl =~ s/\%i/\%1d-\%2d-\%3d-\%4d/g;
1498 $$tmpl =~ s/\%([-._])i/\%1d$1\%2d$1\%3d$1\%4d/g;
1499
1500 #hex-coded IP
1501 # %h
1502 $$tmpl =~ s/\%h/$iphex[0]$iphex[1]$iphex[2]$iphex[3]/g;
1503
1504 #IP as decimal-coded 32-bit value
1505 # %d
1506 my $iptmp = $ipparts[0]*256*256*256 + $ipparts[1]*256*256 + $ipparts[2]*256 + $ipparts[3];
1507 $$tmpl =~ s/\%d/$iptmp/g;
1508
1509 #minor patterns (per-octet)
1510 # %[1234][dh0]
1511 #octet
1512 #hex-coded octet
1513 #0-padded octet
1514 $$tmpl =~ s/\%([1234])d/$ipparts[$1-1]/g;
1515 $$tmpl =~ s/\%([1234])h/$iphex[$1-1]/g;
1516 $$tmpl =~ s/\%([1234])0/$ippad[$1-1]/g;
1517} # _template4_expand()
1518
1519# Broad syntactic check on the hostname. Checks for valid characters, correctly-expandable template patterns.
1520# Takes the hostname, type, and live/default and forward/reverse flags
1521# Returns true/false, sets errstr on failures
1522sub _check_hostname_form {
1523 my ($hname,$rectype,$defrec,$revrec) = @_;
1524
1525 if ($hname =~ /\%/ && ($rectype == 65282 || $rectype == 65283) ) {
1526 my $tmphost = $hname;
1527 # we don't actually need to test with the real IP passed; that saves a bit of fiddling.
1528 _template4_expand(\$tmphost, '10.10.10.10');
1529 if ($tmphost =~ /\%/) {
1530 $errstr = "Invalid template $hname";
1531 return;
1532 }
1533 } elsif ($rectype == $reverse_typemap{CNAME}) {
1534 # Allow / in reverse CNAME hostnames for sub-/24 delegation
1535 if (lc($hname) !~ m|^[0-9a-z_./-]+$|) {
1536 # error message is deliberately restrictive; special cases are SPECIAL and not for general use
1537 $errstr = "Hostnames may not contain anything other than (0-9 a-z . _)";
1538 return;
1539 }
1540 } elsif ($revrec eq 'y') {
1541 # Reverse zones don't support @ in hostnames
1542 if (lc($hname) !~ /^(?:\*\.)?[0-9a-z_.-]+$/) {
1543 # error message is deliberately restrictive; special cases are SPECIAL and not for general use
1544 $errstr = "Hostnames may not contain anything other than (0-9 a-z . _)";
1545 return;
1546 }
1547 } else {
1548 if (lc($hname) !~ /^(?:\*\.)?(?:[0-9a-z_.-]+|@)$/) {
1549 # Don't mention @, because it would be far too wordy to explain the nuance of @
1550 $errstr = "Hostnames may not contain anything other than (0-9 a-z . _)";
1551 return;
1552 }
1553 }
1554 return 1;
1555} # _check_hostname_form()
1556
1557
1558##
1559## Initialization and cleanup subs
1560##
1561
1562## DNSDB::__cfgload()
1563# Private sub to parse a config file and load it into %config
1564# Takes a filename and a hashref to put the parsed entries in
1565sub __cfgload {
1566 $errstr = '';
1567 my $cfgfile = shift;
1568 my $cfg = shift;
1569
1570 if (open CFG, "<$cfgfile") {
1571 while (<CFG>) {
1572 chomp;
1573 s/^\s*//;
1574 next if /^#/;
1575 next if /^$/;
1576# hmm. more complex bits in this file might require [heading] headers, maybe?
1577# $mode = $1 if /^\[(a-z)+]/;
1578 # DB connect info
1579 $cfg->{dbname} = $1 if /^dbname\s*=\s*([a-z0-9_.-]+)/i;
1580 $cfg->{dbuser} = $1 if /^dbuser\s*=\s*([a-z0-9_.-]+)/i;
1581 $cfg->{dbpass} = $1 if /^dbpass\s*=\s*([a-z0-9_.-]+)/i;
1582 $cfg->{dbhost} = $1 if /^dbhost\s*=\s*([a-z0-9_.-]+)/i;
1583 # Mail settings
1584 $cfg->{mailhost} = $1 if /^mailhost\s*=\s*([a-z0-9_.-]+)/i;
1585 $cfg->{mailnotify} = $1 if /^mailnotify\s*=\s*([a-z0-9_.\@-]+)/i;
1586 $cfg->{mailsender} = $1 if /^mailsender\s*=\s*([a-z0-9_.\@-]+)/i;
1587 $cfg->{mailname} = $1 if /^mailname\s*=\s*([a-z0-9\s_.-]+)/i;
1588 $cfg->{orgname} = $1 if /^orgname\s*=\s*([a-z0-9\s_.,'-]+)/i;
1589 $cfg->{domain} = $1 if /^domain\s*=\s*([a-z0-9_.-]+)/i;
1590 # session - note this is fed directly to CGI::Session
1591 $cfg->{timeout} = $1 if /^[tT][iI][mM][eE][oO][uU][tT]\s*=\s*(\d+[smhdwMy]?)/;
1592 $cfg->{sessiondir} = $1 if m{^sessiondir\s*=\s*([a-z0-9/_.-]+)}i;
1593 # misc
1594 $cfg->{log_failures} = $1 if /^log_failures\s*=\s*([a-z01]+)/i;
1595 $cfg->{perpage} = $1 if /^perpage\s*=\s*(\d+)/i;
1596 $cfg->{exportcache} = $1 if m{^exportcache\s*=\s*([a-z0-9/_.-]+)}i;
1597 $cfg->{usecache} = $1 if m{^usecache\s*=\s*([a-z01]+)}i;
1598 $cfg->{force_refresh} = $1 if /^force_refresh\s*=\s*([a-z01]+)/i;
1599 $cfg->{lowercase} = $1 if /^lowercase\s*=\s*([a-z01]+)/i;
1600 $cfg->{showrev_arpa} = $1 if /^showrev_arpa\s*=\s*([a-z]+)/i;
1601# not supported in dns.cgi yet
1602# $cfg->{templatedir} = $1 if m{^templatedir\s*=\s*([a-z0-9/_.-]+)}i;
1603# $cfg->{templateoverride} = $1 if m{^templateoverride\s*=\s*([a-z0-9/_.-]+)}i;
1604 # RPC options
1605 $cfg->{rpcmode} = $1 if /^rpc_mode\s*=\s*(socket|HTTP|XMLRPC)\s*$/i;
1606 $cfg->{maxfcgi} = $1 if /^max_fcgi_requests\s*=\s*(\d+)\s*$/i;
1607 if (my ($tmp) = /^rpc_iplist\s*=\s*(.+)/i) {
1608 my @ips = split /[,\s]+/, $tmp;
1609 my $rpcsys = shift @ips;
1610 push @{$cfg->{rpcacl}{$rpcsys}}, @ips;
1611 }
1612 }
1613 close CFG;
1614 } else {
1615 $errstr = "Couldn't load configuration file $cfgfile: $!";
1616 return;
1617 }
1618 return 1;
1619} # end __cfgload()
1620
1621
1622## DNSDB::connectDB()
1623# Creates connection to DNS database.
1624# Requires the database name, username, and password.
1625# Returns a handle to the db or undef on failure.
1626# Set up for a PostgreSQL db; could be any transactional DBMS with the
1627# right changes.
1628# Called by new(); not intended to be called publicly.
1629sub connectDB {
1630 $errstr = '';
1631 my $dbname = shift;
1632 my $user = shift;
1633 my $pass = shift;
1634 my $dbh;
1635 my $DSN = "DBI:Pg:dbname=$dbname";
1636
1637 my $host = shift;
1638 $DSN .= ";host=$host" if $host;
1639
1640# Note that we want to autocommit by default, and we will turn it off locally as necessary.
1641# We may not want to print gobbledygook errors; YMMV. Have to ponder that further.
1642 $dbh = DBI->connect($DSN, $user, $pass, {
1643 AutoCommit => 1,
1644 PrintError => 0
1645 });
1646 if (!$dbh) {
1647 $errstr = $DBI::errstr;
1648 return;
1649 }
1650#) if(!$dbh);
1651
1652 local $dbh->{RaiseError} = 1;
1653
1654 eval {
1655##fixme: initialize the DB if we can't find the table (since, by definition, there's
1656# nothing there if we can't select from it...)
1657 my $tblsth = $dbh->prepare("SELECT count(*) FROM pg_catalog.pg_class WHERE relkind='r' AND relname=?");
1658 my ($tblcount) = $dbh->selectrow_array($tblsth, undef, ('misc'));
1659# return (undef,$DBI::errstr) if $dbh->err;
1660
1661#if ($tblcount == 0) {
1662# # create tables one at a time, checking for each.
1663# return (undef, "check table misc missing");
1664#}
1665
1666# Return here if we can't select.
1667# This should retrieve the dbversion key.
1668 my $sth = $dbh->prepare("SELECT key,value FROM misc WHERE misc_id=1");
1669 $sth->execute();
1670# return (undef,$DBI::errstr) if ($sth->err);
1671
1672##fixme: do stuff to the DB on version mismatch
1673# x.y series should upgrade on $DNSDB::VERSION > misc(key=>version)
1674# DB should be downward-compatible; column defaults should give sane (if possibly
1675# useless-and-needs-help) values in columns an older software stack doesn't know about.
1676
1677# See if the select returned anything (or null data). This should
1678# succeed if the select executed, but...
1679 $sth->fetchrow();
1680# return (undef,$DBI::errstr) if ($sth->err);
1681
1682 $sth->finish;
1683
1684 }; # wrapped DB checks
1685 if ($@) {
1686 $errstr = $@;
1687 return;
1688 }
1689
1690# If we get here, we should be OK.
1691 return $dbh;
1692} # end connectDB
1693
1694
1695## DNSDB::finish()
1696# Cleans up after database handles and so on.
1697# Requires a database handle
1698sub finish {
1699 my $self = shift;
1700 $self->{dbh}->disconnect;
1701} # end finish
1702
1703
1704## DNSDB::initGlobals()
1705# Initialize global variables
1706# NB: this does NOT include web-specific session variables!
1707sub initGlobals {
1708 my $self = shift;
1709 my $dbh = $self->{dbh};
1710
1711# load record types from database
1712 my $sth = $dbh->prepare("SELECT val,name,stdflag FROM rectypes");
1713 $sth->execute;
1714 while (my ($recval,$recname,$stdflag) = $sth->fetchrow_array()) {
1715 $typemap{$recval} = $recname;
1716 $reverse_typemap{$recname} = $recval;
1717 # now we fill the record validation function hash
1718 if ($stdflag < 5) {
1719 my $fn = "_validate_$recval";
1720 $validators{$recval} = \&$fn;
1721 } else {
1722 my $fn = "sub { return ('FAIL','Type $recval ($recname) not supported'); }";
1723 $validators{$recval} = eval $fn;
1724 }
1725 }
1726} # end initGlobals
1727
1728
1729## DNSDB::initRPC()
1730# Takes a remote username and remote fullname.
1731# Sets up the RPC logging-pseudouser if needed.
1732# Sets the %userdata hash for logging.
1733# Returns undef on failure
1734sub initRPC {
1735 my $self = shift;
1736 my $dbh = $self->{dbh};
1737 my %args = @_;
1738
1739 return if !$args{username};
1740 return if !$args{fullname};
1741
1742 $args{username} = "$args{username}/$args{rpcsys}";
1743
1744 my $tmpuser = $dbh->selectrow_hashref("SELECT username,user_id AS userid,group_id,firstname,lastname,status".
1745 " FROM users WHERE username=?", undef, ($args{username}) );
1746 if (!$tmpuser) {
1747 $dbh->do("INSERT INTO users (username,password,firstname,type) VALUES (?,'RPC',?,'R')", undef,
1748 ($args{username}, $args{fullname}) );
1749 $tmpuser = $dbh->selectrow_hashref("SELECT username,user_id AS userid,group_id,firstname,lastname,status".
1750 " FROM users WHERE username=?", undef, ($args{username}) );
1751 }
1752 $tmpuser->{lastname} = '' if !$tmpuser->{lastname};
1753 $self->{loguserid} = $tmpuser->{userid};
1754 $self->{logusername} = $tmpuser->{username};
1755 $self->{logfullname} = "$tmpuser->{firstname} $tmpuser->{lastname} ($args{rpcsys})";
1756 return 1 if $tmpuser;
1757} # end initRPC()
1758
1759
1760## DNSDB::login()
1761# Takes a database handle, username and password
1762# Returns a userdata hash (UID, GID, username, fullname parts) if username exists,
1763# password matches the one on file, and account is not disabled
1764# Returns undef otherwise
1765sub login {
1766 my $self = shift;
1767 my $dbh = $self->{dbh};
1768 my $user = shift;
1769 my $pass = shift;
1770
1771 my $userinfo = $dbh->selectrow_hashref("SELECT user_id,group_id,password,firstname,lastname,status".
1772 " FROM users WHERE username=?",
1773 undef, ($user) );
1774 return if !$userinfo;
1775 return if !$userinfo->{status};
1776
1777 if ($userinfo->{password} =~ m|^\$1\$([A-Za-z0-9/.]+)\$|) {
1778 # native passwords (crypt-md5)
1779 return if $userinfo->{password} ne unix_md5_crypt($pass,$1);
1780 } elsif ($userinfo->{password} =~ /^[0-9a-f]{32}$/) {
1781 # VegaDNS import (hex-coded MD5)
1782 return if $userinfo->{password} ne md5_hex($pass);
1783 } else {
1784 # plaintext (convenient now and then)
1785 return if $userinfo->{password} ne $pass;
1786 }
1787
1788 return $userinfo;
1789} # end login()
1790
1791
1792## DNSDB::initActionLog()
1793# Set up action logging. Takes a database handle and user ID
1794# Sets some internal globals and Does The Right Thing to set up a logging channel.
1795# This sets up _log() to spew out log entries to the defined channel without worrying
1796# about having to open a file or a syslog channel
1797##fixme Need to call _initActionLog_blah() for various logging channels, configured
1798# via dnsdb.conf, in $self->{log_channel} or something
1799# See https://secure.deepnet.cx/trac/dnsadmin/ticket/21
1800sub initActionLog {
1801 my $self = shift;
1802 my $dbh = $self->{dbh};
1803 my $uid = shift;
1804
1805 return if !$uid;
1806
1807 # snag user info for logging. there's got to be a way to not have to pass this back
1808 # and forth from a caller, but web usage means no persistence we can rely on from
1809 # the server side.
1810 my ($username,$fullname) = $dbh->selectrow_array("SELECT username, firstname || ' ' || lastname".
1811 " FROM users WHERE user_id=?", undef, ($uid));
1812##fixme: errors are unpossible!
1813
1814 $self->{logusername} = $username;
1815 $self->{loguserid} = $uid;
1816 $self->{logfullname} = $fullname;
1817
1818 # convert to real check once we have other logging channels
1819 # if ($self->{log_channel} eq 'sql') {
1820 # Open Log, Sez Me!
1821 # }
1822
1823} # end initActionLog
1824
1825
1826## DNSDB::getPermissions()
1827# Get permissions from DB
1828# Requires DB handle, group or user flag, ID, and hashref.
1829sub getPermissions {
1830 my $self = shift;
1831 my $dbh = $self->{dbh};
1832
1833 my $type = shift;
1834 my $id = shift;
1835 my $hash = shift;
1836
1837 my $sql = qq(
1838 SELECT
1839 p.admin,p.self_edit,
1840 p.group_create,p.group_edit,p.group_delete,
1841 p.user_create,p.user_edit,p.user_delete,
1842 p.domain_create,p.domain_edit,p.domain_delete,
1843 p.record_create,p.record_edit,p.record_delete,p.record_locchg,
1844 p.location_create,p.location_edit,p.location_delete,p.location_view
1845 FROM permissions p
1846 );
1847 if ($type eq 'group') {
1848 $sql .= qq(
1849 JOIN groups g ON g.permission_id=p.permission_id
1850 WHERE g.group_id=?
1851 );
1852 } else {
1853 $sql .= qq(
1854 JOIN users u ON u.permission_id=p.permission_id
1855 WHERE u.user_id=?
1856 );
1857 }
1858
1859 my $sth = $dbh->prepare($sql);
1860
1861##fixme? we don't trap other plain SELECT errors
1862 $sth->execute($id);
1863
1864# my $permref = $sth->fetchrow_hashref;
1865# return $permref;
1866# $hash = $permref;
1867# Eww. Need to learn how to forcibly drop a hashref onto an existing hash.
1868 ($hash->{admin},$hash->{self_edit},
1869 $hash->{group_create},$hash->{group_edit},$hash->{group_delete},
1870 $hash->{user_create},$hash->{user_edit},$hash->{user_delete},
1871 $hash->{domain_create},$hash->{domain_edit},$hash->{domain_delete},
1872 $hash->{record_create},$hash->{record_edit},$hash->{record_delete},$hash->{record_locchg},
1873 $hash->{location_create},$hash->{location_edit},$hash->{location_delete},$hash->{location_view}
1874 ) = $sth->fetchrow_array;
1875
1876} # end getPermissions()
1877
1878
1879## DNSDB::changePermissions()
1880# Update an ACL entry
1881# Takes a db handle, type, owner-id, and hashref for the changed permissions.
1882sub changePermissions {
1883 my $self = shift;
1884 my $dbh = $self->{dbh};
1885 my $type = shift;
1886 my $id = shift;
1887 my $newperms = shift;
1888 my $inherit = shift || 0;
1889
1890 my $resultmsg = '';
1891
1892 # see if we're switching from inherited to custom. for bonus points,
1893 # snag the permid and parent permid anyway, since we'll need the permid
1894 # to set/alter custom perms, and both if we're switching from custom to
1895 # inherited.
1896 my $sth = $dbh->prepare("SELECT (u.permission_id=g.permission_id) AS was_inherited,u.permission_id,g.permission_id,".
1897 ($type eq 'user' ? 'u.group_id,u.username' : 'u.parent_group_id,u.group_name').
1898 " FROM ".($type eq 'user' ? 'users' : 'groups')." u ".
1899 " JOIN groups g ON u.".($type eq 'user' ? '' : 'parent_')."group_id=g.group_id ".
1900 " WHERE u.".($type eq 'user' ? 'user' : 'group')."_id=?");
1901 $sth->execute($id);
1902
1903 my ($wasinherited,$permid,$parpermid,$parid,$name) = $sth->fetchrow_array;
1904
1905# hack phtoui
1906# group id 1 is "special" in that it's it's own parent (err... possibly.)
1907# may make its parent id 0 which doesn't exist, and as a bonus is Perl-false.
1908 $wasinherited = 0 if ($type eq 'group' && $id == 1);
1909
1910 local $dbh->{AutoCommit} = 0;
1911 local $dbh->{RaiseError} = 1;
1912
1913 # Wrap all the SQL in a transaction
1914 eval {
1915 if ($inherit) {
1916
1917 $dbh->do("UPDATE ".($type eq 'user' ? 'users' : 'groups')." SET inherit_perm='t',permission_id=? ".
1918 "WHERE ".($type eq 'user' ? 'user' : 'group')."_id=?", undef, ($parpermid, $id) );
1919 $dbh->do("DELETE FROM permissions WHERE permission_id=?", undef, ($permid) );
1920
1921 } else {
1922
1923 if ($wasinherited) { # munge new permission entry in if we're switching from inherited perms
1924##fixme: need to add semirecursive bit to properly munge inherited permission ID on subgroups and users
1925# ... if'n'when we have groups with fully inherited permissions.
1926 # SQL is coo
1927 $dbh->do("INSERT INTO permissions ($permlist,".($type eq 'user' ? 'user' : 'group')."_id) ".
1928 "SELECT $permlist,? FROM permissions WHERE permission_id=?", undef, ($id,$permid) );
1929 ($permid) = $dbh->selectrow_array("SELECT permission_id FROM permissions ".
1930 "WHERE ".($type eq 'user' ? 'user' : 'group')."_id=?", undef, ($id) );
1931 $dbh->do("UPDATE ".($type eq 'user' ? 'users' : 'groups')." SET inherit_perm='f',permission_id=? ".
1932 "WHERE ".($type eq 'user' ? 'user' : 'group')."_id=?", undef, ($permid, $id) );
1933 }
1934
1935 # and now set the permissions we were passed
1936 foreach (@permtypes) {
1937 if (defined ($newperms->{$_})) {
1938 $dbh->do("UPDATE permissions SET $_=? WHERE permission_id=?", undef, ($newperms->{$_},$permid) );
1939 }
1940 }
1941
1942 } # (inherited->)? custom
1943
1944 if ($type eq 'user') {
1945 $resultmsg = "Updated permissions for user $name";
1946 } else {
1947 $resultmsg = "Updated default permissions for group $name";
1948 }
1949 $self->_log(group_id => ($type eq 'user' ? $parid : $id), entry => $resultmsg);
1950 $dbh->commit;
1951 }; # end eval
1952 if ($@) {
1953 my $msg = $@;
1954 eval { $dbh->rollback; };
1955 return ('FAIL',"Error changing permissions: $msg");
1956 }
1957
1958 return ('OK',$resultmsg);
1959} # end changePermissions()
1960
1961
1962## DNSDB::comparePermissions()
1963# Compare two permission hashes
1964# Returns '>', '<', '=', '!'
1965sub comparePermissions {
1966 my $self = shift;
1967 my $p1 = shift;
1968 my $p2 = shift;
1969
1970 my $retval = '='; # assume equality until proven otherwise
1971
1972 no warnings "uninitialized";
1973
1974 foreach (@permtypes) {
1975 next if $p1->{$_} == $p2->{$_}; # equal is good
1976 if ($p1->{$_} && !$p2->{$_}) {
1977 if ($retval eq '<') { # if we've already found an unequal pair where
1978 $retval = '!'; # $p2 has more access, and we now find a pair
1979 last; # where $p1 has more access, the overall access
1980 } # is neither greater or lesser, it's unequal.
1981 $retval = '>';
1982 }
1983 if (!$p1->{$_} && $p2->{$_}) {
1984 if ($retval eq '>') { # if we've already found an unequal pair where
1985 $retval = '!'; # $p1 has more access, and we now find a pair
1986 last; # where $p2 has more access, the overall access
1987 } # is neither greater or lesser, it's unequal.
1988 $retval = '<';
1989 }
1990 }
1991 return $retval;
1992} # end comparePermissions()
1993
1994
1995## DNSDB::changeGroup()
1996# Change group ID of an entity
1997# Takes a database handle, entity type, entity ID, and new group ID
1998sub changeGroup {
1999 my $self = shift;
2000 my $dbh = $self->{dbh};
2001 my $type = shift;
2002 my $id = shift;
2003 my $newgrp = shift;
2004
2005##fixme: fail on not enough args
2006 #return ('FAIL', "Missing
2007
2008 return ('FAIL', "Can't change the group of a $type")
2009 unless grep /^$type$/, ('domain','revzone','user','group'); # could be extended for defrecs?
2010
2011 # Collect some names for logging and messages
2012 my $entname;
2013 if ($type eq 'domain') {
2014 $entname = $self->domainName($id);
2015 } elsif ($type eq 'revzone') {
2016 $entname = $self->revName($id);
2017 } elsif ($type eq 'user') {
2018 $entname = $self->userFullName($id, '%u');
2019 } elsif ($type eq 'group') {
2020 $entname = $self->groupName($id);
2021 }
2022
2023 my ($oldgid) = $dbh->selectrow_array("SELECT group_id FROM $par_tbl{$type} WHERE $id_col{$type}=?",
2024 undef, ($id));
2025 my $oldgname = $self->groupName($oldgid);
2026 my $newgname = $self->groupName($newgrp);
2027
2028 return ('FAIL', "Can't move things into a group that doesn't exist") if !$newgname;
2029
2030 return ('WARN', "Nothing to do, new group is the same as the old group") if $oldgid == $newgrp;
2031
2032 # Allow transactions, and raise an exception on errors so we can catch it later.
2033 # Use local to make sure these get "reset" properly on exiting this block
2034 local $dbh->{AutoCommit} = 0;
2035 local $dbh->{RaiseError} = 1;
2036
2037 eval {
2038 $dbh->do("UPDATE $par_tbl{$type} SET group_id=? WHERE $id_col{$type}=?", undef, ($newgrp, $id));
2039 # Log the change in both the old and new groups
2040 $self->_log(group_id => $oldgid, entry => "Moved $type $entname from $oldgname to $newgname");
2041 $self->_log(group_id => $newgrp, entry => "Moved $type $entname from $oldgname to $newgname");
2042 $dbh->commit;
2043 };
2044 if ($@) {
2045 my $msg = $@;
2046 eval { $dbh->rollback; };
2047 if ($self->{log_failures}) {
2048 $self->_log(group_id => $oldgid, entry => "Error moving $type $entname to $newgname: $msg");
2049 $dbh->commit; # since we enabled transactions earlier
2050 }
2051 return ('FAIL',"Error moving $type $entname to $newgname: $msg");
2052 }
2053
2054 return ('OK',"Moved $type $entname from $oldgname to $newgname");
2055} # end changeGroup()
2056
2057
2058##
2059## Processing subs
2060##
2061
2062## DNSDB::addDomain()
2063# Add a domain
2064# Takes a database handle, domain name, numeric group, boolean(ish) state (active/inactive),
2065# and user info hash (for logging).
2066# Returns a status code and message
2067sub addDomain {
2068 $errstr = '';
2069 my $self = shift;
2070 my $dbh = $self->{dbh};
2071 my $domain = shift;
2072 return ('FAIL',"Domain must not be blank\n") if !$domain;
2073 my $group = shift;
2074 return ('FAIL',"Group must be specified\n") if !defined($group);
2075 my $state = shift;
2076 return ('FAIL',"Domain status must be specified\n") if !defined($state);
2077 my $defloc = shift || '';
2078
2079 $state = 1 if $state =~ /^active$/;
2080 $state = 1 if $state =~ /^on$/;
2081 $state = 0 if $state =~ /^inactive$/;
2082 $state = 0 if $state =~ /^off$/;
2083
2084 return ('FAIL',"Invalid domain status") if $state !~ /^\d+$/;
2085
2086 $domain = lc($domain) if $self->{lowercase};
2087
2088 return ('FAIL', "Invalid characters in domain") if $domain !~ /^[a-zA-Z0-9_.-]+$/;
2089
2090 my $sth = $dbh->prepare("SELECT domain_id FROM domains WHERE lower(domain) = lower(?)");
2091 my $dom_id;
2092
2093# quick check to start to see if we've already got one
2094 $sth->execute($domain);
2095 ($dom_id) = $sth->fetchrow_array;
2096
2097 return ('FAIL', "Domain already exists") if $dom_id;
2098
2099 # Allow transactions, and raise an exception on errors so we can catch it later.
2100 # Use local to make sure these get "reset" properly on exiting this block
2101 local $dbh->{AutoCommit} = 0;
2102 local $dbh->{RaiseError} = 1;
2103
2104 # Wrap all the SQL in a transaction
2105 eval {
2106 # insert the domain...
2107 $dbh->do("INSERT INTO domains (domain,group_id,status,default_location) VALUES (?,?,?,?)", undef,
2108 ($domain, $group, $state, $defloc));
2109
2110 # get the ID...
2111 ($dom_id) = $dbh->selectrow_array("SELECT domain_id FROM domains WHERE lower(domain) = lower(?)",
2112 undef, ($domain));
2113
2114 $self->_log(domain_id => $dom_id, group_id => $group,
2115 entry => "Added ".($state ? 'active' : 'inactive')." domain $domain");
2116
2117 # ... and now we construct the standard records from the default set. NB: group should be variable.
2118 my $sth = $dbh->prepare("SELECT host,type,val,distance,weight,port,ttl FROM default_records WHERE group_id=?");
2119 my $sth_in = $dbh->prepare("INSERT INTO records (domain_id,host,type,val,distance,weight,port,ttl,location)".
2120 " VALUES ($dom_id,?,?,?,?,?,?,?,?)");
2121 $sth->execute($group);
2122 while (my ($host, $type, $val, $dist, $weight, $port, $ttl) = $sth->fetchrow_array()) {
2123 $host =~ s/DOMAIN/$domain/g;
2124 $val =~ s/DOMAIN/$domain/g;
2125 _caseclean(\$type, \$host, \$val, 'n', 'n') if $self->{lowercase};
2126 $sth_in->execute($host, $type, $val, $dist, $weight, $port, $ttl, $defloc);
2127 if ($typemap{$type} eq 'SOA') {
2128 my @tmp1 = split /:/, $host;
2129 my @tmp2 = split /:/, $val;
2130 $self->_log(domain_id => $dom_id, group_id => $group,
2131 entry => "[new $domain] Added SOA record [contact $tmp1[0]] [master $tmp1[1]] ".
2132 "[refresh $tmp2[0]] [retry $tmp2[1]] [expire $tmp2[2]] [minttl $tmp2[3]], TTL $ttl");
2133 } else {
2134 my $logentry = "[new $domain] Added record '$host $typemap{$type}";
2135 $logentry .= " [distance $dist]" if $typemap{$type} eq 'MX';
2136 $logentry .= " [priority $dist] [weight $weight] [port $port]" if $typemap{$type} eq 'SRV';
2137 $self->_log(domain_id => $dom_id, group_id => $group,
2138 entry => $logentry." $val', TTL $ttl");
2139 }
2140 }
2141
2142 # once we get here, we should have suceeded.
2143 $dbh->commit;
2144 }; # end eval
2145
2146 if ($@) {
2147 my $msg = $@;
2148 eval { $dbh->rollback; };
2149 $self->_log(group_id => $group, entry => "Failed adding domain $domain ($msg)")
2150 if $self->{log_failures};
2151 $dbh->commit; # since we enabled transactions earlier
2152 return ('FAIL',$msg);
2153 } else {
2154 return ('OK',$dom_id);
2155 }
2156} # end addDomain
2157
2158
2159## DNSDB::delZone()
2160# Delete a forward or reverse zone.
2161# Takes a database handle, zone ID, and forward/reverse flag.
2162# for now, just delete the records, then the domain.
2163# later we may want to archive it in some way instead (status code 2, for example?)
2164sub delZone {
2165 my $self = shift;
2166 my $dbh = $self->{dbh};
2167 my $zoneid = shift;
2168 my $revrec = shift;
2169
2170 # Allow transactions, and raise an exception on errors so we can catch it later.
2171 # Use local to make sure these get "reset" properly on exiting this block
2172 local $dbh->{AutoCommit} = 0;
2173 local $dbh->{RaiseError} = 1;
2174
2175 my $msg = '';
2176 my $failmsg = '';
2177 my $zone = ($revrec eq 'n' ? $self->domainName($zoneid) : $self->revName($zoneid));
2178
2179 return ('FAIL', ($revrec eq 'n' ? 'Domain' : 'Reverse zone')." ID $zoneid doesn't exist") if !$zone;
2180
2181 # Set this up here since we may use if if $self->{log_failures} is enabled
2182 my %loghash;
2183 $loghash{domain_id} = $zoneid if $revrec eq 'n';
2184 $loghash{rdns_id} = $zoneid if $revrec eq 'y';
2185 $loghash{group_id} = $self->parentID(
2186 id => $zoneid, type => ($revrec eq 'n' ? 'domain' : 'revzone'), revrec => $revrec);
2187
2188 # Wrap all the SQL in a transaction
2189 eval {
2190 # Disentangle custom record types before removing the
2191 # ones that are only in the zone to be deleted
2192 if ($revrec eq 'n') {
2193 my $sth = $dbh->prepare("UPDATE records SET type=?,domain_id=0 WHERE domain_id=? AND type=?");
2194 $failmsg = "Failure converting multizone types to single-zone";
2195 $sth->execute($reverse_typemap{PTR}, $zoneid, 65280);
2196 $sth->execute($reverse_typemap{PTR}, $zoneid, 65281);
2197 $sth->execute(65282, $zoneid, 65283);
2198 $sth->execute(65282, $zoneid, 65284);
2199 $failmsg = "Failure removing domain records";
2200 $dbh->do("DELETE FROM records WHERE domain_id=?", undef, ($zoneid));
2201 $failmsg = "Failure removing domain";
2202 $dbh->do("DELETE FROM domains WHERE domain_id=?", undef, ($zoneid));
2203 } else {
2204 my $sth = $dbh->prepare("UPDATE records SET type=?,rdns_id=0 WHERE rdns_id=? AND type=?");
2205 $failmsg = "Failure converting multizone types to single-zone";
2206 $sth->execute($reverse_typemap{A}, $zoneid, 65280);
2207 $sth->execute($reverse_typemap{AAAA}, $zoneid, 65281);
2208# We don't have an "A template" or "AAAA template" type, although it might be useful for symmetry.
2209# $sth->execute(65286?, $zoneid, 65283);
2210# $sth->execute(65286?, $zoneid, 65284);
2211 $failmsg = "Failure removing reverse records";
2212 $dbh->do("DELETE FROM records WHERE rdns_id=?", undef, ($zoneid));
2213 $failmsg = "Failure removing reverse zone";
2214 $dbh->do("DELETE FROM revzones WHERE rdns_id=?", undef, ($zoneid));
2215 }
2216
2217 $msg = "Deleted ".($revrec eq 'n' ? 'domain' : 'reverse zone')." $zone";
2218 $loghash{entry} = $msg;
2219 $self->_log(%loghash);
2220
2221 # once we get here, we should have suceeded.
2222 $dbh->commit;
2223 }; # end eval
2224
2225 if ($@) {
2226 $msg = $@;
2227 eval { $dbh->rollback; };
2228 $loghash{entry} = "Error deleting $zone: $msg ($failmsg)";
2229 if ($self->{log_failures}) {
2230 $self->_log(%loghash);
2231 $dbh->commit; # since we enabled transactions earlier
2232 }
2233 return ('FAIL', $loghash{entry});
2234 } else {
2235 return ('OK', $msg);
2236 }
2237
2238} # end delZone()
2239
2240
2241## DNSDB::domainName()
2242# Return the domain name based on a domain ID
2243# Takes a database handle and the domain ID
2244# Returns the domain name or undef on failure
2245sub domainName {
2246 $errstr = '';
2247 my $self = shift;
2248 my $dbh = $self->{dbh};
2249 my $domid = shift;
2250 my ($domname) = $dbh->selectrow_array("SELECT domain FROM domains WHERE domain_id=?", undef, ($domid) );
2251 $errstr = $DBI::errstr if !$domname;
2252 return $domname if $domname;
2253} # end domainName()
2254
2255
2256## DNSDB::revName()
2257# Return the reverse zone name based on an rDNS ID
2258# Takes a database handle and the rDNS ID, and an optional flag to force return of the CIDR zone
2259# instead of the formal .arpa zone name
2260# Returns the reverse zone name or undef on failure
2261sub revName {
2262 $errstr = '';
2263 my $self = shift;
2264 my $dbh = $self->{dbh};
2265 my $revid = shift;
2266 my $cidrflag = shift || 'n';
2267 my ($revname) = $dbh->selectrow_array("SELECT revnet FROM revzones WHERE rdns_id=?", undef, ($revid) );
2268 $errstr = $DBI::errstr if !$revname;
2269 my $tmp = new NetAddr::IP $revname;
2270 $revname = _ZONE($tmp, 'ZONE', 'r', '.').($tmp->{isv6} ? '.ip6.arpa' : '.in-addr.arpa')
2271 if ($self->{showrev_arpa} eq 'zone' || $self->{showrev_arpa} eq 'all') && $cidrflag eq 'n';
2272 return $revname if $revname;
2273} # end revName()
2274
2275
2276## DNSDB::domainID()
2277# Takes a database handle and domain name
2278# Returns the domain ID number
2279sub domainID {
2280 $errstr = '';
2281 my $self = shift;
2282 my $dbh = $self->{dbh};
2283 my $domain = shift;
2284 my ($domid) = $dbh->selectrow_array("SELECT domain_id FROM domains WHERE lower(domain) = lower(?)",
2285 undef, ($domain) );
2286 if (!$domid) {
2287 if ($dbh->err) {
2288 $errstr = $DBI::errstr;
2289 } else {
2290 $errstr = "Domain $domain not present";
2291 }
2292 }
2293 return $domid if $domid;
2294} # end domainID()
2295
2296
2297## DNSDB::revID()
2298# Takes a database handle and reverse zone name
2299# Returns the rDNS ID number
2300sub revID {
2301 $errstr = '';
2302 my $self = shift;
2303 my $dbh = $self->{dbh};
2304 my $revzone = shift;
2305 my ($revid) = $dbh->selectrow_array("SELECT rdns_id FROM revzones WHERE revnet=?", undef, ($revzone) );
2306 if (!$revid) {
2307 if ($dbh->err) {
2308 $errstr = $DBI::errstr;
2309 } else {
2310 $errstr = "Reverse zone $revzone not present";
2311 }
2312 }
2313 return $revid if $revid;
2314} # end revID()
2315
2316
2317## DNSDB::addRDNS
2318# Adds a reverse DNS zone
2319# Takes a database handle, CIDR block, reverse DNS pattern, numeric group,
2320# and boolean(ish) state (active/inactive)
2321# Returns a status code and message
2322sub addRDNS {
2323 my $self = shift;
2324 my $dbh = $self->{dbh};
2325 my $zone = shift;
2326
2327 # Autodetect formal .arpa zones
2328 if ($zone =~ /\.arpa\.?$/) {
2329 my $code;
2330 ($code,$zone) = _zone2cidr($zone);
2331 return ('FAIL', $zone) if $code eq 'FAIL';
2332 }
2333 $zone = NetAddr::IP->new($zone);
2334
2335 return ('FAIL',"Zone name must be a valid CIDR netblock") unless ($zone && $zone->addr !~ /^0/);
2336 my $revpatt = shift; # construct a custom (A/AAAA+)? PTR template record
2337 my $group = shift;
2338 my $state = shift;
2339 my $defloc = shift || '';
2340
2341 $state = 1 if $state =~ /^active$/;
2342 $state = 1 if $state =~ /^on$/;
2343 $state = 0 if $state =~ /^inactive$/;
2344 $state = 0 if $state =~ /^off$/;
2345
2346 return ('FAIL',"Invalid zone status") if $state !~ /^\d+$/;
2347
2348# quick check to start to see if we've already got one
2349 my ($rdns_id) = $dbh->selectrow_array("SELECT rdns_id FROM revzones WHERE revnet=?", undef, ("$zone"));
2350
2351 return ('FAIL', "Zone already exists") if $rdns_id;
2352
2353 # Allow transactions, and raise an exception on errors so we can catch it later.
2354 # Use local to make sure these get "reset" properly on exiting this block
2355 local $dbh->{AutoCommit} = 0;
2356 local $dbh->{RaiseError} = 1;
2357
2358 my $warnstr = '';
2359 my $defttl = 3600; # 1 hour should be reasonable. And unless things have gone horribly
2360 # wrong, we should have a value to override this anyway.
2361
2362 # Wrap all the SQL in a transaction
2363 eval {
2364 # insert the zone...
2365 $dbh->do("INSERT INTO revzones (revnet,group_id,status,default_location) VALUES (?,?,?,?)", undef,
2366 ($zone, $group, $state, $defloc) );
2367
2368 # get the ID...
2369 ($rdns_id) = $dbh->selectrow_array("SELECT currval('revzones_rdns_id_seq')");
2370
2371 $self->_log(rdns_id => $rdns_id, group_id => $group,
2372 entry => "Added ".($state ? 'active' : 'inactive')." reverse zone $zone");
2373
2374 # ... and now we construct the standard records from the default set. NB: group should be variable.
2375 my $sth = $dbh->prepare("SELECT host,type,val,ttl FROM default_rev_records WHERE group_id=?");
2376 my $sth_in = $dbh->prepare("INSERT INTO records (rdns_id,domain_id,host,type,val,ttl,location)".
2377 " VALUES ($rdns_id,?,?,?,?,?,?)");
2378 $sth->execute($group);
2379 while (my ($host,$type,$val,$ttl) = $sth->fetchrow_array()) {
2380 # Silently skip v4/v6 mismatches. This is not an error, this is expected.
2381 if ($zone->{isv6}) {
2382 next if ($type == 65280 || $type == 65283);
2383 } else {
2384 next if ($type == 65281 || $type == 65284);
2385 }
2386
2387 $host =~ s/ADMINDOMAIN/$self->{domain}/g;
2388
2389 # Check to make sure the IP stubs will fit in the zone. Under most usage failures here should be rare.
2390 # On failure, tack a note on to a warning string and continue without adding this record.
2391 # While we're at it, we substitute $zone for ZONE in the value.
2392 if ($val eq 'ZONE') {
2393 # If we've got a pattern, we skip the default record version on (A+)PTR-template types
2394 next if $revpatt && ($type == 65282 || $type == 65283);
2395##fixme? do we care if we have multiple whole-zone templates?
2396 $val = $zone->network;
2397 } elsif ($val =~ /ZONE/) {
2398 my $tmpval = $val;
2399 $tmpval =~ s/ZONE//;
2400 # Bend the rules and allow single-trailing-number PTR or PTR template records to be inserted
2401 # as either v4 or v6. May make this an off-by-default config flag
2402 # Note that the origin records that may trigger this **SHOULD** already have ZONE,\d
2403 if ($type == 12 || $type == 65282) {
2404 $tmpval =~ s/[,.]/::/ if ($tmpval =~ /^[,.]\d+$/ && $zone->{isv6});
2405 $tmpval =~ s/[,:]+/./ if ($tmpval =~ /^(?:,|::)\d+$/ && !$zone->{isv6});
2406 }
2407 my $addr;
2408 if ($self->_ipparent('n', 'y', \$tmpval, $rdns_id, \$addr)) {
2409 $val = $addr->addr;
2410 } else {
2411 $warnstr .= "\nDefault record '$val $typemap{$type} $host' doesn't fit in $zone, skipping";
2412 next;
2413 }
2414 }
2415
2416 # Substitute $zone for ZONE in the hostname, but only for non-NS records.
2417 # NS records get this substitution on the value instead.
2418 $host = _ZONE($zone, $host) if $type != 2;
2419
2420 # Fill in the forward domain ID if we can find it, otherwise:
2421 # Coerce type down to PTR or PTR template if we can't
2422 my $domid = 0;
2423 if ($type >= 65280) {
2424 if (!($domid = $self->_hostparent($host))) {
2425 $warnstr .= "\nRecord added as PTR instead of $typemap{$type}; domain not found for $host";
2426 $type = $reverse_typemap{PTR};
2427 $domid = 0; # just to be explicit.
2428 }
2429 }
2430
2431 _caseclean(\$type, \$host, \$val, 'n', 'y') if $self->{lowercase};
2432
2433 $sth_in->execute($domid,$host,$type,$val,$ttl,$defloc);
2434
2435 if ($typemap{$type} eq 'SOA') {
2436 my @tmp1 = split /:/, $host;
2437 my @tmp2 = split /:/, $val;
2438 $self->_log(rdns_id => $rdns_id, group_id => $group,
2439 entry => "[new $zone] Added SOA record [contact $tmp1[0]] [master $tmp1[1]] ".
2440 "[refresh $tmp2[0]] [retry $tmp2[1]] [expire $tmp2[2]] [minttl $tmp2[3]], TTL $ttl");
2441 $defttl = $tmp2[3];
2442 } else {
2443 my $logentry = "[new $zone] Added record '$host $typemap{$type} $val', TTL $ttl";
2444 $logentry .= ", default location ".$self->getLoc($defloc)->{description} if $defloc;
2445 $self->_log(rdns_id => $rdns_id, domain_id => $domid, group_id => $group, entry => $logentry);
2446 }
2447 }
2448
2449 # Generate record based on provided pattern.
2450 if ($revpatt) {
2451 my $host;
2452 my $type = ($zone->{isv6} ? 65284 : 65283);
2453 my $val = $zone->network;
2454
2455 # Substitute $zone for ZONE in the hostname.
2456 $host = _ZONE($zone, $revpatt);
2457
2458 my $domid = 0;
2459 if (!($domid = $self->_hostparent($host))) {
2460 $warnstr .= "\nDefault pattern added as PTR template instead of $typemap{$type}; domain not found for $host";
2461 $type = 65282;
2462 $domid = 0; # just to be explicit.
2463 }
2464
2465 $sth_in->execute($domid,$host,$type,$val,$defttl,$defloc);
2466 my $logentry = "[new $zone] Added record '$host $typemap{$type}";
2467 $self->_log(rdns_id => $rdns_id, domain_id => $domid, group_id => $group,
2468 entry => $logentry." $val', TTL $defttl from pattern");
2469 }
2470
2471 # If there are warnings (presumably about default records skipped for cause) log them
2472 $self->_log(rdns_id => $rdns_id, group_id => $group, entry => "Warning(s) adding $zone:$warnstr")
2473 if $warnstr;
2474
2475 # once we get here, we should have suceeded.
2476 $dbh->commit;
2477 }; # end eval
2478
2479 if ($@) {
2480 my $msg = $@;
2481 eval { $dbh->rollback; };
2482 $self->_log(group_id => $group, entry => "Failed adding reverse zone $zone ($msg)")
2483 if $self->{log_failures};
2484 $dbh->commit; # since we enabled transactions earlier
2485 return ('FAIL',$msg);
2486 } else {
2487 my $retcode = 'OK';
2488 if ($warnstr) {
2489 $resultstr = $warnstr;
2490 $retcode = 'WARN';
2491 }
2492 return ($retcode, $rdns_id);
2493 }
2494
2495} # end addRDNS()
2496
2497
2498## DNSDB::getZoneCount
2499# Get count of zones in group or groups
2500# Takes a database handle and hash containing:
2501# - the "current" group
2502# - an array of "acceptable" groups
2503# - a flag for forward/reverse zones
2504# - Optionally accept a "starts with" and/or "contains" filter argument
2505# Returns an integer count of the resulting zone list.
2506sub getZoneCount {
2507 my $self = shift;
2508 my $dbh = $self->{dbh};
2509
2510 my %args = @_;
2511
2512 # Fail on bad curgroup argument. There's no sane fallback on this one.
2513 if (!$args{curgroup} || $args{curgroup} !~ /^\d+$/) {
2514 $errstr = "Bad or missing curgroup argument";
2515 return;
2516 }
2517 # Fail on bad childlist argument. This could be sanely ignored if bad, maybe.
2518 if ($args{childlist} && $args{childlist} !~ /^[\d,]+$/) {
2519 $errstr = "Bad childlist argument";
2520 return;
2521 }
2522
2523 my @filterargs;
2524 $args{startwith} = undef if $args{startwith} && $args{startwith} !~ /^(?:[a-z]|0-9)$/;
2525 push @filterargs, "^$args{startwith}" if $args{startwith};
2526 $args{filter} =~ s/\./\[\.\]/g if $args{filter}; # only match literal dots, usually in reverse zones
2527 push @filterargs, $args{filter} if $args{filter};
2528
2529 my $sql;
2530 # Not as compact, and fix-me-twice if the common bits get wrong, but much easier to read
2531 if ($args{revrec} eq 'n') {
2532 $sql = "SELECT count(*) FROM domains".
2533 " WHERE group_id IN ($args{curgroup}".($args{childlist} ? ",$args{childlist}" : '').")".
2534 ($args{startwith} ? " AND domain ~* ?" : '').
2535 ($args{filter} ? " AND domain ~* ?" : '');
2536 } else {
2537 $sql = "SELECT count(*) FROM revzones".
2538 " WHERE group_id IN ($args{curgroup}".($args{childlist} ? ",$args{childlist}" : '').")".
2539 ($args{startwith} ? " AND CAST(revnet AS VARCHAR) ~* ?" : '');
2540# if ($self->{showrev_arpa} eq 'zone' || $self->{showrev_arpa} eq 'all') {
2541 # Just In Case the UI is using formal .arpa notation, and someone enters something reversed,
2542 # we want to match both the formal and natural zone name
2543 $sql .= ($args{filter} ? " AND (CAST(revnet AS VARCHAR) ~* ? OR CAST(revnet AS VARCHAR) ~* ?)" : '');
2544 push @filterargs, join('[.]',reverse(split(/\[\.\]/,$args{filter}))) if $args{filter};
2545# } else {
2546# $sql .= ($args{filter} ? " AND CAST(revnet AS VARCHAR) ~* ?" : '');
2547# }
2548 }
2549 my ($count) = $dbh->selectrow_array($sql, undef, @filterargs);
2550 return $count;
2551} # end getZoneCount()
2552
2553
2554## DNSDB::getZoneList()
2555# Get a list of zones in the specified group(s)
2556# Takes the same arguments as getZoneCount() above
2557# Returns a reference to an array of hashrefs suitable for feeding to HTML::Template
2558sub getZoneList {
2559 my $self = shift;
2560 my $dbh = $self->{dbh};
2561
2562 my %args = @_;
2563
2564 my @zonelist;
2565
2566 $args{sortorder} = 'ASC' if !$args{sortorder} || !grep /^$args{sortorder}$/, ('ASC','DESC');
2567 $args{offset} = 0 if !$args{offset} || $args{offset} !~ /^(?:all|\d+)$/;
2568
2569 # Fail on bad curgroup argument. There's no sane fallback on this one.
2570 if (!$args{curgroup} || $args{curgroup} !~ /^\d+$/) {
2571 $errstr = "Bad or missing curgroup argument";
2572 return;
2573 }
2574 # Fail on bad childlist argument. This could be sanely ignored if bad, maybe.
2575 if ($args{childlist} && $args{childlist} !~ /^[\d,]+$/) {
2576 $errstr = "Bad childlist argument";
2577 return;
2578 }
2579
2580 my @filterargs;
2581 $args{startwith} = undef if $args{startwith} && $args{startwith} !~ /^(?:[a-z]|0-9)$/;
2582 push @filterargs, "^$args{startwith}" if $args{startwith};
2583 $args{filter} =~ s/\./\[\.\]/g if $args{filter}; # only match literal dots, usually in reverse zones
2584 push @filterargs, $args{filter} if $args{filter};
2585
2586 my $sql;
2587 # Not as compact, and fix-me-twice if the common bits get wrong, but much easier to read
2588 if ($args{revrec} eq 'n') {
2589 $args{sortby} = 'domain' if !$args{sortby} || !grep /^$args{sortby}$/, ('domain','group','status');
2590 $sql = "SELECT domain_id AS zoneid,domain AS zone,status,groups.group_name AS group FROM domains".
2591 " INNER JOIN groups ON domains.group_id=groups.group_id".
2592 " WHERE domains.group_id IN ($args{curgroup}".($args{childlist} ? ",$args{childlist}" : '').")".
2593 ($args{startwith} ? " AND domain ~* ?" : '').
2594 ($args{filter} ? " AND domain ~* ?" : '');
2595 } else {
2596##fixme: arguably startwith here is irrelevant. depends on the UI though.
2597 $args{sortby} = 'revnet' if !$args{sortby} || !grep /^$args{sortby}$/, ('revnet','group','status');
2598 $sql = "SELECT rdns_id AS zoneid,revnet AS zone,status,groups.group_name AS group FROM revzones".
2599 " INNER JOIN groups ON revzones.group_id=groups.group_id".
2600 " WHERE revzones.group_id IN ($args{curgroup}".($args{childlist} ? ",$args{childlist}" : '').")".
2601 ($args{startwith} ? " AND CAST(revnet AS VARCHAR) ~* ?" : '');
2602# if ($self->{showrev_arpa} eq 'zone' || $self->{showrev_arpa} eq 'all') {
2603 # Just In Case the UI is using formal .arpa notation, and someone enters something reversed,
2604 # we want to match both the formal and natural zone name
2605 $sql .= ($args{filter} ? " AND (CAST(revnet AS VARCHAR) ~* ? OR CAST(revnet AS VARCHAR) ~* ?)" : '');
2606 push @filterargs, join('[.]',reverse(split(/\[\.\]/,$args{filter}))) if $args{filter};
2607# } else {
2608# $sql .= ($args{filter} ? " AND CAST(revnet AS VARCHAR) ~* ?" : '');
2609# }
2610 }
2611 # A common tail.
2612 $sql .= " ORDER BY ".($args{sortby} eq 'group' ? 'groups.group_name' : $args{sortby})." $args{sortorder} ".
2613 ($args{offset} eq 'all' ? '' : " LIMIT $self->{perpage}".
2614 " OFFSET ".$args{offset}*$self->{perpage});
2615
2616 my @working;
2617 my $zsth = $dbh->prepare($sql);
2618 $zsth->execute(@filterargs);
2619 while (my $zone = $zsth->fetchrow_hashref) {
2620 if ($args{revrec} eq 'y' && ($self->{showrev_arpa} eq 'zone' || $self->{showrev_arpa} eq 'all')) {
2621 my $tmp = new NetAddr::IP $zone->{zone};
2622 $zone->{zone} = DNSDB::_ZONE($tmp, 'ZONE', 'r', '.').($tmp->{isv6} ? '.ip6.arpa' : '.in-addr.arpa');
2623 }
2624 push @working, $zone;
2625 }
2626 return \@working;
2627} # end getZoneList()
2628
2629
2630## DNSDB::getZoneLocation()
2631# Retrieve the default location for a zone.
2632# Takes a database handle, forward/reverse flag, and zone ID
2633sub getZoneLocation {
2634 my $self = shift;
2635 my $dbh = $self->{dbh};
2636 my $revrec = shift;
2637 my $zoneid = shift;
2638
2639 my ($loc) = $dbh->selectrow_array("SELECT default_location FROM ".
2640 ($revrec eq 'n' ? 'domains WHERE domain_id = ?' : 'revzones WHERE rdns_id = ?'),
2641 undef, ($zoneid));
2642 return $loc;
2643} # end getZoneLocation()
2644
2645
2646## DNSDB::addGroup()
2647# Add a group
2648# Takes a database handle, group name, parent group, hashref for permissions,
2649# and optional template-vs-cloneme flag for the default records
2650# Returns a status code and message
2651sub addGroup {
2652 $errstr = '';
2653 my $self = shift;
2654 my $dbh = $self->{dbh};
2655 my $groupname = shift;
2656 my $pargroup = shift;
2657 my $permissions = shift;
2658
2659 # 0 indicates "custom", hardcoded.
2660 # Any other value clones that group's default records, if it exists.
2661 my $inherit = shift || 0;
2662##fixme: need a flag to indicate clone records or <?> ?
2663
2664 # Allow transactions, and raise an exception on errors so we can catch it later.
2665 # Use local to make sure these get "reset" properly on exiting this block
2666 local $dbh->{AutoCommit} = 0;
2667 local $dbh->{RaiseError} = 1;
2668
2669 my ($group_id) = $dbh->selectrow_array("SELECT group_id FROM groups WHERE group_name=?", undef, ($groupname));
2670
2671 return ('FAIL', "Group already exists") if $group_id;
2672
2673 # Wrap all the SQL in a transaction
2674 eval {
2675 $dbh->do("INSERT INTO groups (parent_group_id,group_name) VALUES (?,?)", undef, ($pargroup, $groupname) );
2676
2677 my ($groupid) = $dbh->selectrow_array("SELECT currval('groups_group_id_seq')");
2678
2679 # We work through the whole set of permissions instead of specifying them so
2680 # that when we add a new permission, we don't have to change the code anywhere
2681 # that doesn't explicitly deal with that specific permission.
2682 my @permvals;
2683 foreach (@permtypes) {
2684 if (!defined ($permissions->{$_})) {
2685 push @permvals, 0;
2686 } else {
2687 push @permvals, $permissions->{$_};
2688 }
2689 }
2690 $dbh->do("INSERT INTO permissions (group_id,$permlist) values (?".',?'x($#permtypes+1).")",
2691 undef, ($groupid, @permvals) );
2692 my ($permid) = $dbh->selectrow_array("SELECT currval('permissions_permission_id_seq')");
2693 $dbh->do("UPDATE groups SET permission_id=$permid WHERE group_id=$groupid");
2694
2695 # Default records
2696 my $sthf = $dbh->prepare("INSERT INTO default_records (group_id,host,type,val,distance,weight,port,ttl) ".
2697 "VALUES ($groupid,?,?,?,?,?,?,?)");
2698 my $sthr = $dbh->prepare("INSERT INTO default_rev_records (group_id,host,type,val,ttl) ".
2699 "VALUES ($groupid,?,?,?,?)");
2700 if ($inherit) {
2701 # Duplicate records from parent. Actually relying on inherited records feels
2702 # very fragile, and it would be problematic to roll over at a later time.
2703 my $sth2 = $dbh->prepare("SELECT host,type,val,distance,weight,port,ttl FROM default_records WHERE group_id=?");
2704 $sth2->execute($pargroup);
2705 while (my @clonedata = $sth2->fetchrow_array) {
2706 $sthf->execute(@clonedata);
2707 }
2708 # And now the reverse records
2709 $sth2 = $dbh->prepare("SELECT host,type,val,ttl FROM default_rev_records WHERE group_id=?");
2710 $sth2->execute($pargroup);
2711 while (my @clonedata = $sth2->fetchrow_array) {
2712 $sthr->execute(@clonedata);
2713 }
2714 } else {
2715##fixme: Hardcoding is Bad, mmmmkaaaay?
2716 # reasonable basic defaults for SOA, MX, NS, and minimal hosting
2717 # could load from a config file, but somewhere along the line we need hardcoded bits.
2718 $sthf->execute('ns1.example.com:hostmaster.example.com', 6, '10800:3600:604800:10800', 0, 0, 0, 86400);
2719 $sthf->execute('DOMAIN', 1, '192.168.4.2', 0, 0, 0, 7200);
2720 $sthf->execute('DOMAIN', 15, 'mx.example.com', 10, 0, 0, 7200);
2721 $sthf->execute('DOMAIN', 2, 'ns1.example.com', 0, 0, 0, 7200);
2722 $sthf->execute('DOMAIN', 2, 'ns2.example.com', 0, 0, 0, 7200);
2723 $sthf->execute('www.DOMAIN', 5, 'DOMAIN', 0, 0, 0, 7200);
2724 # reasonable basic defaults for generic reverse zone. Same as initial SQL tabledef.
2725 $sthr->execute('hostmaster.ADMINDOMAIN:ns1.ADMINDOMAIN', 6, '10800:3600:604800:10800', 86400);
2726 $sthr->execute('unused-%r.ADMINDOMAIN', 65283, 'ZONE', 3600);
2727 }
2728
2729 $self->_log(group_id => $pargroup, entry => "Added group $groupname");
2730
2731 # once we get here, we should have suceeded.
2732 $dbh->commit;
2733 }; # end eval
2734
2735 if ($@) {
2736 my $msg = $@;
2737 eval { $dbh->rollback; };
2738 if ($self->{log_failures}) {
2739 $self->_log(group_id => $pargroup, entry => "Failed to add group $groupname: $msg");
2740 $dbh->commit;
2741 }
2742 return ('FAIL',$msg);
2743 }
2744
2745 return ('OK','OK');
2746} # end addGroup()
2747
2748
2749## DNSDB::delGroup()
2750# Delete a group.
2751# Takes a group ID
2752# Returns a status code and message
2753sub delGroup {
2754 my $self = shift;
2755 my $dbh = $self->{dbh};
2756 my $groupid = shift;
2757
2758 # Allow transactions, and raise an exception on errors so we can catch it later.
2759 # Use local to make sure these get "reset" properly on exiting this block
2760 local $dbh->{AutoCommit} = 0;
2761 local $dbh->{RaiseError} = 1;
2762
2763##fixme: locate "knowable" error conditions and deal with them before the eval
2764# ... or inside, whatever.
2765# -> domains still exist in group
2766# -> ...
2767 my $failmsg = '';
2768 my $resultmsg = '';
2769
2770 # collect some pieces for logging and error messages
2771 my $groupname = $self->groupName($groupid);
2772 my $parid = $self->parentID(id => $groupid, type => 'group');
2773
2774 # Wrap all the SQL in a transaction
2775 eval {
2776 # Check for Things in the group
2777 $failmsg = "Can't remove group $groupname";
2778 my ($grpcnt) = $dbh->selectrow_array("SELECT count(*) FROM groups WHERE parent_group_id=?", undef, ($groupid));
2779 die "$grpcnt groups still in group\n" if $grpcnt;
2780 my ($domcnt) = $dbh->selectrow_array("SELECT count(*) FROM domains WHERE group_id=?", undef, ($groupid));
2781 die "$domcnt domains still in group\n" if $domcnt;
2782 my ($revcnt) = $dbh->selectrow_array("SELECT count(*) FROM revzones WHERE group_id=?", undef, ($groupid));
2783 die "$revcnt reverse zones still in group\n" if $revcnt;
2784 my ($usercnt) = $dbh->selectrow_array("SELECT count(*) FROM users WHERE group_id=?", undef, ($groupid));
2785 die "$usercnt users still in group\n" if $usercnt;
2786
2787 $failmsg = "Failed to delete default records for $groupname";
2788 $dbh->do("DELETE from default_records WHERE group_id=?", undef, ($groupid));
2789 $failmsg = "Failed to delete default reverse records for $groupname";
2790 $dbh->do("DELETE from default_rev_records WHERE group_id=?", undef, ($groupid));
2791 $failmsg = "Failed to remove group $groupname";
2792 $dbh->do("DELETE from groups WHERE group_id=?", undef, ($groupid));
2793
2794 $self->_log(group_id => $parid, entry => "Deleted group $groupname");
2795 $resultmsg = "Deleted group $groupname";
2796
2797 # once we get here, we should have suceeded.
2798 $dbh->commit;
2799 }; # end eval
2800
2801 if ($@) {
2802 my $msg = $@;
2803 eval { $dbh->rollback; };
2804 if ($self->{log_failures}) {
2805 $self->_log(group_id => $parid, entry => "$failmsg: $msg");
2806 $dbh->commit; # since we enabled transactions earlier
2807 }
2808 return ('FAIL',"$failmsg: $msg");
2809 }
2810
2811 return ('OK',$resultmsg);
2812} # end delGroup()
2813
2814
2815## DNSDB::getChildren()
2816# Get a list of all groups whose parent^n is group <n>
2817# Takes a database handle, group ID, reference to an array to put the group IDs in,
2818# and an optional flag to return only immediate children or all children-of-children
2819# default to returning all children
2820# Calls itself
2821sub getChildren {
2822 $errstr = '';
2823 my $self = shift;
2824 my $dbh = $self->{dbh};
2825 my $rootgroup = shift;
2826 my $groupdest = shift;
2827 my $immed = shift || 'all';
2828
2829 # special break for default group; otherwise we get stuck.
2830 if ($rootgroup == 1) {
2831 # by definition, group 1 is the Root Of All Groups
2832 my $sth = $dbh->prepare("SELECT group_id FROM groups WHERE NOT (group_id=1)".
2833 ($immed ne 'all' ? " AND parent_group_id=1" : '')." ORDER BY group_name");
2834 $sth->execute;
2835 while (my @this = $sth->fetchrow_array) {
2836 push @$groupdest, @this;
2837 }
2838 } else {
2839 my $sth = $dbh->prepare("SELECT group_id FROM groups WHERE parent_group_id=? ORDER BY group_name");
2840 $sth->execute($rootgroup);
2841 return if $sth->rows == 0;
2842 my @grouplist;
2843 while (my ($group) = $sth->fetchrow_array) {
2844 push @$groupdest, $group;
2845 $self->getChildren($group, $groupdest) if $immed eq 'all';
2846 }
2847 }
2848} # end getChildren()
2849
2850
2851## DNSDB::groupName()
2852# Return the group name based on a group ID
2853# Takes a database handle and the group ID
2854# Returns the group name or undef on failure
2855sub groupName {
2856 $errstr = '';
2857 my $self = shift;
2858 my $dbh = $self->{dbh};
2859 my $groupid = shift;
2860 my $sth = $dbh->prepare("SELECT group_name FROM groups WHERE group_id=?");
2861 $sth->execute($groupid);
2862 my ($groupname) = $sth->fetchrow_array();
2863 $errstr = $DBI::errstr if !$groupname;
2864 return $groupname if $groupname;
2865} # end groupName
2866
2867
2868## DNSDB::getGroupCount()
2869# Get count of subgroups in group or groups
2870# Takes a database handle and hash containing:
2871# - the "current" group
2872# - an array of "acceptable" groups
2873# - Optionally accept a "starts with" and/or "contains" filter argument
2874# Returns an integer count of the resulting group list.
2875sub getGroupCount {
2876 my $self = shift;
2877 my $dbh = $self->{dbh};
2878
2879 my %args = @_;
2880
2881 # Fail on bad curgroup argument. There's no sane fallback on this one.
2882 if (!$args{curgroup} || $args{curgroup} !~ /^\d+$/) {
2883 $errstr = "Bad or missing curgroup argument";
2884 return;
2885 }
2886 # Fail on bad childlist argument. This could be sanely ignored if bad, maybe.
2887 if ($args{childlist} && $args{childlist} !~ /^[\d,]+$/) {
2888 $errstr = "Bad childlist argument";
2889 return;
2890 }
2891
2892 my @filterargs;
2893 $args{startwith} = undef if $args{startwith} && $args{startwith} !~ /^(?:[a-z]|0-9)$/;
2894 push @filterargs, "^$args{startwith}" if $args{startwith};
2895 push @filterargs, $args{filter} if $args{filter};
2896
2897 my $sql = "SELECT count(*) FROM groups ".
2898 "WHERE parent_group_id IN ($args{curgroup}".($args{childlist} ? ",$args{childlist}" : '').")".
2899 ($args{startwith} ? " AND group_name ~* ?" : '').
2900 ($args{filter} ? " AND group_name ~* ?" : '');
2901 my ($count) = $dbh->selectrow_array($sql, undef, (@filterargs) );
2902 $errstr = $dbh->errstr if !$count;
2903 return $count;
2904} # end getGroupCount
2905
2906
2907## DNSDB::getGroupList()
2908# Get a list of sub^n-groups in the specified group(s)
2909# Takes the same arguments as getGroupCount() above
2910# Returns an arrayref containing hashrefs suitable for feeding straight to HTML::Template
2911sub getGroupList {
2912 my $self = shift;
2913 my $dbh = $self->{dbh};
2914
2915 my %args = @_;
2916
2917 # Fail on bad curgroup argument. There's no sane fallback on this one.
2918 if (!$args{curgroup} || $args{curgroup} !~ /^\d+$/) {
2919 $errstr = "Bad or missing curgroup argument";
2920 return;
2921 }
2922 # Fail on bad childlist argument. This could be sanely ignored if bad, maybe.
2923 if ($args{childlist} && $args{childlist} !~ /^[\d,]+$/) {
2924 $errstr = "Bad childlist argument";
2925 return;
2926 }
2927
2928 my @filterargs;
2929 $args{startwith} = undef if $args{startwith} && $args{startwith} !~ /^(?:[a-z]|0-9)$/;
2930 push @filterargs, "^$args{startwith}" if $args{startwith};
2931 push @filterargs, $args{filter} if $args{filter};
2932
2933 # protection against bad or missing arguments
2934 $args{sortorder} = 'ASC' if !$args{sortorder} || !grep /^$args{sortorder}$/, ('ASC','DESC');
2935 $args{sortby} = 'group' if !$args{sortby} || $args{sortby} !~ /^[\w_.]+$/;
2936 $args{offset} = 0 if !$args{offset} || $args{offset} !~ /^(?:all|\d+)$/;
2937
2938 # munge sortby for columns in database
2939 $args{sortby} = 'g.group_name' if $args{sortby} eq 'group';
2940 $args{sortby} = 'g2.group_name' if $args{sortby} eq 'parent';
2941
2942 my $sql = q(SELECT g.group_id AS groupid, g.group_name AS groupname, g2.group_name AS pgroup
2943 FROM groups g
2944 INNER JOIN groups g2 ON g2.group_id=g.parent_group_id
2945 ).
2946 " WHERE g.parent_group_id IN ($args{curgroup}".($args{childlist} ? ",$args{childlist}" : '').")".
2947 ($args{startwith} ? " AND g.group_name ~* ?" : '').
2948 ($args{filter} ? " AND g.group_name ~* ?" : '').
2949 " GROUP BY g.group_id, g.group_name, g2.group_name ".
2950 " ORDER BY $args{sortby} $args{sortorder} ".
2951 ($args{offset} eq 'all' ? '' : " LIMIT $self->{perpage} OFFSET ".$args{offset}*$self->{perpage});
2952 my $glist = $dbh->selectall_arrayref($sql, { Slice => {} }, (@filterargs) );
2953 $errstr = $dbh->errstr if !$glist;
2954
2955 # LEFT JOINs make the result set balloon beyond sanity just to include counts;
2956 # this means there's lots of crunching needed to trim the result set back down.
2957 # So instead we track the order of the groups, and push the counts into the
2958 # arrayref result separately.
2959##fixme: put this whole sub in a transaction? might be
2960# needed for accurate results on very busy systems.
2961##fixme: large group lists need prepared statements?
2962#my $ucsth = $dbh->prepare("SELECT count(*) FROM users WHERE group_id=?");
2963#my $dcsth = $dbh->prepare("SELECT count(*) FROM domains WHERE group_id=?");
2964#my $rcsth = $dbh->prepare("SELECT count(*) FROM revzones WHERE group_id=?");
2965 foreach (@{$glist}) {
2966 my ($ucnt) = $dbh->selectrow_array("SELECT count(*) FROM users WHERE group_id=?", undef, ($$_{groupid}));
2967 $$_{nusers} = $ucnt;
2968 my ($dcnt) = $dbh->selectrow_array("SELECT count(*) FROM domains WHERE group_id=?", undef, ($$_{groupid}));
2969 $$_{ndomains} = $dcnt;
2970 my ($rcnt) = $dbh->selectrow_array("SELECT count(*) FROM revzones WHERE group_id=?", undef, ($$_{groupid}));
2971 $$_{nrevzones} = $rcnt;
2972 }
2973
2974 return $glist;
2975} # end getGroupList
2976
2977
2978## DNSDB::groupID()
2979# Return the group ID based on the group name
2980# Takes a database handle and the group name
2981# Returns the group ID or undef on failure
2982sub groupID {
2983 $errstr = '';
2984 my $self = shift;
2985 my $dbh = $self->{dbh};
2986 my $group = shift;
2987 my ($grpid) = $dbh->selectrow_array("SELECT group_id FROM groups WHERE group_name=?", undef, ($group) );
2988 $errstr = $DBI::errstr if !$grpid;
2989 return $grpid if $grpid;
2990} # end groupID()
2991
2992
2993## DNSDB::addUser()
2994# Add a user.
2995# Takes a DB handle, username, group ID, password, state (active/inactive).
2996# Optionally accepts:
2997# user type (user/admin) - defaults to user
2998# permissions string - defaults to inherit from group
2999# three valid forms:
3000# i - Inherit permissions
3001# c:<user_id> - Clone permissions from <user_id>
3002# C:<permission list> - Set these specific permissions
3003# first name - defaults to username
3004# last name - defaults to blank
3005# phone - defaults to blank (could put other data within column def)
3006# Returns (OK,<uid>) on success, (FAIL,<message>) on failure
3007sub addUser {
3008 $errstr = '';
3009 my $self = shift;
3010 my $dbh = $self->{dbh};
3011 my $username = shift;
3012 my $group = shift;
3013 my $pass = shift;
3014 my $state = shift;
3015
3016 return ('FAIL', "Missing one or more required entries") if !defined($state);
3017 return ('FAIL', "Username must not be blank") if !$username;
3018
3019 # Munge in some alternate state values
3020 $state = 1 if $state =~ /^active$/;
3021 $state = 1 if $state =~ /^on$/;
3022 $state = 0 if $state =~ /^inactive$/;
3023 $state = 0 if $state =~ /^off$/;
3024
3025 my $type = shift || 'u'; # create limited users by default - fwiw, not sure yet how this will interact with ACLs
3026
3027 my $permstring = shift || 'i'; # default is to inhert permissions from group
3028
3029 my $fname = shift || $username;
3030 my $lname = shift || '';
3031 my $phone = shift || ''; # not going format-check
3032
3033 my $sth = $dbh->prepare("SELECT user_id FROM users WHERE username=?");
3034 my $user_id;
3035
3036# quick check to start to see if we've already got one
3037 $sth->execute($username);
3038 ($user_id) = $sth->fetchrow_array;
3039
3040 return ('FAIL', "User already exists") if $user_id;
3041
3042 # Allow transactions, and raise an exception on errors so we can catch it later.
3043 # Use local to make sure these get "reset" properly on exiting this block
3044 local $dbh->{AutoCommit} = 0;
3045 local $dbh->{RaiseError} = 1;
3046
3047 # Wrap all the SQL in a transaction
3048 eval {
3049 # insert the user... note we set inherited perms by default since
3050 # it's simple and cleans up some other bits of state
3051##fixme: need better handling of case of inherited or missing (!!) permissions entries
3052 my $sth = $dbh->prepare("INSERT INTO users ".
3053 "(group_id,username,password,firstname,lastname,phone,type,status,permission_id,inherit_perm) ".
3054 "VALUES (?,?,?,?,?,?,?,?,(SELECT permission_id FROM permissions WHERE group_id=?),'t')");
3055 $sth->execute($group,$username,unix_md5_crypt($pass),$fname,$lname,$phone,$type,$state,$group);
3056
3057 # get the ID...
3058 ($user_id) = $dbh->selectrow_array("SELECT currval('users_user_id_seq')");
3059
3060# Permissions! Gotta set'em all!
3061 die "Invalid permission string $permstring\n"
3062 if $permstring !~ /^(?:
3063 i # inherit
3064 |c:\d+ # clone
3065 # custom. no, the leading , is not a typo
3066 |C:(?:,(?:group|user|domain|record|location|self)_(?:edit|create|delete|locchg|view))*
3067 )$/x;
3068# bleh. I'd call another function to do my dirty work, but we're in the middle of a transaction already.
3069 if ($permstring ne 'i') {
3070 # for cloned or custom permissions, we have to create a new permissions entry.
3071 my $clonesrc = $group;
3072 if ($permstring =~ /^c:(\d+)/) { $clonesrc = $1; }
3073 $dbh->do("INSERT INTO permissions ($permlist,user_id) ".
3074 "SELECT $permlist,? FROM permissions WHERE permission_id=".
3075 "(SELECT permission_id FROM permissions WHERE ".($permstring =~ /^c:/ ? 'user' : 'group')."_id=?)",
3076 undef, ($user_id,$clonesrc) );
3077 $dbh->do("UPDATE users SET permission_id=".
3078 "(SELECT permission_id FROM permissions WHERE user_id=?) ".
3079 "WHERE user_id=?", undef, ($user_id, $user_id) );
3080 }
3081 if ($permstring =~ /^C:/) {
3082 # finally for custom permissions, we set the passed-in permissions (and unset
3083 # any that might have been brought in by the clone operation above)
3084 my ($permid) = $dbh->selectrow_array("SELECT permission_id FROM permissions WHERE user_id=?",
3085 undef, ($user_id) );
3086 foreach (@permtypes) {
3087 if ($permstring =~ /,$_/) {
3088 $dbh->do("UPDATE permissions SET $_='t' WHERE permission_id=?", undef, ($permid) );
3089 } else {
3090 $dbh->do("UPDATE permissions SET $_='f' WHERE permission_id=?", undef, ($permid) );
3091 }
3092 }
3093 }
3094
3095 $dbh->do("UPDATE users SET inherit_perm='n' WHERE user_id=?", undef, ($user_id) );
3096
3097##fixme: add another table to hold name/email for log table?
3098
3099 $self->_log(group_id => $group, entry => "Added user $username ($fname $lname)");
3100 # once we get here, we should have suceeded.
3101 $dbh->commit;
3102 }; # end eval
3103
3104 if ($@) {
3105 my $msg = $@;
3106 eval { $dbh->rollback; };
3107 if ($self->{log_failures}) {
3108 $self->_log(group_id => $group, entry => "Error adding user $username: $msg");
3109 $dbh->commit; # since we enabled transactions earlier
3110 }
3111 return ('FAIL',"Error adding user $username: $msg");
3112 }
3113
3114 return ('OK',"User $username ($fname $lname) added");
3115} # end addUser
3116
3117
3118## DNSDB::getUserCount()
3119# Get count of users in group
3120# Takes a database handle and hash containing at least the current group, and optionally:
3121# - a reference list of secondary groups
3122# - a filter string
3123# - a "Starts with" string
3124sub getUserCount {
3125 my $self = shift;
3126 my $dbh = $self->{dbh};
3127
3128 my %args = @_;
3129
3130 # Fail on bad curgroup argument. There's no sane fallback on this one.
3131 if (!$args{curgroup} || $args{curgroup} !~ /^\d+$/) {
3132 $errstr = "Bad or missing curgroup argument";
3133 return;
3134 }
3135 # Fail on bad childlist argument. This could be sanely ignored if bad, maybe.
3136 if ($args{childlist} && $args{childlist} !~ /^[\d,]+$/) {
3137 $errstr = "Bad childlist argument";
3138 return;
3139 }
3140
3141 my @filterargs;
3142 $args{startwith} = undef if $args{startwith} && $args{startwith} !~ /^(?:[a-z]|0-9)$/;
3143 push @filterargs, "^$args{startwith}" if $args{startwith};
3144 push @filterargs, $args{filter} if $args{filter};
3145
3146 my $sql = "SELECT count(*) FROM users ".
3147 "WHERE group_id IN ($args{curgroup}".($args{childlist} ? ",$args{childlist}" : '').")".
3148 ($args{startwith} ? " AND username ~* ?" : '').
3149 ($args{filter} ? " AND username ~* ?" : '');
3150 my ($count) = $dbh->selectrow_array($sql, undef, (@filterargs) );
3151 $errstr = $dbh->errstr if !$count;
3152 return $count;
3153} # end getUserCount()
3154
3155
3156## DNSDB::getUserList()
3157# Get list of users
3158# Takes the same arguments as getUserCount() above, plus optional:
3159# - sort field
3160# - sort order
3161# - offset/return-all-everything flag (defaults to $perpage records)
3162sub getUserList {
3163 my $self = shift;
3164 my $dbh = $self->{dbh};
3165
3166 my %args = @_;
3167
3168 # Fail on bad curgroup argument. There's no sane fallback on this one.
3169 if (!$args{curgroup} || $args{curgroup} !~ /^\d+$/) {
3170 $errstr = "Bad or missing curgroup argument";
3171 return;
3172 }
3173 # Fail on bad childlist argument. This could be sanely ignored if bad, maybe.
3174 if ($args{childlist} && $args{childlist} !~ /^[\d,]+$/) {
3175 $errstr = "Bad childlist argument";
3176 return;
3177 }
3178
3179 my @filterargs;
3180 $args{startwith} = undef if $args{startwith} && $args{startwith} !~ /^(?:[a-z]|0-9)$/;
3181 push @filterargs, "^$args{startwith}" if $args{startwith};
3182 push @filterargs, $args{filter} if $args{filter};
3183
3184 # better to request sorts on "simple" names, but it means we need to map it to real columns
3185 my %sortmap = (user => 'u.username', type => 'u.type', group => 'g.group_name', status => 'u.status',
3186 fname => 'fname');
3187 $args{sortby} = $sortmap{$args{sortby}};
3188
3189 # protection against bad or missing arguments
3190 $args{sortorder} = 'ASC' if !$args{sortorder} || !grep /^$args{sortorder}$/, ('ASC','DESC');
3191 $args{sortby} = 'u.username' if !$args{sortby} || $args{sortby} !~ /^[\w_.]+$/;
3192 $args{offset} = 0 if !$args{offset} || $args{offset} !~ /^(?:all|\d+)$/;
3193
3194 my $sql = "SELECT u.user_id, u.username, u.firstname || ' ' || u.lastname AS fname, u.type, g.group_name, u.status ".
3195 "FROM users u ".
3196 "INNER JOIN groups g ON u.group_id=g.group_id ".
3197 "WHERE u.group_id IN ($args{curgroup}".($args{childlist} ? ",$args{childlist}" : '').")".
3198 ($args{startwith} ? " AND u.username ~* ?" : '').
3199 ($args{filter} ? " AND u.username ~* ?" : '').
3200 " AND NOT u.type = 'R' ".
3201 " ORDER BY $args{sortby} $args{sortorder} ".
3202 ($args{offset} eq 'all' ? '' : " LIMIT $self->{perpage} OFFSET ".$args{offset}*$self->{perpage});
3203 my $ulist = $dbh->selectall_arrayref($sql, { Slice => {} }, (@filterargs) );
3204 $errstr = $dbh->errstr if !$ulist;
3205 return $ulist;
3206} # end getUserList()
3207
3208
3209## DNSDB::getUserDropdown()
3210# Get a list of usernames for use in a dropdown menu.
3211# Takes a database handle, current group, and optional "tag this as selected" flag.
3212# Returns a reference to a list of hashrefs suitable to feeding to HTML::Template
3213sub getUserDropdown {
3214 my $self = shift;
3215 my $dbh = $self->{dbh};
3216 my $grp = shift;
3217 my $sel = shift || 0;
3218
3219 my $sth = $dbh->prepare("SELECT username,user_id FROM users WHERE group_id=?");
3220 $sth->execute($grp);
3221
3222 my @userlist;
3223 while (my ($username,$uid) = $sth->fetchrow_array) {
3224 my %row = (
3225 username => $username,
3226 uid => $uid,
3227 selected => ($sel == $uid ? 1 : 0)
3228 );
3229 push @userlist, \%row;
3230 }
3231 return \@userlist;
3232} # end getUserDropdown()
3233
3234
3235## DNSDB:: updateUser()
3236# Update general data about user
3237sub updateUser {
3238 my $self = shift;
3239 my $dbh = $self->{dbh};
3240
3241##fixme: tweak calling convention so that we can update any given bit of data
3242 my $uid = shift;
3243 my $username = shift;
3244 my $group = shift;
3245 my $pass = shift;
3246 my $state = shift;
3247 my $type = shift || 'u';
3248 my $fname = shift || $username;
3249 my $lname = shift || '';
3250 my $phone = shift || ''; # not going format-check
3251
3252 my $resultmsg = '';
3253
3254 # Munge in some alternate state values
3255 $state = 1 if $state =~ /^active$/;
3256 $state = 1 if $state =~ /^on$/;
3257 $state = 0 if $state =~ /^inactive$/;
3258 $state = 0 if $state =~ /^off$/;
3259
3260 # Allow transactions, and raise an exception on errors so we can catch it later.
3261 # Use local to make sure these get "reset" properly on exiting this block
3262 local $dbh->{AutoCommit} = 0;
3263 local $dbh->{RaiseError} = 1;
3264
3265 my $sth;
3266
3267 # Password can be left blank; if so we assume there's one on file.
3268 # Actual blank passwords are bad, mm'kay?
3269 if (!$pass) {
3270 ($pass) = $dbh->selectrow_array("SELECT password FROM users WHERE user_id=?", undef, ($uid));
3271 } else {
3272 $pass = unix_md5_crypt($pass);
3273 }
3274
3275 eval {
3276 $dbh->do("UPDATE users SET username=?, password=?, firstname=?, lastname=?, phone=?, type=?, status=?".
3277 " WHERE user_id=?", undef, ($username, $pass, $fname, $lname, $phone, $type, $state, $uid));
3278 $resultmsg = "Updated user info for $username ($fname $lname)";
3279 $self->_log(group_id => $group, entry => $resultmsg);
3280 $dbh->commit;
3281 };
3282 if ($@) {
3283 my $msg = $@;
3284 eval { $dbh->rollback; };
3285 if ($self->{log_failures}) {
3286 $self->_log(group_id => $group, entry => "Error updating user $username: $msg");
3287 $dbh->commit; # since we enabled transactions earlier
3288 }
3289 return ('FAIL',"Error updating user $username: $msg");
3290 }
3291
3292 return ('OK',$resultmsg);
3293} # end updateUser()
3294
3295
3296## DNSDB::delUser()
3297# Delete a user.
3298# Takes a database handle and user ID
3299# Returns a success/failure code and matching message
3300sub delUser {
3301 my $self = shift;
3302 my $dbh = $self->{dbh};
3303 my $userid = shift;
3304
3305 return ('FAIL',"Bad userid") if !defined($userid);
3306
3307 my $userdata = $self->getUserData($userid);
3308
3309 # Allow transactions, and raise an exception on errors so we can catch it later.
3310 # Use local to make sure these get "reset" properly on exiting this block
3311 local $dbh->{AutoCommit} = 0;
3312 local $dbh->{RaiseError} = 1;
3313
3314 eval {
3315 $dbh->do("DELETE FROM users WHERE user_id=?", undef, ($userid));
3316 $self->_log(group_id => $userdata->{group_id},
3317 entry => "Deleted user ID $userid/".$userdata->{username}.
3318 " (".$userdata->{firstname}." ".$userdata->{lastname}.")");
3319 $dbh->commit;
3320 };
3321 if ($@) {
3322 my $msg = $@;
3323 eval { $dbh->rollback; };
3324 if ($self->{log_failures}) {
3325 $self->_log(group_id => $userdata->{group_id}, entry => "Error deleting user ID ".
3326 "$userid/".$userdata->{username}.": $msg");
3327 $dbh->commit;
3328 }
3329 return ('FAIL',"Error deleting user $userid/".$userdata->{username}.": $msg");
3330 }
3331
3332 return ('OK',"Deleted user ".$userdata->{username}." (".$userdata->{firstname}." ".$userdata->{lastname}.")");
3333} # end delUser
3334
3335
3336## DNSDB::userFullName()
3337# Return a pretty string!
3338# Takes a user_id and optional printf-ish string to indicate which pieces where:
3339# %u for the username
3340# %f for the first name
3341# %l for the last name
3342# All other text in the passed string will be left as-is.
3343##fixme: need a "smart" option too, so that missing/null/blank first/last names don't give funky output
3344sub userFullName {
3345 $errstr = '';
3346 my $self = shift;
3347 my $dbh = $self->{dbh};
3348 my $userid = shift;
3349 my $fullformat = shift || '%f %l (%u)';
3350 my $sth = $dbh->prepare("select username,firstname,lastname from users where user_id=?");
3351 $sth->execute($userid);
3352 my ($uname,$fname,$lname) = $sth->fetchrow_array();
3353 $errstr = $DBI::errstr if !$uname;
3354
3355 $fullformat =~ s/\%u/$uname/g;
3356 $fullformat =~ s/\%f/$fname/g;
3357 $fullformat =~ s/\%l/$lname/g;
3358
3359 return $fullformat;
3360} # end userFullName
3361
3362
3363## DNSDB::userStatus()
3364# Sets and/or returns a user's status
3365# Takes a database handle, user ID and optionally a status argument
3366# Returns undef on errors.
3367sub userStatus {
3368 my $self = shift;
3369 my $dbh = $self->{dbh};
3370 my $id = shift;
3371 my $newstatus = shift || 'mu';
3372
3373 return undef if $id !~ /^\d+$/;
3374
3375 my $userdata = $self->getUserData($id);
3376
3377 # Allow transactions, and raise an exception on errors so we can catch it later.
3378 # Use local to make sure these get "reset" properly on exiting this block
3379 local $dbh->{AutoCommit} = 0;
3380 local $dbh->{RaiseError} = 1;
3381
3382 if ($newstatus ne 'mu') {
3383 # ooo, fun! let's see what we were passed for status
3384 eval {
3385 $newstatus = 0 if $newstatus eq 'useroff';
3386 $newstatus = 1 if $newstatus eq 'useron';
3387 $dbh->do("UPDATE users SET status=? WHERE user_id=?", undef, ($newstatus, $id));
3388
3389 $resultstr = ($newstatus ? 'Enabled' : 'Disabled')." user ".$userdata->{username}.
3390 " (".$userdata->{firstname}." ".$userdata->{lastname}.")";
3391
3392 my %loghash;
3393 $loghash{group_id} = $self->parentID(id => $id, type => 'user');
3394 $loghash{entry} = $resultstr;
3395 $self->_log(%loghash);
3396
3397 $dbh->commit;
3398 };
3399 if ($@) {
3400 my $msg = $@;
3401 eval { $dbh->rollback; };
3402 $resultstr = '';
3403 $errstr = $msg;
3404##fixme: failure logging?
3405 return;
3406 }
3407 }
3408
3409 my ($status) = $dbh->selectrow_array("SELECT status FROM users WHERE user_id=?", undef, ($id));
3410 return $status;
3411} # end userStatus()
3412
3413
3414## DNSDB::getUserData()
3415# Get misc user data for display
3416sub getUserData {
3417 my $self = shift;
3418 my $dbh = $self->{dbh};
3419 my $uid = shift;
3420
3421 my $sth = $dbh->prepare("SELECT group_id,username,firstname,lastname,phone,type,status,inherit_perm ".
3422 "FROM users WHERE user_id=?");
3423 $sth->execute($uid);
3424 return $sth->fetchrow_hashref();
3425} # end getUserData()
3426
3427
3428## DNSDB::addLoc()
3429# Add a new location.
3430# Takes a database handle, group ID, short and long description, and a comma-separated
3431# list of IP addresses.
3432# Returns ('OK',<location>) on success, ('FAIL',<failmsg>) on failure
3433sub addLoc {
3434 my $self = shift;
3435 my $dbh = $self->{dbh};
3436 my $grp = shift;
3437 my $shdesc = shift;
3438 my $comments = shift;
3439 my $iplist = shift;
3440
3441 # $shdesc gets set to the generated location ID if possible, but these can be de-undefined here.
3442 $comments = '' if !$comments;
3443 $iplist = '' if !$iplist;
3444
3445 my $loc;
3446
3447 # Generate a location ID. This is, by spec, a two-character widget. We'll use [a-z][a-z]
3448 # for now; 676 locations should satisfy all but the largest of the huge networks.
3449 # Not sure whether these are case-sensitive, or what other rules might apply - in any case
3450 # the absolute maximum is 16K (256*256) since it's parsed by tinydns as a two-character field.
3451
3452# add just after "my $origloc = $loc;":
3453# # These expand the possible space from 26^2 to 52^2 [* note in testing only 2052 were achieved],
3454# # and wrap it around.
3455# # Yes, they skip a couple of possibles. No, I don't care.
3456# $loc = 'aA' if $loc eq 'zz';
3457# $loc = 'Aa' if $loc eq 'zZ';
3458# $loc = 'ZA' if $loc eq 'Zz';
3459# $loc = 'aa' if $loc eq 'ZZ';
3460
3461 # Allow transactions, and raise an exception on errors so we can catch it later.
3462 # Use local to make sure these get "reset" properly on exiting this block
3463 local $dbh->{AutoCommit} = 0;
3464 local $dbh->{RaiseError} = 1;
3465
3466##fixme: There is probably a far better way to do this. Sequential increments
3467# are marginally less stupid that pure random generation though, and the existence
3468# check makes sure we don't stomp on an imported one.
3469
3470 eval {
3471 # Get the "last" location. Note this is the only use for loc_id, because selecting on location Does Funky Things
3472 ($loc) = $dbh->selectrow_array("SELECT location FROM locations ORDER BY loc_id DESC LIMIT 1");
3473 ($loc) = ($loc =~ /^(..)/) if $loc;
3474 my $origloc = $loc;
3475 $loc = 'aa' if !$loc;
3476 # Make a change...
3477 $loc++;
3478 # ... and keep changing if it exists
3479 while ($dbh->selectrow_array("SELECT count(*) FROM locations WHERE location LIKE ?", undef, ($loc.'%'))) {
3480 $loc++;
3481 ($loc) = ($loc =~ /^(..)/);
3482 die "too many locations in use, can't add another one\n" if $loc eq $origloc;
3483##fixme: really need to handle this case faster somehow
3484#if $loc eq $origloc die "<thwap> bad admin: all locations used, your network is too fragmented";
3485 }
3486 # And now we should have a unique location. tinydns fundamentally limits the
3487 # number of these but there's no doc on what characters are valid.
3488 $shdesc = $loc if !$shdesc;
3489 $dbh->do("INSERT INTO locations (location, group_id, iplist, description, comments) VALUES (?,?,?,?,?)",
3490 undef, ($loc, $grp, $iplist, $shdesc, $comments) );
3491 $self->_log(entry => "Added location ($shdesc, '$iplist')");
3492 $dbh->commit;
3493 };
3494 if ($@) {
3495 my $msg = $@;
3496 eval { $dbh->rollback; };
3497 if ($self->{log_failures}) {
3498 $shdesc = $loc if !$shdesc;
3499 $self->_log(entry => "Failed adding location ($shdesc, '$iplist'): $msg");
3500 $dbh->commit;
3501 }
3502 return ('FAIL',$msg);
3503 }
3504
3505 return ('OK',$loc);
3506} # end addLoc()
3507
3508
3509## DNSDB::updateLoc()
3510# Update details of a location.
3511# Takes a database handle, location ID, group ID, short description,
3512# long comments/notes, and comma/space-separated IP list
3513# Returns a result code and message
3514sub updateLoc {
3515 my $self = shift;
3516 my $dbh = $self->{dbh};
3517 my $loc = shift;
3518 my $grp = shift;
3519 my $shdesc = shift;
3520 my $comments = shift;
3521 my $iplist = shift;
3522
3523 $shdesc = '' if !$shdesc;
3524 $comments = '' if !$comments;
3525 $iplist = '' if !$iplist;
3526
3527 # Allow transactions, and raise an exception on errors so we can catch it later.
3528 # Use local to make sure these get "reset" properly on exiting this block
3529 local $dbh->{AutoCommit} = 0;
3530 local $dbh->{RaiseError} = 1;
3531
3532 my $oldloc = $self->getLoc($loc);
3533 my $okmsg = "Updated location (".$oldloc->{description}.", '".$oldloc->{iplist}."') to ($shdesc, '$iplist')";
3534
3535 eval {
3536 $dbh->do("UPDATE locations SET group_id=?,iplist=?,description=?,comments=? WHERE location=?",
3537 undef, ($grp, $iplist, $shdesc, $comments, $loc) );
3538 $self->_log(entry => $okmsg);
3539 $dbh->commit;
3540 };
3541 if ($@) {
3542 my $msg = $@;
3543 eval { $dbh->rollback; };
3544 if ($self->{log_failures}) {
3545 $shdesc = $loc if !$shdesc;
3546 $self->_log(entry => "Failed updating location ($shdesc, '$iplist'): $msg");
3547 $dbh->commit;
3548 }
3549 return ('FAIL',$msg);
3550 }
3551
3552 return ('OK',$okmsg);
3553} # end updateLoc()
3554
3555
3556## DNSDB::delLoc()
3557sub delLoc {
3558 my $self = shift;
3559 my $dbh = $self->{dbh};
3560 my $loc = shift;
3561
3562 # Allow transactions, and raise an exception on errors so we can catch it later.
3563 # Use local to make sure these get "reset" properly on exiting this block
3564 local $dbh->{AutoCommit} = 0;
3565 local $dbh->{RaiseError} = 1;
3566
3567 my $oldloc = $self->getLoc($loc);
3568 my $olddesc = ($oldloc->{description} ? $oldloc->{description} : $loc);
3569 my $okmsg = "Deleted location ($olddesc, '".$oldloc->{iplist}."')";
3570
3571 eval {
3572 # Check for records with this location first. Deleting a location without deleting records
3573 # tagged for that location will render them unpublished without other warning.
3574 my ($r) = $dbh->selectrow_array("SELECT record_id FROM records WHERE location=? LIMIT 1", undef, ($loc) );
3575 die "Records still exist in location $olddesc\n" if $r;
3576 $dbh->do("DELETE FROM locations WHERE location=?", undef, ($loc) );
3577 $self->_log(entry => $okmsg);
3578 $dbh->commit;
3579 };
3580 if ($@) {
3581 my $msg = $@;
3582 eval { $dbh->rollback; };
3583 if ($self->{log_failures}) {
3584 $self->_log(entry => "Failed to delete location ($olddesc, '$oldloc->{iplist}'): $msg");
3585 $dbh->commit;
3586 }
3587 return ('FAIL', "Failed to delete location ($olddesc, '$oldloc->{iplist}'): $msg");
3588 }
3589
3590 return ('OK',$okmsg);
3591} # end delLoc()
3592
3593
3594## DNSDB::getLoc()
3595# Get details about a location/view
3596# Takes a database handle and location ID.
3597# Returns a reference to a hash containing the group ID, IP list, description, and comments/notes
3598sub getLoc {
3599 my $self = shift;
3600 my $dbh = $self->{dbh};
3601 my $loc = shift;
3602
3603 my $sth = $dbh->prepare("SELECT group_id,iplist,description,comments FROM locations WHERE location=?");
3604 $sth->execute($loc);
3605 return $sth->fetchrow_hashref();
3606} # end getLoc()
3607
3608
3609## DNSDB::getLocCount()
3610# Get count of locations/views
3611# Takes a database handle and hash containing at least the current group, and optionally:
3612# - a reference list of secondary groups
3613# - a filter string
3614# - a "Starts with" string
3615sub getLocCount {
3616 my $self = shift;
3617 my $dbh = $self->{dbh};
3618
3619 my %args = @_;
3620
3621 # Fail on bad curgroup argument. There's no sane fallback on this one.
3622 if (!$args{curgroup} || $args{curgroup} !~ /^\d+$/) {
3623 $errstr = "Bad or missing curgroup argument";
3624 return;
3625 }
3626 # Fail on bad childlist argument. This could be sanely ignored if bad, maybe.
3627 if ($args{childlist} && $args{childlist} !~ /^[\d,]+$/) {
3628 $errstr = "Bad childlist argument";
3629 return;
3630 }
3631
3632 my @filterargs;
3633 $args{startwith} = undef if $args{startwith} && $args{startwith} !~ /^(?:[a-z]|0-9)$/;
3634 push @filterargs, "^$args{startwith}" if $args{startwith};
3635 push @filterargs, $args{filter} if $args{filter};
3636
3637 my $sql = "SELECT count(*) FROM locations ".
3638 "WHERE group_id IN ($args{curgroup}".($args{childlist} ? ",$args{childlist}" : '').")".
3639 ($args{startwith} ? " AND description ~* ?" : '').
3640 ($args{filter} ? " AND description ~* ?" : '');
3641 my ($count) = $dbh->selectrow_array($sql, undef, (@filterargs) );
3642 $errstr = $dbh->errstr if !$count;
3643 return $count;
3644} # end getLocCount()
3645
3646
3647## DNSDB::getLocList()
3648sub getLocList {
3649 my $self = shift;
3650 my $dbh = $self->{dbh};
3651
3652 my %args = @_;
3653
3654 # Fail on bad curgroup argument. There's no sane fallback on this one.
3655 if (!$args{curgroup} || $args{curgroup} !~ /^\d+$/) {
3656 $errstr = "Bad or missing curgroup argument";
3657 return;
3658 }
3659 # Fail on bad childlist argument. This could be sanely ignored if bad, maybe.
3660 if ($args{childlist} && $args{childlist} !~ /^[\d,]+$/) {
3661 $errstr = "Bad childlist argument";
3662 return;
3663 }
3664
3665 my @filterargs;
3666 $args{startwith} = undef if $args{startwith} && $args{startwith} !~ /^(?:[a-z]|0-9)$/;
3667 push @filterargs, "^$args{startwith}" if $args{startwith};
3668 push @filterargs, $args{filter} if $args{filter};
3669
3670 # better to request sorts on "simple" names, but it means we need to map it to real columns
3671# my %sortmap = (user => 'u.username', type => 'u.type', group => 'g.group_name', status => 'u.status',
3672# fname => 'fname');
3673# $args{sortby} = $sortmap{$args{sortby}};
3674
3675 # protection against bad or missing arguments
3676 $args{sortorder} = 'ASC' if !$args{sortorder} || !grep /^$args{sortorder}$/, ('ASC','DESC');
3677 $args{sortby} = 'l.description' if !$args{sortby} || $args{sortby} !~ /^[\w_.]+$/;
3678 $args{offset} = 0 if !$args{offset} || $args{offset} !~ /^(?:all|\d+)$/;
3679
3680 my $sql = "SELECT l.location, l.description, l.iplist, g.group_name ".
3681 "FROM locations l ".
3682 "INNER JOIN groups g ON l.group_id=g.group_id ".
3683 "WHERE l.group_id IN ($args{curgroup}".($args{childlist} ? ",$args{childlist}" : '').")".
3684 ($args{startwith} ? " AND l.description ~* ?" : '').
3685 ($args{filter} ? " AND l.description ~* ?" : '').
3686 " ORDER BY $args{sortby} $args{sortorder} ".
3687 ($args{offset} eq 'all' ? '' : " LIMIT $self->{perpage} OFFSET ".$args{offset}*$self->{perpage});
3688 my $ulist = $dbh->selectall_arrayref($sql, { Slice => {} }, (@filterargs) );
3689 $errstr = $dbh->errstr if !$ulist;
3690 return $ulist;
3691} # end getLocList()
3692
3693
3694## DNSDB::getLocDropdown()
3695# Get a list of location names for use in a dropdown menu.
3696# Takes a database handle, current group, and optional "tag this as selected" flag.
3697# Returns a reference to a list of hashrefs suitable to feeding to HTML::Template
3698sub getLocDropdown {
3699 my $self = shift;
3700 my $dbh = $self->{dbh};
3701 my $grp = shift;
3702 my $sel = shift || '';
3703
3704 my $sth = $dbh->prepare(qq(
3705 SELECT description,location FROM locations
3706 WHERE group_id=?
3707 ORDER BY description
3708 ) );
3709 $sth->execute($grp);
3710
3711 my @loclist;
3712 push @loclist, { locname => "(Default/All)", loc => '', selected => ($sel ? 0 : ($sel eq '' ? 1 : 0)) };
3713 while (my ($locname, $loc) = $sth->fetchrow_array) {
3714 my %row = (
3715 locname => $locname,
3716 loc => $loc,
3717 selected => ($sel eq $loc ? 1 : 0)
3718 );
3719 push @loclist, \%row;
3720 }
3721 return \@loclist;
3722} # end getLocDropdown()
3723
3724
3725## DNSDB::getSOA()
3726# Return all suitable fields from an SOA record in separate elements of a hash
3727# Takes a database handle, default/live flag, domain/reverse flag, and parent ID
3728sub getSOA {
3729 $errstr = '';
3730 my $self = shift;
3731 my $dbh = $self->{dbh};
3732 my $def = shift;
3733 my $rev = shift;
3734 my $id = shift;
3735
3736 # (ab)use distance and weight columns to store SOA data? can't for default_rev_records...
3737 # - should really attach serial to the zone parent somewhere
3738
3739 my $sql = "SELECT record_id,host,val,ttl from "._rectable($def,$rev).
3740 " WHERE "._recparent($def,$rev)." = ? AND type=$reverse_typemap{SOA}";
3741 my $ret = $dbh->selectrow_hashref($sql, undef, ($id) );
3742 return if !$ret;
3743##fixme: stick a flag somewhere if the record doesn't exist. by the API, this is an impossible case, but...
3744
3745 ($ret->{contact},$ret->{prins}) = split /:/, $ret->{host};
3746 delete $ret->{host};
3747 ($ret->{refresh},$ret->{retry},$ret->{expire},$ret->{minttl}) = split /:/, $ret->{val};
3748 delete $ret->{val};
3749
3750 return $ret;
3751} # end getSOA()
3752
3753
3754## DNSDB::updateSOA()
3755# Update the specified SOA record
3756# Takes a database handle, default/live flag, forward/reverse flag, and SOA data hash
3757# Returns a two-element list with a result code and message
3758sub updateSOA {
3759 my $self = shift;
3760 my $dbh = $self->{dbh};
3761 my $defrec = shift;
3762 my $revrec = shift;
3763
3764 my %soa = @_;
3765
3766 my $oldsoa = $self->getSOA($defrec, $revrec, $soa{id});
3767
3768 my $msg;
3769 my %logdata;
3770 if ($defrec eq 'n') {
3771 $logdata{domain_id} = $soa{id} if $revrec eq 'n';
3772 $logdata{rdns_id} = $soa{id} if $revrec eq 'y';
3773 $logdata{group_id} = $self->parentID(id => $soa{id}, revrec => $revrec,
3774 type => ($revrec eq 'n' ? 'domain' : 'revzone') );
3775 } else {
3776 $logdata{group_id} = $soa{id};
3777 }
3778 my $parname = ($defrec eq 'y' ? $self->groupName($soa{id}) :
3779 ($revrec eq 'n' ? $self->domainName($soa{id}) : $self->revName($soa{id})) );
3780
3781 # Allow transactions, and raise an exception on errors so we can catch it later.
3782 # Use local to make sure these get "reset" properly on exiting this block
3783 local $dbh->{AutoCommit} = 0;
3784 local $dbh->{RaiseError} = 1;
3785
3786 eval {
3787 if (!$oldsoa) {
3788 # old SOA record is missing for some reason. create a new one.
3789 my $sql = "INSERT INTO "._rectable($defrec, $revrec)." ("._recparent($defrec, $revrec).
3790 ", host, type, val, ttl) VALUES (?,?,6,?,?)";
3791 $dbh->do($sql, undef, ($soa{id}, "$soa{contact}:$soa{prins}",
3792 "$soa{refresh}:$soa{retry}:$soa{expire}:$soa{minttl}", $soa{ttl}) );
3793 $msg = ($defrec eq 'y' ? ($revrec eq 'y' ? 'Default reverse ' : 'Default ') : '').
3794 "SOA missing for $parname; added (ns $soa{prins}, contact $soa{contact}, refresh $soa{refresh},".
3795 " retry $soa{retry}, expire $soa{expire}, minTTL $soa{minttl}, TTL $soa{ttl})";
3796 } else {
3797 my $sql = "UPDATE "._rectable($defrec, $revrec)." SET host=?, val=?, ttl=? WHERE record_id=? AND type=6";
3798 $dbh->do($sql, undef, ("$soa{contact}:$soa{prins}", "$soa{refresh}:$soa{retry}:$soa{expire}:$soa{minttl}",
3799 $soa{ttl}, $oldsoa->{record_id}) );
3800 $msg = "Updated ".($defrec eq 'y' ? ($revrec eq 'y' ? 'default reverse ' : 'default ') : '').
3801 "SOA for $parname: ".
3802 "(ns $oldsoa->{prins}, contact $oldsoa->{contact}, refresh $oldsoa->{refresh},".
3803 " retry $oldsoa->{retry}, expire $oldsoa->{expire}, minTTL $oldsoa->{minttl}, TTL $oldsoa->{ttl}) to ".
3804 "(ns $soa{prins}, contact $soa{contact}, refresh $soa{refresh},".
3805 " retry $soa{retry}, expire $soa{expire}, minTTL $soa{minttl}, TTL $soa{ttl})";
3806 }
3807 $logdata{entry} = $msg;
3808 $self->_log(%logdata);
3809
3810 $dbh->commit;
3811 };
3812 if ($@) {
3813 $msg = $@;
3814 eval { $dbh->rollback; };
3815 $logdata{entry} = "Error updating ".($defrec eq 'y' ? ($revrec eq 'y' ? 'default reverse zone ' : 'default ') : '').
3816 "SOA record for $parname: $msg";
3817 if ($self->{log_failures}) {
3818 $self->_log(%logdata);
3819 $dbh->commit;
3820 }
3821 return ('FAIL', $logdata{entry});
3822 } else {
3823 return ('OK', $msg);
3824 }
3825} # end updateSOA()
3826
3827
3828## DNSDB::getRecLine()
3829# Return all data fields for a zone record in separate elements of a hash
3830# Takes a database handle, default/live flag, forward/reverse flag, and record ID
3831sub getRecLine {
3832 $errstr = '';
3833 my $self = shift;
3834 my $dbh = $self->{dbh};
3835 my $defrec = shift;
3836 my $revrec = shift;
3837 my $id = shift;
3838
3839##fixme: do we need a knob to twist to switch between unix epoch and postgres time string?
3840 my $sql = "SELECT record_id,host,type,val,ttl".
3841 ($defrec eq 'n' ? ',location' : '').
3842 ($revrec eq 'n' ? ',distance,weight,port' : '').
3843 (($defrec eq 'y') ? ',group_id FROM ' : ',domain_id,rdns_id,stamp,stamp < now() AS ispast,expires,stampactive FROM ').
3844 _rectable($defrec,$revrec)." WHERE record_id=?";
3845 my $ret = $dbh->selectrow_hashref($sql, undef, ($id) );
3846
3847 if ($dbh->err) {
3848 $errstr = $DBI::errstr;
3849 return undef;
3850 }
3851
3852 if (!$ret) {
3853 $errstr = "No such record";
3854 return undef;
3855 }
3856
3857 # explicitly set a parent id
3858 if ($defrec eq 'y') {
3859 $ret->{parid} = $ret->{group_id};
3860 } else {
3861 $ret->{parid} = (($revrec eq 'n') ? $ret->{domain_id} : $ret->{rdns_id});
3862 # and a secondary if we have a custom type that lives in both a forward and reverse zone
3863 $ret->{secid} = (($revrec eq 'y') ? $ret->{domain_id} : $ret->{rdns_id}) if $ret->{type} > 65279;
3864 }
3865 $ret->{address} = $ret->{val}; # because.
3866
3867 return $ret;
3868}
3869
3870
3871##fixme: should use above (getRecLine()) to get lines for below?
3872## DNSDB::getRecList()
3873# Return records for a group or zone
3874# Takes a default/live flag, group or zone ID, start,
3875# number of records, sort field, and sort order
3876# Returns a reference to an array of hashes
3877sub getRecList {
3878 $errstr = '';
3879 my $self = shift;
3880 my $dbh = $self->{dbh};
3881
3882 my %args = @_;
3883
3884 # protection against bad or missing arguments
3885 $args{sortorder} = 'ASC' if !$args{sortorder} || !grep /^$args{sortorder}$/, ('ASC','DESC');
3886 my $defsort;
3887 $defsort = 'host' if $args{revrec} eq 'n'; # default sort by host on domain record list
3888 $defsort = 'val' if $args{revrec} eq 'y'; # default sort by IP on revzone record list
3889 $args{sortby} = '' if !$args{sortby};
3890 $args{sortby} = $defsort if !$args{revrec};
3891 $args{sortby} = $defsort if $args{sortby} !~ /^[\w_,.]+$/;
3892 $args{offset} = 0 if !$args{offset} || $args{offset} !~ /^(?:all|\d+)$/;
3893 my $perpage = ($args{nrecs} ? $args{nrecs} : $self->{perpage});
3894
3895 # sort reverse zones on IP, correctly
3896 # do other fiddling with $args{sortby} while we're at it.
3897 # whee! multisort means just passing comma-separated fields in sortby!
3898 my $newsort = '';
3899 foreach my $sf (split /,/, $args{sortby}) {
3900 $sf = "r.$sf";
3901 $sf =~ s/r\.val/inetlazy(r.val)/
3902 if $args{revrec} eq 'y' && $args{defrec} eq 'n';
3903 $sf =~ s/r\.type/t.alphaorder/;
3904 $newsort .= ",$sf";
3905 }
3906 $newsort =~ s/^,//;
3907
3908 my @bindvars = ($args{id});
3909 push @bindvars, ($args{filter},$args{filter}) if $args{filter};
3910
3911##fixme: do we need a knob to twist to switch from unix epoch to postgres time string?
3912 my $sql = "SELECT r.record_id,r.host,r.type,r.val,r.ttl";
3913 $sql .= ",l.description AS locname,stamp,r.stamp < now() AS ispast,r.expires,r.stampactive"
3914 if $args{defrec} eq 'n';
3915 $sql .= ",r.distance,r.weight,r.port" if $args{revrec} eq 'n';
3916 $sql .= " FROM "._rectable($args{defrec},$args{revrec})." r ";
3917 $sql .= "INNER JOIN rectypes t ON r.type=t.val "; # for sorting by type alphabetically
3918 $sql .= "LEFT JOIN locations l ON r.location=l.location " if $args{defrec} eq 'n';
3919 $sql .= "WHERE "._recparent($args{defrec},$args{revrec})." = ?";
3920 $sql .= " AND NOT r.type=$reverse_typemap{SOA}";
3921 if ($args{filter}) {
3922 $sql .= " AND (r.host ~* ? OR r.val ~* ? OR r.host ~* ? OR r.val ~* ?)";
3923 my $tmp = join('.',reverse(split(/\./,$args{filter})));
3924 push @bindvars, ($tmp, $tmp);
3925 }
3926 $sql .= " ORDER BY $newsort $args{sortorder}";
3927 # ensure consistent ordering by sorting on record_id too
3928 $sql .= ", record_id $args{sortorder}";
3929 $sql .= ($args{offset} eq 'all' ? '' : " LIMIT $perpage OFFSET ".$args{offset}*$perpage);
3930
3931 my @working;
3932 my $recsth = $dbh->prepare($sql);
3933 $recsth->execute(@bindvars);
3934 while (my $rec = $recsth->fetchrow_hashref) {
3935 if ($args{revrec} eq 'y' && $args{defrec} eq 'n' &&
3936 ($self->{showrev_arpa} eq 'record' || $self->{showrev_arpa} eq 'all') &&
3937 $rec->{val} !~ /\.arpa$/ ) {
3938 # skip all reverse zone .arpa "hostnames" since they're already .arpa names.
3939##enhance: extend {showrev_arpa} eq 'record' to specify record types
3940 my $tmpip = new NetAddr::IP $rec->{val};
3941 $rec->{val} = DNSDB::_ZONE($tmpip, 'ZONE', 'r', '.').($tmpip->{isv6} ? '.ip6.arpa' : '.in-addr.arpa') if $tmpip;
3942 }
3943 push @working, $rec;
3944 }
3945 return \@working;
3946} # end getRecList()
3947
3948
3949## DNSDB::getRecCount()
3950# Return count of non-SOA records in zone (or default records in a group)
3951# Takes a database handle, default/live flag, reverse/forward flag, group/domain ID,
3952# and optional filtering modifier
3953# Returns the count
3954sub getRecCount {
3955 my $self = shift;
3956 my $dbh = $self->{dbh};
3957 my $defrec = shift;
3958 my $revrec = shift;
3959 my $id = shift;
3960 my $filter = shift || '';
3961
3962 # keep the nasties down, since we can't ?-sub this bit. :/
3963 # note this is chars allowed in DNS hostnames
3964 $filter =~ s/[^a-zA-Z0-9_.:-]//g;
3965
3966 my @bindvars = ($id);
3967 push @bindvars, ($filter,$filter) if $filter;
3968 my $sql = "SELECT count(*) FROM ".
3969 _rectable($defrec,$revrec).
3970 " WHERE "._recparent($defrec,$revrec)."=? ".
3971 "AND NOT type=$reverse_typemap{SOA}";
3972 if ($filter) {
3973 $sql .= " AND (r.host ~* ? OR r.val ~* ? OR r.host ~* ? OR r.val ~* ?)";
3974 my $tmp = join('.',reverse(split(/\./,$filter)));
3975 push @bindvars, ($tmp, $tmp);
3976 }
3977 $sql .= " AND (host ~* ? OR val ~* ? OR host ~* ? OR val ~* ?)" if $filter;
3978 my $tmp = join('.',reverse(split(/\./,$filter)));
3979 push @bindvars, ($tmp, $tmp) if $filter;
3980
3981 my ($count) = $dbh->selectrow_array($sql, undef, (@bindvars) );
3982
3983 return $count;
3984
3985} # end getRecCount()
3986
3987
3988## DNSDB::addRec()
3989# Add a new record to a domain or a group's default records
3990# Takes a database handle, default/live flag, group/domain ID,
3991# host, type, value, and TTL
3992# Some types require additional detail: "distance" for MX and SRV,
3993# and weight/port for SRV
3994# Returns a status code and detail message in case of error
3995##fixme: pass a hash with the record data, not a series of separate values
3996sub addRec {
3997 $errstr = '';
3998 my $self = shift;
3999 my $dbh = $self->{dbh};
4000 my $defrec = shift;
4001 my $revrec = shift;
4002 my $id = shift; # parent (group_id for defrecs, rdns_id for reverse records,
4003 # domain_id for domain records)
4004
4005 my $host = shift;
4006 my $rectype = shift; # reference so we can coerce it if "+"-types can't find both zones
4007 my $val = shift;
4008 my $ttl = shift;
4009 my $location = shift;
4010 $location = '' if !$location;
4011
4012 my $expires = shift;
4013 $expires = 1 if $expires eq 'until'; # Turn some special values into the appropriate booleans.
4014 $expires = 0 if $expires eq 'after';
4015 my $stamp = shift;
4016 $stamp = '' if !$stamp; # Timestamp should be a string at this point.
4017
4018 # Spaces are evil.
4019 $$host =~ s/^\s+//;
4020 $$host =~ s/\s+$//;
4021 if ($typemap{$$rectype} ne 'TXT') {
4022 # Leading or trailng spaces could be legit in TXT records.
4023 $$val =~ s/^\s+//;
4024 $$val =~ s/\s+$//;
4025 }
4026
4027 _caseclean($rectype, $host, $val, $defrec, $revrec) if $self->{lowercase};
4028
4029 # prep for validation
4030 my $addr = NetAddr::IP->new($$val) if _maybeip($val);
4031 $$host =~ s/\.+$//; # FQDNs ending in . are an internal detail, and really shouldn't be exposed in the UI.
4032
4033 my $domid = 0;
4034 my $revid = 0;
4035
4036 my $retcode = 'OK'; # assume everything will go OK
4037 my $retmsg = '';
4038
4039 # do simple validation first
4040 return ('FAIL', "TTL must be numeric") unless $ttl =~ /^-?\d+$/;
4041
4042 # Collect these even if we're only doing a simple A record so we can call *any* validation sub
4043 my $dist = shift;
4044 my $weight = shift;
4045 my $port = shift;
4046
4047 my $fields;
4048 my @vallist;
4049
4050 # Call the validation sub for the type requested.
4051 ($retcode,$retmsg) = $validators{$$rectype}($self, defrec => $defrec, revrec => $revrec, id => $id,
4052 host => $host, rectype => $rectype, val => $val, addr => $addr,
4053 dist => \$dist, port => \$port, weight => \$weight,
4054 fields => \$fields, vallist => \@vallist);
4055
4056 return ($retcode,$retmsg) if $retcode eq 'FAIL';
4057
4058 # Set up database fields and bind parameters
4059 $fields .= "host,type,val,ttl,"._recparent($defrec,$revrec);
4060 push @vallist, ($$host,$$rectype,$$val,$ttl,$id);
4061
4062 if ($defrec eq 'n') {
4063 # locations are not for default records, silly coder!
4064 $fields .= ",location";
4065 push @vallist, $location;
4066 # timestamps are rare.
4067 if ($stamp) {
4068 $fields .= ",stamp,expires,stampactive";
4069 push @vallist, $stamp, $expires, 'y';
4070 } else {
4071 $fields .= ",stampactive";
4072 push @vallist, 'n';
4073 }
4074 }
4075
4076 # a little magic to get the right number of ? placeholders based on how many values we're providing
4077 my $vallen = '?'.(',?'x$#vallist);
4078
4079 # Put together the success log entry. We have to use this horrible kludge
4080 # because domain_id and rdns_id may or may not be present, and if they are,
4081 # they're not at a guaranteed consistent index in the array. wheee!
4082 my %logdata;
4083 my @ftmp = split /,/, $fields;
4084 for (my $i=0; $i <= $#vallist; $i++) {
4085 $logdata{domain_id} = $vallist[$i] if $ftmp[$i] eq 'domain_id';
4086 $logdata{rdns_id} = $vallist[$i] if $ftmp[$i] eq 'rdns_id';
4087 }
4088 $logdata{group_id} = $id if $defrec eq 'y';
4089 $logdata{group_id} = $self->parentID(id => $id, type => ($revrec eq 'n' ? 'domain' : 'revzone'), revrec => $revrec)
4090 if $defrec eq 'n';
4091 $logdata{entry} = "Added ".($defrec eq 'y' ? 'default record' : 'record');
4092 # Log reverse records to match the formal .arpa tree
4093 if ($revrec eq 'y') {
4094 $logdata{entry} .= " '$$val $typemap{$$rectype} $$host";
4095 } else {
4096 $logdata{entry} .= " '$$host $typemap{$$rectype} $$val";
4097 }
4098
4099 $logdata{entry} .= " [distance $dist]" if $typemap{$$rectype} eq 'MX';
4100 $logdata{entry} .= " [priority $dist] [weight $weight] [port $port]"
4101 if $typemap{$$rectype} eq 'SRV';
4102 $logdata{entry} .= "', TTL $ttl";
4103 $logdata{entry} .= ", location ".$self->getLoc($location)->{description} if $location;
4104 $logdata{entry} .= ($expires eq 'after' ? ', valid after ' : ', expires at ').$stamp if $stamp;
4105
4106 # Allow transactions, and raise an exception on errors so we can catch it later.
4107 # Use local to make sure these get "reset" properly on exiting this block
4108 local $dbh->{AutoCommit} = 0;
4109 local $dbh->{RaiseError} = 1;
4110
4111 eval {
4112 $dbh->do("INSERT INTO "._rectable($defrec, $revrec)." ($fields) VALUES ($vallen)",
4113 undef, @vallist);
4114 $self->_log(%logdata);
4115 $dbh->commit;
4116 };
4117 if ($@) {
4118 my $msg = $@;
4119 eval { $dbh->rollback; };
4120 if ($self->{log_failures}) {
4121 $logdata{entry} = "Failed adding ".($defrec eq 'y' ? 'default ' : '').
4122 "record '$$host $typemap{$$rectype} $$val', TTL $ttl ($msg)";
4123 $self->_log(%logdata);
4124 $dbh->commit;
4125 }
4126 return ('FAIL',$msg);
4127 }
4128
4129 $resultstr = $logdata{entry};
4130 return ($retcode, $retmsg);
4131
4132} # end addRec()
4133
4134
4135## DNSDB::updateRec()
4136# Update a record
4137# Takes a database handle, default and reverse flags, record ID, immediate parent ID, and new record data.
4138# Returns a status code and message
4139sub updateRec {
4140 $errstr = '';
4141
4142 my $self = shift;
4143 my $dbh = $self->{dbh};
4144 my $defrec = shift;
4145 my $revrec = shift;
4146 my $id = shift;
4147 my $parid = shift; # immediate parent entity that we're descending from to update the record
4148
4149 # all records have these
4150 my $host = shift;
4151 my $hostbk = $$host; # Keep a backup copy of the original, so we can WARN if the update mangles the domain
4152 my $rectype = shift;
4153 my $val = shift;
4154 my $ttl = shift;
4155 my $location = shift; # may be empty/null/undef depending on caller
4156 $location = '' if !$location;
4157
4158 my $expires = shift;
4159 $expires = 1 if $expires eq 'until'; # Turn some special values into the appropriate booleans.
4160 $expires = 0 if $expires eq 'after';
4161 my $stamp = shift;
4162 $stamp = '' if !$stamp; # Timestamp should be a string at this point.
4163
4164 # just set it to an empty string; failures will be caught later.
4165 $$host = '' if !$$host;
4166
4167 # Spaces are evil.
4168 $$host =~ s/^\s+//;
4169 $$host =~ s/\s+$//;
4170 if ($typemap{$$rectype} ne 'TXT') {
4171 # Leading or trailng spaces could be legit in TXT records.
4172 $$val =~ s/^\s+//;
4173 $$val =~ s/\s+$//;
4174 }
4175
4176 _caseclean($rectype, $host, $val, $defrec, $revrec) if $self->{lowercase};
4177
4178 # prep for validation
4179 my $addr = NetAddr::IP->new($$val) if _maybeip($val);
4180 $$host =~ s/\.+$//; # FQDNs ending in . are an internal detail, and really shouldn't be exposed in the UI.
4181
4182 my $domid = 0;
4183 my $revid = 0;
4184
4185 my $retcode = 'OK'; # assume everything will go OK
4186 my $retmsg = '';
4187
4188 # do simple validation first
4189 return ('FAIL', "TTL must be numeric") unless $ttl =~ /^-?\d+$/;
4190
4191 # only MX and SRV will use these
4192 my $dist = shift || 0;
4193 my $weight = shift || 0;
4194 my $port = shift || 0;
4195
4196 my $fields;
4197 my @vallist;
4198
4199 # get old record data so we have the right parent ID
4200 # and for logging (eventually)
4201 my $oldrec = $self->getRecLine($defrec, $revrec, $id);
4202
4203 # Call the validation sub for the type requested.
4204 # Note the ID to pass here is the *parent*, not the record
4205 ($retcode,$retmsg) = $validators{$$rectype}($self, defrec => $defrec, revrec => $revrec,
4206 id => ($defrec eq 'y' ? $oldrec->{group_id} : ($revrec eq 'n' ? $oldrec->{domain_id} : $oldrec->{rdns_id})),
4207 host => $host, rectype => $rectype, val => $val, addr => $addr,
4208 dist => \$dist, port => \$port, weight => \$weight,
4209 fields => \$fields, vallist => \@vallist,
4210 update => $id);
4211
4212 return ($retcode,$retmsg) if $retcode eq 'FAIL';
4213
4214 # Set up database fields and bind parameters. Note only the optional fields
4215 # (distance, weight, port, secondary parent ID) are added in the validation call above
4216 $fields .= "host,type,val,ttl,"._recparent($defrec,$revrec);
4217 push @vallist, ($$host,$$rectype,$$val,$ttl,
4218 ($defrec eq 'y' ? $oldrec->{group_id} : ($revrec eq 'n' ? $oldrec->{domain_id} : $oldrec->{rdns_id})) );
4219
4220 if ($defrec eq 'n') {
4221 # locations are not for default records, silly coder!
4222 $fields .= ",location";
4223 push @vallist, $location;
4224 # timestamps are rare.
4225 if ($stamp) {
4226 $fields .= ",stamp,expires,stampactive";
4227 push @vallist, $stamp, $expires, 'y';
4228 } else {
4229 $fields .= ",stampactive";
4230 push @vallist, 'n';
4231 }
4232 }
4233
4234 # hack hack PTHUI
4235 # need to forcibly make sure we disassociate a record with a parent it's no longer related to.
4236 # eg, PTR records may not have a domain parent, or A/AAAA records may not have a revzone parent.
4237 # needed for crossover types that got coerced down to "standard" types due to data changes
4238 # need to *avoid* funky records being updated like A/AAAA records in revzones, or PTRs in forward zones.
4239 if ($defrec eq 'n' && $oldrec->{type} > 65000) {
4240 if ($$rectype == $reverse_typemap{PTR}) {
4241 $fields .= ",domain_id";
4242 push @vallist, 0;
4243 }
4244 if ($$rectype == $reverse_typemap{A} || $$rectype == $reverse_typemap{AAAA}) {
4245 $fields .= ",rdns_id";
4246 push @vallist, 0;
4247 }
4248 }
4249 # fix fat-finger-originated record type changes
4250 if ($$rectype == 65285) { # delegation
4251 $fields .= ",rdns_id" if $revrec eq 'n';
4252 $fields .= ",domain_id" if $revrec eq 'y';
4253 push @vallist, 0;
4254 }
4255 # ... and now make sure we *do* associate a record with the "calling" parent
4256 if ($defrec eq 'n') {
4257 $domid = $parid if $revrec eq 'n';
4258 $revid = $parid if $revrec eq 'y';
4259 }
4260
4261 # Put together the success log entry. Horrible kludge from addRec() copied as-is since
4262 # we don't know whether the passed arguments or retrieved values for domain_id and rdns_id
4263 # will be maintained (due to "not-in-zone" validation changes)
4264 my %logdata;
4265 $logdata{domain_id} = $domid;
4266 $logdata{rdns_id} = $revid;
4267 my @ftmp = split /,/, $fields;
4268 for (my $i=0; $i <= $#vallist; $i++) {
4269 $logdata{domain_id} = $vallist[$i] if $ftmp[$i] eq 'domain_id';
4270 $logdata{rdns_id} = $vallist[$i] if $ftmp[$i] eq 'rdns_id';
4271 }
4272 $logdata{group_id} = $parid if $defrec eq 'y';
4273 $logdata{group_id} = $self->parentID(id => $parid, type => ($revrec eq 'n' ? 'domain' : 'revzone'), revrec => $revrec)
4274 if $defrec eq 'n';
4275 $logdata{entry} = "Updated ".($defrec eq 'y' ? 'default record' : 'record')." from\n";
4276 # Log reverse records "naturally", since they're stored, um, unnaturally.
4277 if ($revrec eq 'y') {
4278 $logdata{entry} .= " '$oldrec->{val} $typemap{$oldrec->{type}} $oldrec->{host}";
4279 } else {
4280 $logdata{entry} .= " '$oldrec->{host} $typemap{$oldrec->{type}} $oldrec->{val}";
4281 }
4282 $logdata{entry} .= " [distance $oldrec->{distance}]" if $typemap{$oldrec->{type}} eq 'MX';
4283 $logdata{entry} .= " [priority $oldrec->{distance}] [weight $oldrec->{weight}] [port $oldrec->{port}]"
4284 if $typemap{$oldrec->{type}} eq 'SRV';
4285 $logdata{entry} .= "', TTL $oldrec->{ttl}";
4286 $logdata{entry} .= ", location ".$self->getLoc($oldrec->{location})->{description} if $oldrec->{location};
4287 $logdata{entry} .= ($oldrec->{expires} ? ', expires at ' : ', valid after ').$oldrec->{stamp}
4288 if $oldrec->{stampactive};
4289 $logdata{entry} .= "\nto\n";
4290 # Log reverse records "naturally", since they're stored, um, unnaturally.
4291 if ($revrec eq 'y') {
4292 $logdata{entry} .= "'$$val $typemap{$$rectype} $$host";
4293 } else {
4294 $logdata{entry} .= "'$$host $typemap{$$rectype} $$val";
4295 }
4296 $logdata{entry} .= " [distance $dist]" if $typemap{$$rectype} eq 'MX';
4297 $logdata{entry} .= " [priority $dist] [weight $weight] [port $port]" if $typemap{$$rectype} eq 'SRV';
4298 $logdata{entry} .= "', TTL $ttl";
4299 $logdata{entry} .= ", location ".$self->getLoc($location)->{description} if $location;
4300 $logdata{entry} .= ($expires eq 'after' ? ', valid after ' : ', expires at ').$stamp if $stamp;
4301
4302 local $dbh->{AutoCommit} = 0;
4303 local $dbh->{RaiseError} = 1;
4304
4305 # Fiddle the field list into something suitable for updates
4306 $fields =~ s/,/=?,/g;
4307 $fields .= "=?";
4308
4309 eval {
4310 $dbh->do("UPDATE "._rectable($defrec,$revrec)." SET $fields WHERE record_id=?", undef, (@vallist, $id) );
4311 $self->_log(%logdata);
4312 $dbh->commit;
4313 };
4314 if ($@) {
4315 my $msg = $@;
4316 eval { $dbh->rollback; };
4317 if ($self->{log_failures}) {
4318 $logdata{entry} = "Failed updating ".($defrec eq 'y' ? 'default ' : '').
4319 "record '$oldrec->{host} $typemap{$oldrec->{type}} $oldrec->{val}', TTL $oldrec->{ttl} ($msg)";
4320 $self->_log(%logdata);
4321 $dbh->commit;
4322 }
4323 return ('FAIL', $msg);
4324 }
4325
4326 $resultstr = $logdata{entry};
4327 return ($retcode, $retmsg);
4328} # end updateRec()
4329
4330
4331## DNSDB::downconvert()
4332# A mostly internal (not exported) semiutilty sub to downconvert from pseudotype <x>
4333# to a compatible component type. Only a handful of operations are valid, anything
4334# else is a null-op.
4335# Takes the record ID and the new type. Returns boolean.
4336sub downconvert {
4337 my $self = shift;
4338 my $dbh = $self->{dbh};
4339 my $recid = shift;
4340 my $newtype = shift;
4341
4342 # also, only work on live records; little to no value trying to do this on default records.
4343 my $rec = $self->getRecLine('n', 'y', $recid);
4344
4345 # hm?
4346 #return 1 if !$rec;
4347
4348 return 1 if $rec->{type} < 65000; # Only the reverse-record pseudotypes can be downconverted
4349 return 1 if $rec->{type} == 65282; # Nowhere to go
4350
4351 my $delpar;
4352 my @sqlargs;
4353 if ($rec->{type} == 65280) {
4354 return 1 if $newtype != 1 && $newtype != 12;
4355 $delpar = ($newtype == 1 ? 'rdns_id' : 'domain_id');
4356 push @sqlargs, 0, $newtype, $recid;
4357 } elsif ($rec->{type} == 65281) {
4358 return 1 if $newtype != 28 && $newtype != 12;
4359 $delpar = ($newtype == 28 ? 'rdns_id' : 'domain_id');
4360 push @sqlargs, 0, $newtype, $recid;
4361 } elsif ($rec->{type} == 65283) {
4362 return 1 if $newtype != 65282;
4363 $delpar = 'rdns_id';
4364 } elsif ($rec->{type} == 65284) {
4365 return 1 if $newtype != 65282;
4366 $delpar = 'rdns_id';
4367 } else {
4368 # Your llama is on fire.
4369 }
4370
4371 local $dbh->{AutoCommit} = 0;
4372 local $dbh->{RaiseError} = 1;
4373
4374 eval {
4375 $dbh->do("UPDATE records SET $delpar = ?, type = ? WHERE record_id = ?", undef, @sqlargs);
4376 $dbh->commit;
4377 };
4378 if ($@) {
4379 $errstr = $@;
4380 eval { $dbh->rollback; };
4381 return 0;
4382 }
4383 return 1;
4384} # end downconvert()
4385
4386
4387## DNSDB::delRec()
4388# Delete a record.
4389sub delRec {
4390 $errstr = '';
4391 my $self = shift;
4392 my $dbh = $self->{dbh};
4393 my $defrec = shift;
4394 my $revrec = shift;
4395 my $id = shift;
4396
4397 my $oldrec = $self->getRecLine($defrec, $revrec, $id);
4398
4399 # Allow transactions, and raise an exception on errors so we can catch it later.
4400 # Use local to make sure these get "reset" properly on exiting this block
4401 local $dbh->{AutoCommit} = 0;
4402 local $dbh->{RaiseError} = 1;
4403
4404 # Put together the log entry
4405 my %logdata;
4406 $logdata{domain_id} = $oldrec->{domain_id};
4407 $logdata{rdns_id} = $oldrec->{rdns_id};
4408 $logdata{group_id} = $oldrec->{group_id} if $defrec eq 'y';
4409 $logdata{group_id} = $self->parentID(id => $oldrec->{domain_id}, type => ($revrec eq 'n' ? 'domain' : 'revzone'),
4410 revrec => $revrec)
4411 if $defrec eq 'n';
4412 $logdata{entry} = "Deleted ".($defrec eq 'y' ? 'default record ' : 'record ').
4413 "'$oldrec->{host} $typemap{$oldrec->{type}} $oldrec->{val}";
4414 $logdata{entry} .= " [distance $oldrec->{distance}]" if $typemap{$oldrec->{type}} eq 'MX';
4415 $logdata{entry} .= " [priority $oldrec->{distance}] [weight $oldrec->{weight}] [port $oldrec->{port}]"
4416 if $typemap{$oldrec->{type}} eq 'SRV';
4417 $logdata{entry} .= "', TTL $oldrec->{ttl}";
4418 $logdata{entry} .= ", location ".$self->getLoc($oldrec->{location})->{description} if $oldrec->{location};
4419
4420 eval {
4421 my $sth = $dbh->do("DELETE FROM "._rectable($defrec,$revrec)." WHERE record_id=?", undef, ($id));
4422 $self->_log(%logdata);
4423 $dbh->commit;
4424 };
4425 if ($@) {
4426 my $msg = $@;
4427 eval { $dbh->rollback; };
4428 if ($self->{log_failures}) {
4429 $logdata{entry} = "Error deleting ".($defrec eq 'y' ? 'default record' : 'record').
4430 " '$oldrec->{host} $typemap{$oldrec->{type}} $oldrec->{val}', TTL $oldrec->{ttl} ($msg)";
4431 $self->_log(%logdata);
4432 $dbh->commit;
4433 }
4434 return ('FAIL', $msg);
4435 }
4436
4437 return ('OK',$logdata{entry});
4438} # end delRec()
4439
4440
4441## DNSDB::getLogCount()
4442# Get a count of log entries
4443# Takes a database handle and a hash containing at least:
4444# - Entity ID and entity type as the primary log "slice"
4445sub getLogCount {
4446 my $self = shift;
4447 my $dbh = $self->{dbh};
4448
4449 my %args = @_;
4450
4451 my @filterargs;
4452##fixme: which fields do we want to filter on?
4453# push @filterargs,
4454
4455 $errstr = 'Missing primary parent ID and/or type';
4456 # fail early if we don't have a "prime" ID to look for log entries for
4457 return if !$args{id};
4458
4459 # or if the prime id type is missing or invalid
4460 return if !$args{logtype};
4461 $args{logtype} = 'revzone' if $args{logtype} eq 'rdns'; # hack pthui
4462 $args{logtype} = 'domain' if $args{logtype} eq 'dom'; # hack pthui
4463 return if !grep /^$args{logtype}$/, ('group', 'domain', 'revzone', 'user');
4464
4465 my $sql = "SELECT count(*) FROM log ".
4466 "WHERE $id_col{$args{logtype}}=?".
4467 ($args{filter} ? " AND entry ~* ?" : '');
4468 my ($count) = $dbh->selectrow_array($sql, undef, ($args{id}, @filterargs) );
4469 $errstr = $dbh->errstr if !$count;
4470 return $count;
4471} # end getLogCount()
4472
4473
4474## DNSDB::getLogEntries()
4475# Get a list of log entries
4476# Takes arguments as with getLogCount() above, plus optional:
4477# - sort field
4478# - sort order
4479# - offset for pagination
4480sub getLogEntries {
4481 my $self = shift;
4482 my $dbh = $self->{dbh};
4483
4484 my %args = @_;
4485
4486 my @filterargs;
4487
4488 # fail early if we don't have a "prime" ID to look for log entries for
4489 return if !$args{id};
4490
4491 # or if the prime id type is missing or invalid
4492 return if !$args{logtype};
4493 $args{logtype} = 'revzone' if $args{logtype} eq 'rdns'; # hack pthui
4494 $args{logtype} = 'domain' if $args{logtype} eq 'dom'; # hack pthui
4495 return if !grep /^$args{logtype}$/, ('group', 'domain', 'revzone', 'user');
4496
4497 # Sorting defaults
4498 $args{sortorder} = 'DESC' if !$args{sortorder} || !grep /^$args{sortorder}$/, ('ASC','DESC');
4499 $args{sortby} = 'stamp' if !$args{sortby} || $args{sortby} !~ /^[\w_.]+$/;
4500 $args{offset} = 0 if !$args{offset} || $args{offset} !~ /^(?:all|\d+)$/;
4501
4502 my %sortmap = (fname => 'name', username => 'email', entry => 'entry', stamp => 'stamp');
4503 $args{sortby} = $sortmap{$args{sortby}};
4504
4505 my $sql = "SELECT user_id AS userid, email AS useremail, name AS userfname, entry AS logentry, ".
4506 "date_trunc('second',stamp) AS logtime ".
4507 "FROM log ".
4508 "WHERE $id_col{$args{logtype}}=?".
4509 ($args{filter} ? " AND entry ~* ?" : '').
4510 " ORDER BY $args{sortby} $args{sortorder}, log_id $args{sortorder}".
4511 ($args{offset} eq 'all' ? '' : " LIMIT $self->{perpage} OFFSET ".$args{offset}*$self->{perpage});
4512 my $loglist = $dbh->selectall_arrayref($sql, { Slice => {} }, ($args{id}, @filterargs) );
4513 $errstr = $dbh->errstr if !$loglist;
4514 return $loglist;
4515} # end getLogEntries()
4516
4517
4518## IPDB::getRevPattern()
4519# Get the narrowest template pattern applicable to a passed CIDR address (may be a netblock or an IP)
4520sub getRevPattern {
4521 my $self = shift;
4522 my $dbh = $self->{dbh};
4523 my $cidr = shift;
4524 my $group = shift || 1; # just in case
4525
4526 # for speed! Casting and comparing even ~7K records takes ~2.5s, so narrow it down to one revzone first.
4527 my ($revid) = $dbh->selectrow_array("SELECT rdns_id FROM revzones WHERE revnet >>= ? AND group_id = ?",
4528 undef, ($cidr, $group) );
4529
4530##fixme? may need to narrow things down more by octet-chopping and doing text comparisons before casting.
4531 my ($revpatt) = $dbh->selectrow_array("SELECT host FROM records ".
4532 "WHERE (type in (12,65280,65281,65282,65283,65284)) AND rdns_id = ? AND inetlazy(val) >>= ? ".
4533 "ORDER BY inetlazy(val) DESC LIMIT 1", undef, ($revid, $cidr) );
4534 return $revpatt;
4535} # end getRevPattern()
4536
4537
4538## DNSDB::getTypelist()
4539# Get a list of record types for various UI dropdowns
4540# Takes database handle, forward/reverse/lookup flag, and optional "tag as selected" indicator (defaults to A)
4541# Returns an arrayref to list of hashrefs perfect for HTML::Template
4542sub getTypelist {
4543 my $self = shift;
4544 my $dbh = $self->{dbh};
4545 my $recgroup = shift;
4546 my $type = shift || $reverse_typemap{A};
4547
4548 # also accepting $webvar{revrec}!
4549 $recgroup = 'f' if $recgroup eq 'n';
4550 $recgroup = 'r' if $recgroup eq 'y';
4551
4552 my $sql = "SELECT val,name FROM rectypes WHERE ";
4553 if ($recgroup eq 'r') {
4554 # reverse zone types
4555 $sql .= "stdflag=2 OR stdflag=3";
4556 } elsif ($recgroup eq 'l') {
4557 # DNS lookup types. Note we avoid our custom types >= 65280, since those are entirely internal.
4558 $sql .= "(stdflag=1 OR stdflag=2 OR stdflag=3) AND val < 65280";
4559 } else {
4560 # default; forward zone types. technically $type eq 'f' but not worth the error message.
4561 $sql .= "stdflag=1 OR stdflag=2";
4562 $sql .= " AND val < 65280" if $recgroup eq 'fo'; # An extra flag to trim off the pseudotypes as well.
4563 }
4564 $sql .= " ORDER BY listorder";
4565
4566 my $sth = $dbh->prepare($sql);
4567 $sth->execute;
4568 my @typelist;
4569 # track whether the passed type is in the list at all. allows you to edit a record
4570 # that wouldn't otherwise be generally available in that zone (typically, reverse zones)
4571 # without changing its type (accidentally or otherwise)
4572 my $selflag = 0;
4573 while (my ($rval,$rname) = $sth->fetchrow_array()) {
4574 my %row = ( recval => $rval, recname => $rname );
4575 if ($rval == $type) {
4576 $row{tselect} = 1;
4577 $selflag = 1;
4578 }
4579 push @typelist, \%row;
4580 }
4581
4582 # add the passed type if it wasn't in the list
4583 if (!$selflag) {
4584 my %row = ( recval => $type, recname => $typemap{$type}, tselect => 1 );
4585 push @typelist, \%row;
4586 }
4587
4588 # Add SOA on lookups since it's not listed in other dropdowns.
4589 if ($recgroup eq 'l') {
4590 my %row = ( recval => $reverse_typemap{SOA}, recname => 'SOA' );
4591 $row{tselect} = 1 if $reverse_typemap{SOA} == $type;
4592 push @typelist, \%row;
4593 }
4594
4595 return \@typelist;
4596} # end getTypelist()
4597
4598
4599## DNSDB::parentID()
4600# Get ID of entity that is nearest parent to requested id
4601# Takes a database handle and a hash of entity ID, entity type, optional parent type flag
4602# (domain/reverse zone or group), and optional default/live and forward/reverse flags
4603# Returns the ID or undef on failure
4604sub parentID {
4605 my $self = shift;
4606 my $dbh = $self->{dbh};
4607
4608 my %args = @_;
4609
4610 # clean up the parent-type. Set it to group if not set; coerce revzone to domain for simpler logic
4611 $args{partype} = 'group' if !$args{partype};
4612 $args{partype} = 'domain' if $args{partype} eq 'revzone';
4613
4614 # clean up defrec and revrec. default to live record, forward zone
4615 $args{defrec} = 'n' if !$args{defrec};
4616 $args{revrec} = 'n' if !$args{revrec};
4617
4618 if ($par_type{$args{partype}} eq 'domain') {
4619 # only live records can have a domain/zone parent
4620 return unless ($args{type} eq 'record' && $args{defrec} eq 'n');
4621 my $result = $dbh->selectrow_hashref("SELECT ".($args{revrec} eq 'n' ? 'domain_id' : 'rdns_id').
4622 " FROM records WHERE record_id = ?",
4623 undef, ($args{id}) ) or return;
4624 return $result;
4625 } else {
4626 # snag some arguments that will either fall through or be overwritten to save some code duplication
4627 my $tmpid = $args{id};
4628 my $type = $args{type};
4629 if ($type eq 'record' && $args{defrec} eq 'n') {
4630 # Live records go through the records table first.
4631 ($tmpid) = $dbh->selectrow_array("SELECT ".($args{revrec} eq 'n' ? 'domain_id' : 'rdns_id').
4632 " FROM records WHERE record_id = ?",
4633 undef, ($args{id}) ) or return;
4634 $type = ($args{revrec} eq 'n' ? 'domain' : 'revzone');
4635 }
4636 my ($result) = $dbh->selectrow_array("SELECT $par_col{$type} FROM $par_tbl{$type} WHERE $id_col{$type} = ?",
4637 undef, ($tmpid) );
4638 return $result;
4639 }
4640# should be impossible to get here with even remotely sane arguments
4641 return;
4642} # end parentID()
4643
4644
4645## DNSDB::isParent()
4646# Returns true if $id1 is a parent of $id2, false otherwise
4647sub isParent {
4648 my $self = shift;
4649 my $dbh = $self->{dbh};
4650 my $id1 = shift;
4651 my $type1 = shift;
4652 my $id2 = shift;
4653 my $type2 = shift;
4654##todo: immediate, secondary, full (default)
4655
4656 # Return false on invalid types
4657 return 0 if !grep /^$type1$/, ('record','defrec','defrevrec','user','domain','revzone','group');
4658 return 0 if !grep /^$type2$/, ('record','defrec','defrevrec','user','domain','revzone','group');
4659
4660 # Return false on impossible relations
4661 return 0 if $type1 eq 'record'; # nothing may be a child of a record
4662 return 0 if $type1 eq 'defrec'; # nothing may be a child of a record
4663 return 0 if $type1 eq 'defrevrec'; # nothing may be a child of a record
4664 return 0 if $type1 eq 'user'; # nothing may be child of a user
4665 return 0 if $type1 eq 'domain' && $type2 ne 'record'; # domain may not be a parent of anything other than a record
4666 return 0 if $type1 eq 'revzone' && $type2 ne 'record';# reverse zone may not be a parent of anything other than a record
4667
4668 # ennnhhhh.... if we're passed an id of 0, it will never be found. usual
4669 # case would be the UI creating a new <thing>, and so we don't have an ID for
4670 # <thing> to look up yet. in that case the UI should check the parent as well.
4671 return 0 if $id1 == 0; # nothing can have a parent id of 0
4672 return 1 if $id2 == 0; # anything could have a child id of 0 (or "unknown")
4673
4674 # group 1 is the ultimate root parent
4675 return 1 if $type1 eq 'group' && $id1 == 1;
4676
4677 # groups are always (a) parent of themselves
4678 return 1 if $type1 eq 'group' && $type2 eq 'group' && $id1 == $id2;
4679
4680 my $id = $id2;
4681 my $type = $type2;
4682 my $foundparent = 0;
4683
4684 # Records are the only entity with two possible parents. We need to split the parent checks on
4685 # domain/rdns.
4686 if ($type eq 'record') {
4687 my ($dom,$rdns) = $dbh->selectrow_array("SELECT domain_id,rdns_id FROM records WHERE record_id=?",
4688 undef, ($id));
4689 # check immediate parent against request
4690 return 1 if $type1 eq 'domain' && $id1 == $dom;
4691 return 1 if $type1 eq 'revzone' && $id1 == $rdns;
4692 # if request is group, check *both* parents. Only check if the parent is nonzero though.
4693 return 1 if $dom && $self->isParent($id1, $type1, $dom, 'domain');
4694 return 1 if $rdns && $self->isParent($id1, $type1, $rdns, 'revzone');
4695 # exit here since we've executed the loop below by proxy in the above recursive calls.
4696 return 0;
4697 }
4698
4699# almost the same loop as getParents() above
4700 my $limiter = 0;
4701 while (1) {
4702 my $sql = "SELECT $par_col{$type} FROM $par_tbl{$type} WHERE $id_col{$type} = ?";
4703 my $result = $dbh->selectrow_hashref($sql,
4704 undef, ($id) );
4705 if (!$result) {
4706 $limiter++;
4707##fixme: how often will this happen on a live site? fail at max limiter <n>?
4708# 2013/10/22 only seems to happen when you request an entity that doesn't exist.
4709 warn "no results looking for $sql with id $id (depth $limiter)\n";
4710 last;
4711 }
4712 if ($result && $result->{$par_col{$type}} == $id1) {
4713 $foundparent = 1;
4714 last;
4715 } else {
4716##fixme: do we care about trying to return a "no such record/domain/user/group" error?
4717# should be impossible to create an inconsistent DB just with API calls.
4718 warn $dbh->errstr." $sql, $id" if $dbh->errstr;
4719 }
4720 # group 1 is its own parent. need this here more to break strange loops than for detecting a parent
4721 last if $result->{$par_col{$type}} == 1;
4722 $id = $result->{$par_col{$type}};
4723 $type = $par_type{$type};
4724 }
4725
4726 return $foundparent;
4727} # end isParent()
4728
4729
4730## DNSDB::zoneStatus()
4731# Returns and optionally sets a zone's status
4732# Takes a database handle, domain/revzone ID, forward/reverse flag, and optionally a status argument
4733# Returns status, or undef on errors.
4734sub zoneStatus {
4735 my $self = shift;
4736 my $dbh = $self->{dbh};
4737 my $id = shift;
4738 my $revrec = shift;
4739 my $newstatus = shift || 'mu';
4740
4741 return undef if $id !~ /^\d+$/;
4742
4743 # Allow transactions, and raise an exception on errors so we can catch it later.
4744 # Use local to make sure these get "reset" properly on exiting this block
4745 local $dbh->{AutoCommit} = 0;
4746 local $dbh->{RaiseError} = 1;
4747
4748 if ($newstatus ne 'mu') {
4749 # ooo, fun! let's see what we were passed for status
4750 eval {
4751 $newstatus = 0 if $newstatus eq 'domoff';
4752 $newstatus = 1 if $newstatus eq 'domon';
4753 $dbh->do("UPDATE ".($revrec eq 'n' ? 'domains' : 'revzones')." SET status=? WHERE ".
4754 ($revrec eq 'n' ? 'domain_id' : 'rdns_id')."=?", undef, ($newstatus,$id) );
4755
4756##fixme switch to more consise "Enabled <domain"/"Disabled <domain>" as with users?
4757 $resultstr = "Changed ".($revrec eq 'n' ? $self->domainName($id) : $self->revName($id)).
4758 " state to ".($newstatus ? 'active' : 'inactive');
4759
4760 my %loghash;
4761 $loghash{domain_id} = $id if $revrec eq 'n';
4762 $loghash{rdns_id} = $id if $revrec eq 'y';
4763 $loghash{group_id} = $self->parentID(id => $id, type => ($revrec eq 'n' ? 'domain' : 'revzone'), revrec => $revrec);
4764 $loghash{entry} = $resultstr;
4765 $self->_log(%loghash);
4766
4767 $dbh->commit;
4768 };
4769 if ($@) {
4770 my $msg = $@;
4771 eval { $dbh->rollback; };
4772 $resultstr = '';
4773 $errstr = $msg;
4774 return;
4775 }
4776 }
4777
4778 my ($status) = $dbh->selectrow_array("SELECT status FROM ".
4779 ($revrec eq 'n' ? "domains WHERE domain_id=?" : "revzones WHERE rdns_id=?"),
4780 undef, ($id) );
4781 return $status;
4782} # end zoneStatus()
4783
4784
4785## DNSDB::getZonesByCIDR()
4786# Get a list of zone names and IDs that records for a passed CIDR block are within.
4787sub getZonesByCIDR {
4788 my $self = shift;
4789 my $dbh = $self->{dbh};
4790 my %args = @_;
4791
4792 my $result = $dbh->selectall_arrayref("SELECT rdns_id,revnet FROM revzones WHERE revnet >>= ? OR revnet <<= ?",
4793 { Slice => {} }, ($args{cidr}, $args{cidr}) );
4794 return $result;
4795} # end getZonesByCIDR()
4796
4797
4798## DNSDB::importAXFR
4799# Import a domain via AXFR
4800# Takes AXFR host, domain to transfer, group to put the domain in,
4801# and an optional hash containing:
4802# status - active/inactive state flag (defaults to active)
4803# rwsoa - overwrite-SOA flag (defaults to off)
4804# rwns - overwrite-NS flag (defaults to off, doesn't affect subdomain NS records)
4805# merge - flag to automerge A or AAAA records with matching PTR records
4806# Returns a status code (OK, WARN, or FAIL) and message - message should be blank
4807# if status is OK, but WARN includes conditions that are not fatal but should
4808# really be reported.
4809sub importAXFR {
4810 my $self = shift;
4811 my $dbh = $self->{dbh};
4812 my $ifrom_in = shift;
4813 my $zone = shift;
4814 my $group = shift;
4815
4816 my %args = @_;
4817
4818##fixme: add mode to delete&replace, merge+overwrite, merge new?
4819
4820 $args{status} = (defined($args{status}) ? $args{status} : 0);
4821 $args{status} = 1 if $args{status} eq 'on';
4822
4823 my $nrecs = 0;
4824 my $soaflag = 0;
4825 my $nsflag = 0;
4826 my $warnmsg = '';
4827 my $ifrom;
4828
4829 my $rev = 'n';
4830 my $code = 'OK';
4831 my $msg = 'foobar?';
4832
4833 # choke on possible bad setting in ifrom
4834 # IPv4 and v6, and valid hostnames!
4835 ($ifrom) = ($ifrom_in =~ /^([0-9a-f\:.]+|[0-9a-z_.-]+)$/i);
4836 return ('FAIL', "Bad AXFR source host $ifrom")
4837 unless ($ifrom) = ($ifrom_in =~ /^([0-9a-f\:.]+|[0-9a-z_.-]+)$/i);
4838
4839 my $errmsg;
4840
4841 my $zone_id;
4842 my $domain_id = 0;
4843 my $rdns_id = 0;
4844 my $cidr;
4845
4846# magic happens! detect if we're importing a domain or a reverse zone
4847# while we're at it, figure out what the CIDR netblock is (if we got a .arpa)
4848# or what the formal .arpa zone is (if we got a CIDR netblock)
4849# Handles sub-octet v4 zones in the format specified in the Cricket Book, 2nd Ed, p217-218
4850
4851 if ($zone =~ m{(?:\.arpa\.?|/\d+|^[\d.]+|^[a-fA-F0-9:]+)$}) {
4852 # we seem to have a reverse zone
4853 $rev = 'y';
4854
4855 if ($zone =~ /\.arpa\.?$/) {
4856 # we have a formal reverse zone. call _zone2cidr and get the CIDR block.
4857 ($code,$msg) = _zone2cidr($zone);
4858 return ($code, $msg) if $code eq 'FAIL';
4859 $cidr = $msg;
4860 } elsif ($zone =~ m|^[\d.]+/\d+$|) {
4861 # v4 revzone, CIDR netblock
4862 $cidr = NetAddr::IP->new($zone) or return ('FAIL',"$zone is not a valid CIDR block");
4863 $zone = _ZONE($cidr, 'ZONE.in-addr.arpa', 'r', '.');
4864 } elsif ($zone =~ /^[\d.]+$/) {
4865 # v4 revzone, leading-octet format
4866 my $mask = 32;
4867 while ($zone !~ /^\d+\.\d+\.\d+\.\d+$/) {
4868 $zone .= '.0';
4869 $mask -= 8;
4870 }
4871 $zone .= "/$mask";
4872 $cidr = NetAddr::IP->new($zone) or return ('FAIL',"$zone is not a valid CIDR block");
4873 $zone = _ZONE($cidr, 'ZONE.in-addr.arpa', 'r', '.');
4874 } elsif ($zone =~ m|^[a-fA-F\d:]+/\d+$|) {
4875 # v6 revzone, CIDR netblock
4876 $cidr = NetAddr::IP->new($zone) or return ('FAIL',"$zone is not a valid CIDR block");
4877 return ('FAIL', "$zone is not a nibble-aligned block") if $cidr->masklen % 4 != 0;
4878 $zone = _ZONE($cidr, 'ZONE.ip6.arpa', 'r', '.');
4879 } elsif ($zone =~ /^[a-fA-F\d:]+$/) {
4880 # v6 revzone, leading-group format
4881 $zone =~ s/::$//;
4882 my $mask = 128;
4883 while ($zone !~ /^(?:[a-fA-F\d]{1,4}:){7}[a-fA-F\d]$/) {
4884 $zone .= ":0";
4885 $mask -= 16;
4886 }
4887 $zone .= "/$mask";
4888 $cidr = NetAddr::IP->new($zone) or return ('FAIL',"$zone is not a valid CIDR block");
4889 $zone = _ZONE($cidr, 'ZONE.ip6.arpa', 'r', '.');
4890 } else {
4891 # there is. no. else!
4892 return ('FAIL', "Unknown zone name format '$zone'");
4893 }
4894
4895 # several places this can be triggered from; better to do it once.
4896 $warnmsg .= "Apparent sub-/64 IPv6 reverse zone\n" if $cidr->masklen > 64;
4897
4898 # quick check to start to see if we've already got one
4899
4900 ($zone_id) = $dbh->selectrow_array("SELECT rdns_id FROM revzones WHERE revnet=?",
4901 undef, ("$cidr"));
4902 $rdns_id = $zone_id;
4903 } else {
4904 # default to domain
4905 ($zone_id) = $dbh->selectrow_array("SELECT domain_id FROM domains WHERE lower(domain) = lower(?)",
4906 undef, ($zone));
4907 $domain_id = $zone_id;
4908 }
4909
4910 return ('FAIL', ($rev eq 'n' ? 'Domain' : 'Reverse zone')." already exists") if $zone_id;
4911
4912 # little local utility sub to swap $val and $host for revzone records.
4913 sub _revswap {
4914 my $rechost = shift;
4915 my $recdata = shift;
4916
4917 if ($rechost =~ /\.in-addr\.arpa\.?$/) {
4918 $rechost =~ s/\.in-addr\.arpa\.?$//;
4919 $rechost = join '.', reverse split /\./, $rechost;
4920 } else {
4921 $rechost =~ s/\.ip6\.arpa\.?$//;
4922 my @nibs = reverse split /\./, $rechost;
4923 $rechost = '';
4924 my $nc;
4925 foreach (@nibs) {
4926 $rechost.= $_;
4927 $rechost .= ":" if ++$nc % 4 == 0 && $nc < 32;
4928 }
4929 $rechost .= ":" if $nc < 32 && $rechost !~ /\*$/; # close netblock records?
4930##fixme: there's a case that ends up with a partial entry here:
4931# ip:add:re:ss::
4932# can't reproduce after letting it sit overnight after discovery. :(
4933#print "$rechost\n";
4934 # canonicalize with NetAddr::IP
4935 $rechost = NetAddr::IP->new($rechost)->addr unless $rechost =~ /\*$/;
4936 }
4937 return ($recdata,$rechost)
4938 }
4939
4940
4941 # Allow transactions, and raise an exception on errors so we can catch it later.
4942 # Use local to make sure these get "reset" properly on exiting this block
4943 local $dbh->{AutoCommit} = 0;
4944 local $dbh->{RaiseError} = 1;
4945
4946 my $sth;
4947 eval {
4948
4949 if ($rev eq 'n') {
4950##fixme: serial
4951 $dbh->do("INSERT INTO domains (domain,group_id,status) VALUES (?,?,?)", undef,
4952 ($zone, $group, $args{status}) );
4953 # get domain id so we can do the records
4954 ($zone_id) = $dbh->selectrow_array("SELECT currval('domains_domain_id_seq')");
4955 $domain_id = $zone_id;
4956 $self->_log(group_id => $group, domain_id => $domain_id,
4957 entry => "[Added ".($args{status} ? 'active' : 'inactive')." domain $zone via AXFR]");
4958 } else {
4959##fixme: serial
4960 $dbh->do("INSERT INTO revzones (revnet,group_id,status) VALUES (?,?,?)", undef,
4961 ($cidr,$group,$args{status}) );
4962 # get revzone id so we can do the records
4963 ($zone_id) = $dbh->selectrow_array("SELECT currval('revzones_rdns_id_seq')");
4964 $rdns_id = $zone_id;
4965 $self->_log(group_id => $group, rdns_id => $rdns_id,
4966 entry => "[Added ".($args{status} ? 'active' : 'inactive')." reverse zone $cidr via AXFR]");
4967 }
4968
4969## bizarre DBI<->Net::DNS interaction bug:
4970## sometimes a zone will cause an immediate commit-and-exit (sort of) of the while()
4971## fixed, apparently I was doing *something* odd, but not certain what it was that
4972## caused a commit instead of barfing
4973
4974 my $res = Net::DNS::Resolver->new;
4975 $res->nameservers($ifrom);
4976 $res->axfr_start($zone)
4977 or die "Couldn't begin AXFR\n";
4978
4979 $sth = $dbh->prepare("INSERT INTO records (domain_id,rdns_id,host,type,val,distance,weight,port,ttl)".
4980 " VALUES (?,?,?,?,?,?,?,?,?)");
4981
4982 # Stash info about sub-octet v4 revzones here so we don't have
4983 # to store the CNAMEs used to delegate a suboctet zone
4984 # $suboct{zone}{ns}[] -> array of nameservers
4985 # $suboct{zone}{cname}[] -> array of extant CNAMEs (Just In Case someone did something bizarre)
4986## commented pending actual use of this data. for now, we'll just
4987## auto-(re)create the CNAMEs in revzones on export
4988# my %suboct;
4989
4990 while (my $rr = $res->axfr_next()) {
4991
4992 # Discard out-of-zone records. After trying for a while to replicate this with
4993 # *nix-based DNS servers, it appears that only MS DNS is prone to including these
4994 # in the AXFR data in the first place, and possibly only older versions at that...
4995 # so it can't be reasonably tested. Yay Microsoft.
4996 if ($rr->name !~ /$zone$/i) {
4997 $warnmsg .= "Discarding out-of-zone record ".$rr->string."\n";
4998 }
4999
5000 my $val;
5001 my $distance = 0;
5002 my $weight = 0;
5003 my $port = 0;
5004 my $logfrag = '';
5005
5006 # Collect some record parts
5007 my $type = $rr->type;
5008 my $host = $rr->name;
5009 my $ttl = ($args{newttl} ? $args{newttl} : $rr->ttl); # allow force-override TTLs
5010
5011 # Info flags for SOA and NS records
5012 $soaflag = 1 if $type eq 'SOA';
5013 $nsflag = 1 if $type eq 'NS';
5014
5015# "Primary" types:
5016# A, NS, CNAME, SOA, PTR(warn in forward), MX, TXT, AAAA, SRV, A6(ob), SPF
5017# maybe KEY
5018
5019# BIND supports:
5020# [standard]
5021# A AAAA CNAME MX NS PTR SOA TXT
5022# [variously experimental, obsolete, or obscure]
5023# HINFO MB(ex) MD(ob) MF(ob) MG(ex) MINFO(ex) MR(ex) NULL WKS AFSDB(ex) ISDN(ex) RP(ex) RT(ex) X25(ex) PX
5024# ... if one can ever find the right magic to format them correctly
5025
5026# Net::DNS supports:
5027# RRSIG SIG NSAP NS NIMLOC NAPTR MX MR MINFO MG MB LOC ISDN IPSECKEY HINFO
5028# EID DNAME CNAME CERT APL AFSDB AAAA A DS NXT NSEC3PARAM NSEC3 NSEC KEY
5029# DNSKEY DLV X25 TXT TSIG TKEY SSHFP SRV SPF SOA RT RP PX PTR NULL APL::AplItem
5030
5031# nasty big ugly case-like thing here, since we have to do *some* different
5032# processing depending on the record. le sigh.
5033
5034# do the initial processing as if the record was in a forward zone. If we're
5035# doing a revzone, we can flip $host and $val as needed, once, after this
5036# monster if-elsif-...-elsif-else. This actually simplifies things a lot.
5037
5038##fixme: what record types other than TXT can/will have >255-byte payloads?
5039
5040 if ($type eq 'A') {
5041 $val = $rr->address;
5042 } elsif ($type eq 'NS') {
5043# hmm. should we warn here if subdomain NS'es are left alone?
5044 next if ($args{rwns} && ($host eq $zone));
5045 $val = $rr->nsdname;
5046 $nsflag = 1;
5047 } elsif ($type eq 'CNAME') {
5048 $val = $rr->cname;
5049 } elsif ($type eq 'SOA') {
5050 next if $args{rwsoa};
5051 $host = $rr->rname.":".$rr->mname;
5052 $val = $rr->refresh.":".$rr->retry.":".$rr->expire.":".$rr->minimum;
5053 $soaflag = 1;
5054 } elsif ($type eq 'PTR') {
5055 $val = $rr->ptrdname;
5056 } elsif ($type eq 'MX') {
5057 $val = $rr->exchange;
5058 $distance = $rr->preference;
5059 } elsif ($type eq 'TXT') {
5060##fixme: Net::DNS docs say this should be deprecated for rdatastr() or char_str_list(),
5061## but don't really seem enthusiastic about it.
5062#print "should use rdatastr:\n\t".$rr->rdatastr."\n or char_str_list:\n\t".join(' ',$rr->char_str_list())."\n";
5063# rdatastr returns a BIND-targetted logical string, including opening and closing quotes
5064# char_str_list returns a list of the individual string fragments in the record
5065# txtdata returns the more useful all-in-one form (since we want to push such protocol
5066# details as far down the stack as we can)
5067# NB: this may turn out to be more troublesome if we ever have need of >512-byte TXT records.
5068 $val = $rr->txtdata;
5069 } elsif ($type eq 'SPF') {
5070##fixme: and the same caveat here, since it is apparently a clone of ::TXT
5071 $val = $rr->txtdata;
5072 } elsif ($type eq 'AAAA') {
5073 $val = $rr->address;
5074 } elsif ($type eq 'SRV') {
5075 $val = $rr->target;
5076 $distance = $rr->priority;
5077 $weight = $rr->weight;
5078 $port = $rr->port;
5079 } elsif ($type eq 'KEY') {
5080 # we don't actually know what to do with these...
5081 $val = $rr->flags.":".$rr->protocol.":".$rr->algorithm.":".$rr->key.":".$rr->keytag.":".$rr->privatekeyname;
5082 } else {
5083 $val = $rr->rdatastr;
5084 # Finding a different record type is not fatal.... just problematic.
5085 # We may not be able to export it correctly.
5086 $warnmsg .= "Unusual record ".$rr->name." ($type) found\n";
5087 }
5088
5089 if ($rev eq 'y' && $type ne 'SOA') {
5090 # up to this point we haven't meddled with the record's hostname part or rdata part.
5091 # for reverse records, (except SOA) we must swap the two.
5092 $host = $val;
5093 $val = $rr->name;
5094 my ($tmpcode,$tmpmsg) = _zone2cidr($val);
5095 if ($tmpcode eq 'FAIL') {
5096 # $val did not have a valid IP value. It's syntactically valid but WTF?
5097 $warnmsg .= "Suspect record '".$rr->string."' may not be imported correctly: $tmpmsg\n";
5098 } else {
5099 # $val has a valid IP value. See if we can store it as that IP value.
5100 # Note we're enumerating do-nothing cases for clarity.
5101##enhance: this is where we will implement the more subtle variations on #53
5102 if ($type ne 'PTR' && $type ne 'NS' && $type ne 'CNAME' && $type ne 'TXT') {
5103 # case: the record is "weird" - ie, not a PTR, NS, CNAME, or TXT
5104 # $warnmsg .= "Discarding suspect record '".$rr->string."'\n" if $self->{strict} eq 'full';
5105 } elsif ($type eq 'PTR' && $tmpmsg->masklen != 32 && $tmpmsg->masklen != 128) {
5106 # case: PTR with netblock value, not IP value
5107 # eg, "@ PTR foo" in zone f.e.e.b.d.a.e.d.ip6.arpa should not be
5108 # stored/displayed as dead:beef::/32 PTR foo
5109
5110## hrm. WTF is this case for, anyway? Needs testing to check the logic.
5111# } elsif ( ($type eq 'PTR' || $type eq 'NS' || $type eq 'CNAME' || $type eq 'TXT') &&
5112# ($tmpmsg->masklen != $cidr->masklen)
5113# ) {
5114# # leave $val as-is if the record is "normal" (a PTR, NS, CNAME, or TXT),
5115# # and the mask does not match the zone
5116#$warnmsg .= "WTF case: $host $type $val\n";
5117# # $warnmsg .= "Discarding suspect record '".$rr->string."'\n" if $self->{strict} eq 'full';
5118
5119 } else {
5120 $val = $tmpmsg;
5121 $val =~ s/\/(?:32|128)$//; # automagically converts $val back to a string before s///
5122 #$val =~ s/:0$//g;
5123 }
5124 }
5125 # magic? convert * records to PTR template (not sure this actually makes sense)
5126 #if ($val =~ /^\*/) {
5127 # $val =~ s/\*\.//;
5128 # ($tmpcode,$tmpmsg) = _zone2cidr($val);
5129 # if ($tmpcode eq 'FAIL') {
5130 # $val = "*.$val";
5131 # $warnmsg .= "Suspect record '".$rr->string."' may not be converted to PTR template correctly: $tmpmsg\n";
5132 # } else {
5133 # $type = 'PTR template';
5134 # $val = $tmpmsg; if $tmp
5135 # $val =~ s/\/(?:32|128)$//; # automagically converts $val back to a string before s///
5136 # }
5137 #}
5138 } # non-SOA revrec $host/$val inversion and munging
5139
5140 my $logentry = "[AXFR ".($rev eq 'n' ? $zone : $cidr)."] ";
5141
5142 if ($args{merge}) {
5143 if ($rev eq 'n') {
5144 # importing a domain; we have A and AAAA records that could be merged with matching PTR records
5145 my $etype;
5146 my ($erdns,$erid,$ettl) = $dbh->selectrow_array("SELECT rdns_id,record_id,ttl FROM records ".
5147 "WHERE host=? AND val=? AND type=12",
5148 undef, ($host, $val) );
5149 if ($erid) {
5150 if ($type eq 'A') { # PTR -> A+PTR
5151 $etype = 65280;
5152 $logentry .= "Merged A record with existing PTR record '$host A+PTR $val', TTL $ettl";
5153 }
5154 if ($type eq 'AAAA') { # PTR -> AAAA+PTR
5155 $etype = 65281;
5156 $logentry .= "Merged AAAA record with existing PTR record '$host AAAA+PTR $val', TTL $ettl";
5157 }
5158 $ettl = ($ettl < $ttl ? $ettl : $ttl); # use lower TTL
5159 $dbh->do("UPDATE records SET domain_id=?,ttl=?,type=? WHERE record_id=?", undef,
5160 ($domain_id, $ettl, $etype, $erid));
5161 $nrecs++;
5162 $self->_log(group_id => $group, domain_id => $domain_id, rdns_id => $erdns, entry => $logentry);
5163 next; # while axfr_next
5164 }
5165 } # $rev eq 'n'
5166 else {
5167 # importing a revzone, we have PTR records that could be merged with matching A/AAAA records
5168 my ($domid,$erid,$ettl,$etype) = $dbh->selectrow_array("SELECT domain_id,record_id,ttl,type FROM records ".
5169 "WHERE host=? AND val=? AND (type=1 OR type=28)",
5170 undef, ($host, $val) );
5171 if ($erid) {
5172 if ($etype == 1) { # A -> A+PTR
5173 $etype = 65280;
5174 $logentry .= "Merged PTR record with existing matching A record '$host A+PTR $val', TTL $ettl";
5175 }
5176 if ($etype == 28) { # AAAA -> AAAA+PTR
5177 $etype = 65281;
5178 $logentry .= "Merged PTR record with existing matching AAAA record '$host AAAA+PTR $val', TTL $ettl";
5179 }
5180 $ettl = ($ettl < $ttl ? $ettl : $ttl); # use lower TTL
5181 $dbh->do("UPDATE records SET rdns_id=?,ttl=?,type=? WHERE record_id=?", undef,
5182 ($rdns_id, $ettl, $etype, $erid));
5183 $nrecs++;
5184 $self->_log(group_id => $group, domain_id => $domid, rdns_id => $rdns_id, entry => $logentry);
5185 next; # while axfr_next
5186 }
5187 } # $rev eq 'y'
5188 } # if $args{merge}
5189
5190 # Insert the new record
5191 $sth->execute($domain_id, $rdns_id, $host, $reverse_typemap{$type}, $val,
5192 $distance, $weight, $port, $ttl);
5193
5194 $nrecs++;
5195
5196 if ($type eq 'SOA') {
5197 # also !$args{rwsoa}, but if that's set, it should be impossible to get here.
5198 my @tmp1 = split /:/, $host;
5199 my @tmp2 = split /:/, $val;
5200 $logentry .= "Added SOA record [contact $tmp1[0]] [master $tmp1[1]] ".
5201 "[refresh $tmp2[0]] [retry $tmp2[1]] [expire $tmp2[2]] [minttl $tmp2[3]], TTL $ttl";
5202 } elsif ($logfrag) {
5203 # special case for log entries we need to meddle with a little.
5204 $logentry .= $logfrag;
5205 } else {
5206 $logentry .= "Added record '".($rev eq 'y' ? $val : $host)." $type";
5207 $logentry .= " [distance $distance]" if $type eq 'MX';
5208 $logentry .= " [priority $distance] [weight $weight] [port $port]" if $type eq 'SRV';
5209 $logentry .= " ".($rev eq 'y' ? $host : $val)."', TTL $ttl";
5210 }
5211 $self->_log(group_id => $group, domain_id => $domain_id, rdns_id => $rdns_id, entry => $logentry);
5212
5213 } # while axfr_next
5214
5215# Detect and handle delegated subzones
5216# Placeholder for when we decide what to actually do with this, see previous comments in NS and CNAME handling.
5217#foreach (keys %suboct) {
5218# print "found ".($suboct{$_}{ns} ? @{$suboct{$_}{ns}} : '0')." NS records and ".
5219# ($suboct{$_}{cname} ? @{$suboct{$_}{cname}} : '0')." CNAMEs for $_\n";
5220#}
5221
5222 # Overwrite SOA record
5223 if ($args{rwsoa}) {
5224 $soaflag = 1;
5225 my $sthgetsoa = $dbh->prepare("SELECT host,val,ttl FROM "._rectable('y', $rev)." WHERE group_id=? AND type=?");
5226 my $sthputsoa = $dbh->prepare("INSERT INTO records (".
5227 ($rev eq 'n' ? 'domain_id' : 'rdns_id').",host,type,val,ttl) VALUES (?,?,?,?,?)");
5228 $sthgetsoa->execute($group,$reverse_typemap{SOA});
5229 while (my ($host,$val,$ttl) = $sthgetsoa->fetchrow_array()) {
5230 if ($rev eq 'n') {
5231 $host =~ s/DOMAIN/$zone/g;
5232 $val =~ s/DOMAIN/$zone/g; # arguably useless
5233 } else {
5234 $host =~ s/ADMINDOMAIN/$self->{domain}/g;
5235 }
5236 $sthputsoa->execute($zone_id,$host,$reverse_typemap{SOA},$val,$ttl);
5237 }
5238 }
5239
5240 # Add standard NS records. The old one(s) should have been skipped by this point.
5241 if ($args{rwns}) {
5242 $nsflag = 1;
5243 my $sthgetns = $dbh->prepare("SELECT host,val,ttl FROM "._rectable('y',$rev)." WHERE group_id=? AND type=?");
5244 my $sthputns = $dbh->prepare("INSERT INTO records (".
5245 ($rev eq 'n' ? 'domain_id' : 'rdns_id').",host,type,val,ttl) VALUES (?,?,?,?,?)");
5246 $sthgetns->execute($group,$reverse_typemap{NS});
5247 while (my ($host,$val,$ttl) = $sthgetns->fetchrow_array()) {
5248 if ($rev eq 'n') {
5249 $host =~ s/DOMAIN/$zone/g;
5250 $val =~ s/DOMAIN/$zone/g; #hmm.
5251 } else {
5252 $host =~ s/ADMINDOMAIN/$self->{domain}/g; #hmm.
5253 $val =~ s/ZONE/$cidr/g;
5254 }
5255 $sthputns->execute($zone_id,$host,$reverse_typemap{NS},$val,$ttl);
5256 }
5257 }
5258
5259 die "No records found; either $ifrom is not authoritative or doesn't allow transfers\n" if !$nrecs;
5260 die "Bad zone: No SOA record!\n" if !$soaflag;
5261 die "Bad zone: No NS records!\n" if !$nsflag;
5262
5263 $dbh->commit;
5264
5265 };
5266
5267 if ($@) {
5268 my $msg = $@;
5269 eval { $dbh->rollback; };
5270 return ('FAIL',$msg." $warnmsg");
5271 } else {
5272 return ('WARN', $warnmsg) if $warnmsg;
5273 return ('OK',"Imported OK");
5274 }
5275
5276 # it should be impossible to get here.
5277 return ('WARN',"OOOK!");
5278} # end importAXFR()
5279
5280
5281## DNSDB::importBIND()
5282sub importBIND {
5283} # end importBIND()
5284
5285
5286## DNSDB::import_tinydns()
5287sub import_tinydns {
5288} # end import_tinydns()
5289
5290
5291## DNSDB::export()
5292# Export the DNS database, or a part of it
5293# Takes a string indicating the export type, plus optional arguments depending on type
5294# Writes zone data to targets as appropriate for type
5295sub export {
5296 my $self = shift;
5297 my $target = shift;
5298
5299 if ($target eq 'tiny') {
5300 eval {
5301 $self->__export_tiny(@_);
5302 };
5303 if ($@) {
5304 $errstr = $@;
5305 return undef;
5306 }
5307 }
5308# elsif ($target eq 'foo') {
5309# __export_foo(@_);
5310#}
5311# etc
5312
5313 return 1;
5314} # end export()
5315
5316
5317## DNSDB::__export_tiny
5318# Internal sub to implement tinyDNS (compatible) export
5319# Takes filehandle to write export to, optional argument(s)
5320# to determine which data gets exported
5321sub __export_tiny {
5322 my $self = shift;
5323 my $dbh = $self->{dbh};
5324 my $datafile = shift;
5325 my $zonefilehandle = $datafile; # makes cache/no-cache a little simpler
5326
5327##fixme: slurp up further options to specify particular zone(s) to export
5328
5329##fixme: fail if $datafile isn't an open, writable file
5330
5331 # Error check - does the cache dir exist, if we're using one?
5332 if ($self->{usecache}) {
5333 die "Cache directory does not exist\n" if !-e $self->{exportcache};
5334 die "$self->{exportcache} is not a directory\n" if !-d $self->{exportcache};
5335 die "$self->{exportcache} must be both readable and writable\n"
5336 if !-r $self->{exportcache} || !-w $self->{exportcache};
5337 }
5338
5339 # easy case - export all evarything
5340 # not-so-easy case - export item(s) specified
5341 # todo: figure out what kind of list we use to export items
5342
5343# raw packet in unknown format: first byte indicates length
5344# of remaining data, allows up to 255 raw bytes
5345
5346 # note: the only I/O failures we seem to be able to actually catch
5347 # here are "closed filehandle" errors. we're probably not writing
5348 # enough data at this point to properly trigger an "out of space"
5349 # error. :/
5350 eval {
5351 use warnings FATAL => ('io');
5352 # Locations/views - worth including in the caching setup?
5353 my $lochash = $dbh->selectall_hashref("SELECT location,iplist FROM locations", 'location');
5354 foreach my $location (keys %$lochash) {
5355 foreach my $ipprefix (split /[,\s]+/, $lochash->{$location}{iplist}) {
5356 $ipprefix =~ s/\s+//g;
5357 $ipprefix = new NetAddr::IP $ipprefix;
5358##fixme: how to handle IPv6?
5359next if $ipprefix->{isv6};
5360 # have to account for /nn CIDR entries. tinydns only speaks octet-sliced prefix.
5361 if ($ipprefix->masklen <= 8) {
5362 foreach ($ipprefix->split(8)) {
5363 my $tmp = $_->addr;
5364 $tmp =~ s/\.\d+\.\d+\.\d+$//;
5365 print $datafile "%$location:$tmp\n";
5366 }
5367 } elsif ($ipprefix->masklen <= 16) {
5368 foreach ($ipprefix->split(16)) {
5369 my $tmp = $_->addr;
5370 $tmp =~ s/\.\d+\.\d+$//;
5371 print $datafile "%$location:$tmp\n";
5372 }
5373 } elsif ($ipprefix->masklen <= 24) {
5374 foreach ($ipprefix->split(24)) {
5375 my $tmp = $_->addr;
5376 $tmp =~ s/\.\d+$//;
5377 print $datafile "%$location:$tmp\n";
5378 }
5379 } else {
5380 foreach ($ipprefix->split(32)) {
5381 print $datafile "%$location:".$_->addr."\n";
5382 }
5383 }
5384 }
5385 print $datafile "%$location\n" if !$lochash->{$location}{iplist};
5386 }
5387 };
5388 if ($@) {
5389 die "Error writing locations to master file: $@, $!\n";
5390 }
5391
5392 # tracking hash so we don't double-export A+PTR or AAAA+PTR records.
5393 my %recflags;
5394
5395# For reasons unknown, we can't sanely UNION these statements. Feh.
5396# Supposedly it should work though (note last 3 lines):
5397## PG manual
5398#UNION Clause
5399#
5400#The UNION clause has this general form:
5401#
5402# select_statement UNION [ ALL ] select_statement
5403#
5404#select_statement is any SELECT statement without an ORDER BY, LIMIT, FOR UPDATE, or FOR SHARE clause. (ORDER BY
5405#and LIMIT can be attached to a subexpression if it is enclosed in parentheses. Without parentheses, these
5406#clauses will be taken to apply to the result of the UNION, not to its right-hand input expression.)
5407 my $soasth = $dbh->prepare("SELECT host,type,val,distance,weight,port,ttl,record_id,location ".
5408 "FROM records WHERE rdns_id=? AND type=6");
5409 my $recsth = $dbh->prepare("SELECT host,type,val,distance,weight,port,ttl,record_id,location,extract(epoch from stamp),expires,stampactive ".
5410 "FROM records WHERE rdns_id=? AND NOT type=6 ".
5411 "ORDER BY masklen(inetlazy(val)) DESC, inetlazy(val)");
5412 my $revsth = $dbh->prepare("SELECT rdns_id,revnet,status,changed FROM revzones WHERE status=1 ".
5413 "ORDER BY masklen(revnet) DESC, rdns_id");
5414 my $zonesth = $dbh->prepare("UPDATE revzones SET changed='n' WHERE rdns_id=?");
5415 $revsth->execute();
5416 while (my ($revid,$revzone,$revstat,$changed) = $revsth->fetchrow_array) {
5417##fixme: need to find a way to block opening symlinked files without introducing a race.
5418# O_NOFOLLOW
5419# If pathname is a symbolic link, then the open fails. This is a FreeBSD extension, which was
5420# added to Linux in version 2.1.126. Symbolic links in earlier components of the pathname will
5421# still be followed.
5422# but that doesn't help other platforms. :/
5423 my $tmpzone = NetAddr::IP->new($revzone);
5424##fixme: locations/views? subnet mask? need to avoid possible collisions with zone/superzone
5425## (eg /20 vs /24, starting on .0.0)
5426 my $cz = $tmpzone->network->addr."-".$tmpzone->masklen;
5427 my $cachefile = "$self->{exportcache}/$cz";
5428 my $tmpcache = "$self->{exportcache}/tmp.$cz.$$";
5429 eval {
5430
5431 # write fresh records if:
5432 # - we are not using the cache
5433 # - force_refresh is set
5434 # - the zone has changed
5435 # - the cache file does not exist
5436 # - the cache file is empty
5437 if (!$self->{usecache} || $self->{force_refresh} || $changed || !-e $cachefile || -z $cachefile) {
5438 if ($self->{usecache}) {
5439 open ZONECACHE, ">$tmpcache" or die "Error creating temporary file $tmpcache: $!\n";
5440 $zonefilehandle = *ZONECACHE;
5441 }
5442
5443 # need to fetch this separately since the rest of the records all (should) have real IPs in val
5444 $soasth->execute($revid);
5445 my (@zsoa) = $soasth->fetchrow_array();
5446 _printrec_tiny($zonefilehandle, $zsoa[7], 'y',\%recflags,$revzone,
5447 $zsoa[0],$zsoa[1],$zsoa[2],$zsoa[3],$zsoa[4],$zsoa[5],$zsoa[6],$zsoa[8],'');
5448
5449 $recsth->execute($revid);
5450 my $fullzone = _ZONE($tmpzone, 'ZONE', 'r', '.').($tmpzone->{isv6} ? '.ip6.arpa' : '.in-addr.arpa');
5451
5452 while (my ($host, $type, $val, $dist, $weight, $port, $ttl, $recid, $loc, $stamp, $expires, $stampactive)
5453 = $recsth->fetchrow_array) {
5454 next if $recflags{$recid};
5455
5456 # Check for out-of-zone data
5457 if ($val =~ /\.arpa$/) {
5458 # val is non-IP
5459 if ($val !~ /$fullzone$/) {
5460 warn "Not exporting out-of-zone record $val $typemap{$type} $host, $ttl (zone $tmpzone)\n";
5461 next;
5462 }
5463 } else {
5464 my $ipval = new NetAddr::IP $val;
5465 if (!$tmpzone->contains($ipval)) {
5466 warn "Not exporting out-of-zone record $val $typemap{$type} $host, $ttl (zone $tmpzone)\n";
5467 next;
5468 }
5469 } # is $val a raw .arpa name?
5470
5471 # Spaces are evil.
5472 $val =~ s/^\s+//;
5473 $val =~ s/\s+$//;
5474 if ($typemap{$type} ne 'TXT') {
5475 # Leading or trailng spaces could be legit in TXT records.
5476 $host =~ s/^\s+//;
5477 $host =~ s/\s+$//;
5478 }
5479
5480 _printrec_tiny($zonefilehandle, $recid, 'y', \%recflags, $revzone,
5481 $host, $type, $val, $dist, $weight, $port, $ttl, $loc, $stamp, $expires, $stampactive);
5482
5483 $recflags{$recid} = 1;
5484
5485 } # while ($recsth)
5486
5487 if ($self->{usecache}) {
5488 close ZONECACHE; # force the file to be written
5489 # catch obvious write errors that leave an empty temp file
5490 if (-s $tmpcache) {
5491 rename $tmpcache, $cachefile
5492 or die "Error overwriting cache file $cachefile with temporary file: $!\n";
5493 }
5494 }
5495
5496 } # if $changed or cache filesize is 0
5497
5498 };
5499 if ($@) {
5500 die "error writing ".($self->{usecache} ? 'new data for ' : '')."$revzone: $@\n";
5501 # error! something borked, and we should be able to fall back on the old cache file
5502 # report the error, somehow.
5503 } else {
5504 # mark zone as unmodified. Only do this if no errors, that way
5505 # export failures should recover a little more automatically.
5506 $zonesth->execute($revid);
5507 }
5508
5509 if ($self->{usecache}) {
5510 # We've already made as sure as we can that a cached zone file is "good",
5511 # although possibly stale/obsolete due to errors creating a new one.
5512 eval {
5513 open CACHE, "<$cachefile" or die $!;
5514 print $datafile $_ or die "error copying cached $revzone to master file: $!" while <CACHE>;
5515 close CACHE;
5516 };
5517 die $@ if $@;
5518 }
5519
5520 } # while ($revsth)
5521
5522 $soasth = $dbh->prepare("SELECT host,type,val,distance,weight,port,ttl,record_id,location ".
5523 "FROM records WHERE domain_id=? AND type=6");
5524 $recsth = $dbh->prepare("SELECT host,type,val,distance,weight,port,ttl,record_id,location,extract(epoch from stamp),expires,stampactive ".
5525 "FROM records WHERE domain_id=? AND NOT type=6"); # Just exclude all types relating to rDNS
5526# "FROM records WHERE domain_id=? AND type < 65280"); # Just exclude all types relating to rDNS
5527 my $domsth = $dbh->prepare("SELECT domain_id,domain,status,changed FROM domains WHERE status=1 ORDER BY domain_id");
5528 $zonesth = $dbh->prepare("UPDATE domains SET changed='n' WHERE domain_id=?");
5529 $domsth->execute();
5530 while (my ($domid,$dom,$domstat,$changed) = $domsth->fetchrow_array) {
5531##fixme: need to find a way to block opening symlinked files without introducing a race.
5532# O_NOFOLLOW
5533# If pathname is a symbolic link, then the open fails. This is a FreeBSD extension, which was
5534# added to Linux in version 2.1.126. Symbolic links in earlier components of the pathname will
5535# still be followed.
5536# but that doesn't help other platforms. :/
5537 my $cachefile = "$self->{exportcache}/$dom";
5538 my $tmpcache = "$self->{exportcache}/tmp.$dom.$$";
5539 eval {
5540
5541 # write fresh records if:
5542 # - we are not using the cache
5543 # - force_refresh is set
5544 # - the zone has changed
5545 # - the cache file does not exist
5546 # - the cache file is empty
5547 if (!$self->{usecache} || $self->{force_refresh} || $changed || !-e $cachefile || -z $cachefile) {
5548 if ($self->{usecache}) {
5549 open ZONECACHE, ">$tmpcache" or die "Error creating temporary file $tmpcache: $!\n";
5550 $zonefilehandle = *ZONECACHE;
5551 }
5552
5553 # need to fetch this separately so the SOA comes first in the flatfile....
5554 # Just In Case we need/want to reimport from the flatfile later on.
5555 $soasth->execute($domid);
5556 my (@zsoa) = $soasth->fetchrow_array();
5557 _printrec_tiny($zonefilehandle, $zsoa[7], 'n',\%recflags,$dom,
5558 $zsoa[0],$zsoa[1],$zsoa[2],$zsoa[3],$zsoa[4],$zsoa[5],$zsoa[6],$zsoa[8],'');
5559
5560 $recsth->execute($domid);
5561 while (my ($host,$type,$val,$dist,$weight,$port,$ttl,$recid,$loc,$stamp,$expires,$stampactive) = $recsth->fetchrow_array) {
5562 next if $recflags{$recid};
5563
5564 # Check for out-of-zone data
5565 if ($host !~ /$dom$/) {
5566 warn "Not exporting out-of-zone record $host $type $val, $ttl (zone $dom)\n";
5567 next;
5568 }
5569
5570 # Spaces are evil.
5571 $host =~ s/^\s+//;
5572 $host =~ s/\s+$//;
5573 if ($typemap{$type} ne 'TXT') {
5574 # Leading or trailng spaces could be legit in TXT records.
5575 $val =~ s/^\s+//;
5576 $val =~ s/\s+$//;
5577 }
5578
5579 _printrec_tiny($zonefilehandle, $recid, 'n', \%recflags,
5580 $dom, $host, $type, $val, $dist, $weight, $port, $ttl, $loc, $stamp, $expires, $stampactive);
5581
5582 $recflags{$recid} = 1;
5583
5584 } # while ($recsth)
5585
5586
5587 if ($self->{usecache}) {
5588 close ZONECACHE; # force the file to be written
5589 # catch obvious write errors that leave an empty temp file
5590 if (-s $tmpcache) {
5591 rename $tmpcache, $cachefile
5592 or die "Error overwriting cache file $cachefile with temporary file: $!\n";
5593 }
5594 }
5595
5596 } # if $changed or cache filesize is 0
5597
5598 };
5599 if ($@) {
5600 die "error writing ".($self->{usecache} ? 'new data for ' : '')."$dom: $@\n";
5601 # error! something borked, and we should be able to fall back on the old cache file
5602 # report the error, somehow.
5603 } else {
5604 # mark domain as unmodified. Only do this if no errors, that way
5605 # export failures should recover a little more automatically.
5606 $zonesth->execute($domid);
5607 }
5608
5609 if ($self->{usecache}) {
5610 # We've already made as sure as we can that a cached zone file is "good",
5611 # although possibly stale/obsolete due to errors creating a new one.
5612 eval {
5613 open CACHE, "<$cachefile" or die $!;
5614 print $datafile $_ or die "error copying cached $dom to master file: $!" while <CACHE>;
5615 close CACHE;
5616 };
5617 die $@ if $@;
5618 }
5619
5620 } # while ($domsth)
5621
5622 return 1;
5623} # end __export_tiny()
5624
5625
5626# Utility sub for __export_tiny above
5627sub _printrec_tiny {
5628 my ($datafile, $recid, $revrec, $recflags, $zone, $host, $type, $val, $dist, $weight, $port, $ttl,
5629 $loc, $stamp, $expires, $stampactive) = @_;
5630
5631 $loc = '' if !$loc; # de-nullify - just in case
5632##fixme: handle case of record-with-location-that-doesn't-exist better.
5633# note this currently fails safe (tested) - records with a location that
5634# doesn't exist will not be sent to any client
5635# $loc = '' if !$lochash->{$loc};
5636
5637
5638## Records that are valid only before or after a set time
5639
5640# record due to expire sometime is the complex case. we don't want to just
5641# rely on tinydns' auto-adjusting TTLs, because the default TTL in that case
5642# is one day instead of the SOA minttl as BIND might do.
5643
5644# consider the case where a record is set to expire a week ahead, but the next
5645# day later you want to change it NOW (or as NOWish as you get with your DNS
5646# management practice). but now you're stuck, because someone, somewhere,
5647# has just done a lookup before your latest change was published, and they'll
5648# be caching that old, broken record for 1 day instead of your zone default
5649# TTL.
5650
5651# $stamp-$ttl is the *latest* we can publish the record with the defined TTL
5652# to still have the expiry happen as scheduled, but we need to find some
5653# *earlier* point. We can maybe guess, and 2x TTL is probably reasonable,
5654# but we need info on the export frequency.
5655
5656# export the normal, non-expiring record up until $stamp-<guesstimate>, then
5657# switch to exporting a record with the TAI64 stamp and a 0 TTL so tinydns
5658# takes over TTL management.
5659
5660 if ($stampactive) {
5661 if ($expires) {
5662 # record expires at $stamp; decide if we need to keep the TTL and ignore
5663 # the stamp for a time or if we need to change the TTL to 0 and convert
5664 # $stamp to TAI64 so tinydns can use $stamp to autoadjust the TTL on the fly.
5665# extra hack, optimally needs more knowledge of data export frequency
5666# smack the idiot customer who insists on 0 TTLs; they can suck up and
5667# deal with a 10-minute TTL. especially on scheduled changes. note this
5668# should be (export freq * 2), but we don't know the actual export frequency.
5669$ttl = 300 if $ttl == 0; #hack phtui
5670 my $ahead = (86400 < $ttl*2 ? 86400 : $ttl*2);
5671 if ((time() + $ahead) < $stamp) {
5672 # more than 2x TTL OR more than one day (whichever is less) from expiry time; publish normal record
5673 $stamp = '';
5674 } else {
5675 # less than 2x TTL from expiry time, let tinydns take over TTL management and publish the TAI64 stamp.
5676 $ttl = 0;
5677 $stamp = unixtai64($stamp);
5678 $stamp =~ s/\@//;
5679 }
5680 } else {
5681 # record is "active after"; convert epoch from database to TAI64, publish, and collect $200.
5682 $stamp = unixtai64($stamp);
5683 $stamp =~ s/\@//;
5684 }
5685 } else {
5686 # flag for active timestamp is false; don't actually put a timestamp in the output
5687 $stamp = '';
5688 }
5689
5690 # support tinydns' auto-TTL
5691 $ttl = '' if $ttl == -1;
5692# these are WAY FREAKING HIGH - higher even than most TLD registry TTLs!
5693# NS 259200 => 3d
5694# all others 86400 => 1d
5695
5696 if ($revrec eq 'y') {
5697 $val = $zone if $val eq '@';
5698 } else {
5699 $host = $zone if $host eq '@';
5700 }
5701
5702 ## Convert a bare number into an octal-coded pair of octets.
5703 # Take optional arg to indicate a decimal or hex input. Defaults to hex.
5704 sub octalize {
5705 my $tmp = shift;
5706 my $srctype = shift || 'h'; # default assumes hex string
5707 $tmp = sprintf "%0.4x", hex($tmp) if $srctype eq 'h'; # 0-pad hex to 4 digits
5708 $tmp = sprintf "%0.4x", $tmp if $srctype eq 'd'; # 0-pad decimal to 4 hex digits
5709 my @o = ($tmp =~ /^(..)(..)$/); # split into octets
5710 return sprintf "\\%0.3o\\%0.3o", hex($o[0]), hex($o[1]);;
5711 }
5712
5713## WARNING: This works to export even the whole Internet's worth of IP space...
5714## if you have the disk/RAM to handle the dataset, and you call this sub based on /16-sized chunks
5715## A /16 took ~3 seconds with a handful of separate records; adding a /8 pushed export time out to ~13m:40s
5716## 0/0 is estimated to take ~54 hours and ~256G of disk
5717## RAM usage depends on how many non-template entries you have in the set.
5718## This should probably be done on record addition rather than export; large blocks may need to be done in a
5719## forked process
5720 sub __publish_subnet {
5721 my $sub = shift;
5722 my $recflags = shift;
5723 my $hpat = shift;
5724 my $fh = shift;
5725 my $ttl = shift;
5726 my $stamp = shift;
5727 my $loc = shift;
5728 my $ptronly = shift || 0;
5729
5730 my $iplist = $sub->splitref(32);
5731 foreach (@$iplist) {
5732 my $ip = $_->addr;
5733 # make as if we split the non-octet-aligned block into octet-aligned blocks as with SOA
5734 next if $ip =~ /\.(0|255)$/;
5735 next if $$recflags{$ip};
5736 $$recflags{$ip}++;
5737 next if $hpat eq '%blank%'; # Allows blanking a subnet so no records are published.
5738 my $rec = $hpat; # start fresh with the template for each IP
5739 _template4_expand(\$rec, $ip);
5740 print $fh ($ptronly ? "^"._ZONE($_, 'ZONE.in-addr.arpa', 'r', '.').":$rec" : "=$rec:$ip").
5741 ":$ttl:$stamp:$loc\n" or die $!;
5742 }
5743 }
5744
5745##fixme? append . to all host/val hostnames
5746 if ($typemap{$type} eq 'SOA') {
5747
5748 # host contains pri-ns:responsible
5749 # val is abused to contain refresh:retry:expire:minttl
5750##fixme: "manual" serial vs tinydns-autoserial
5751 # let's be explicit about abusing $host and $val
5752 my ($email, $primary) = (split /:/, $host)[0,1];
5753 my ($refresh, $retry, $expire, $min_ttl) = (split /:/, $val)[0,1,2,3];
5754 if ($revrec eq 'y') {
5755##fixme: have to publish SOA records for each v4 /24 in sub-/16, and each /16 in sub-/8
5756# what about v6?
5757# -> only need SOA for local chunks offset from reverse delegation boundaries, so v6 is fine
5758 $zone = NetAddr::IP->new($zone);
5759 # handle split-n-multiply SOA for off-octet (8 < mask < 16) or (16 < mask < 24) v4 zones
5760 if (!$zone->{isv6} && ($zone->masklen < 24) && ($zone->masklen % 8 != 0)) {
5761 foreach my $szone ($zone->split($zone->masklen + (8 - $zone->masklen % 8))) {
5762 $szone = _ZONE($szone, 'ZONE.in-addr.arpa', 'r', '.');
5763 print $datafile "Z$szone:$primary:$email"."::$refresh:$retry:$expire:$min_ttl:$ttl:$stamp:$loc\n"
5764 or die $!;
5765 }
5766 return; # skips "default" bits just below
5767 }
5768 $zone = _ZONE($zone, 'ZONE', 'r', '.').($zone->{isv6} ? '.ip6.arpa' : '.in-addr.arpa');
5769 }
5770 print $datafile "Z$zone:$primary:$email"."::$refresh:$retry:$expire:$min_ttl:$ttl:$stamp:$loc\n"
5771 or die $!;
5772
5773 } elsif ($typemap{$type} eq 'A') {
5774
5775 print $datafile "+$host:$val:$ttl:$stamp:$loc\n" or die $!;
5776
5777 } elsif ($typemap{$type} eq 'NS') {
5778
5779 if ($revrec eq 'y') {
5780 $val = NetAddr::IP->new($val);
5781 # handle split-n-multiply SOA for off-octet (8 < mask < 16) or (16 < mask < 24) v4 zones
5782 if (!$val->{isv6} && ($val->masklen < 24) && ($val->masklen % 8 != 0)) {
5783 foreach my $szone ($val->split($val->masklen + (8 - $val->masklen % 8))) {
5784 my $szone2 = _ZONE($szone, 'ZONE.in-addr.arpa', 'r', '.');
5785 next if $$recflags{$szone2} && $$recflags{$szone2} > $val->masklen;
5786 print $datafile "\&$szone2"."::$host:$ttl:$stamp:$loc\n" or die $!;
5787 $$recflags{$szone2} = $val->masklen;
5788 }
5789 } elsif ($val->{isv6} && ($val->masklen < 64) && ($val->masklen % 4 !=0)) {
5790 foreach my $szone ($val->split($val->masklen + (4 - $val->masklen % 4))) {
5791 my $szone2 = _ZONE($szone, 'ZONE.ip6.arpa', 'r', '.');
5792 next if $$recflags{$szone2} && $$recflags{$szone2} > $val->masklen;
5793 print $datafile "\&$szone2"."::$host:$ttl:$stamp:$loc\n" or die $!;
5794 $$recflags{$szone2} = $val->masklen;
5795 }
5796 } else {
5797 my $val2 = _ZONE($val, 'ZONE', 'r', '.').($val->{isv6} ? '.ip6.arpa' : '.in-addr.arpa');
5798 print $datafile "\&$val2"."::$host:$ttl:$stamp:$loc\n" or die $!;
5799 $$recflags{$val2} = $val->masklen;
5800 }
5801 } else {
5802 print $datafile "\&$host"."::$val:$ttl:$stamp:$loc\n" or die $!;
5803 }
5804
5805 } elsif ($typemap{$type} eq 'AAAA') {
5806
5807# print $datafile ":$host:28:";
5808 my $altgrp = 0;
5809 my @altconv;
5810 # Split in to up to 8 groups of hex digits (allows for IPv6 :: 0-collapsing)
5811 foreach (split /:/, $val) {
5812 if (/^$/) {
5813 # flag blank entry; this is a series of 0's of (currently) unknown length
5814 $altconv[$altgrp++] = 's';
5815 } else {
5816 # call sub to convert 1-4 hex digits to 2 string-rep octal bytes
5817 $altconv[$altgrp++] = octalize($_)
5818 }
5819 }
5820 my $prefix = ":$host:28:";
5821 foreach my $octet (@altconv) {
5822 # if not 's', output
5823 $prefix .= $octet unless $octet =~ /^s$/;
5824 # if 's', output (9-array length)x literal '\000\000'
5825 $prefix .= '\000\000'x(9-$altgrp) if $octet =~ /^s$/;
5826 }
5827 print $datafile "$prefix:$ttl:$stamp:$loc\n" or die $!;
5828
5829 } elsif ($typemap{$type} eq 'MX') {
5830
5831##fixme: what if we get an MX AXFRed into a reverse zone?
5832 print $datafile "\@$host"."::$val:$dist:$ttl:$stamp:$loc\n" or die $!;
5833
5834 } elsif ($typemap{$type} eq 'TXT') {
5835
5836##fixme: split v-e-r-y long TXT strings? will need to do so for BIND export, at least
5837 if ($revrec eq 'n') {
5838 $val =~ s/:/\\072/g; # may need to replace other symbols
5839 print $datafile "'$host:$val:$ttl:$stamp:$loc\n" or die $!;
5840 } else {
5841 $host =~ s/:/\\072/g; # may need to replace other symbols
5842 my $val2 = NetAddr::IP->new($val);
5843 print $datafile "'"._ZONE($val2, 'ZONE', 'r', '.').($val2->{isv6} ? '.ip6.arpa' : '.in-addr.arpa').
5844 ":$host:$ttl:$stamp:$loc\n" or die $!;
5845 }
5846
5847# by-hand TXT
5848#:deepnet.cx:16:2v\075spf1\040a\040a\072bacon.deepnet.cx\040a\072home.deepnet.cx\040-all:3600
5849#@ IN TXT "v=spf1 a a:bacon.deepnet.cx a:home.deepnet.cx -all"
5850#'deepnet.cx:v=spf1 a a\072bacon.deepnet.cx a\072home.deepnet.cx -all:3600
5851
5852#txttest IN TXT "v=foo bar:bob kn;ob' \" !@#$%^&*()-=_+[]{}<>?"
5853#: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
5854
5855# very long TXT record as brought in by axfr-get
5856# note tinydns does not support >512-byte RR data, need axfr-dns (for TCP support) for that
5857# also note, tinydns does not seem to support <512, >256-byte RRdata from axfr-get either. :/
5858#:longtxt.deepnet.cx:16:
5859#\170this is a very long txt record. it is really long. long. very long. really very long. this is a very long txt record.
5860#\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.
5861#\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.
5862#:3600
5863
5864 } elsif ($typemap{$type} eq 'CNAME') {
5865
5866 if ($revrec eq 'n') {
5867 print $datafile "C$host:$val:$ttl:$stamp:$loc\n" or die $!;
5868 } else {
5869 my $val2 = NetAddr::IP->new($val);
5870 print $datafile "C"._ZONE($val2, 'ZONE', 'r', '.').($val2->{isv6} ? '.ip6.arpa' : '.in-addr.arpa').
5871 ":$host:$ttl:$stamp:$loc\n" or die $!;
5872 }
5873
5874 } elsif ($typemap{$type} eq 'SRV') {
5875
5876 # data is two-byte values for priority, weight, port, in that order,
5877 # followed by length/string data
5878
5879 print $datafile ":$host:33:".octalize($dist,'d').octalize($weight,'d').octalize($port,'d') or die $!;
5880
5881 $val .= '.' if $val !~ /\.$/;
5882 foreach (split /\./, $val) {
5883 printf $datafile "\\%0.3o%s", length($_), $_ or die $!;
5884 }
5885 print $datafile "\\000:$ttl:$stamp:$loc\n" or die $!;
5886
5887 } elsif ($typemap{$type} eq 'RP') {
5888
5889 # RP consists of two mostly free-form strings.
5890 # The first is supposed to be an email address with @ replaced by . (as with the SOA contact)
5891 # The second is the "hostname" of a TXT record with more info.
5892 my $prefix = ":$host:17:";
5893 my ($who,$what) = split /\s/, $val;
5894 foreach (split /\./, $who) {
5895 $prefix .= sprintf "\\%0.3o%s", length($_), $_;
5896 }
5897 $prefix .= '\000';
5898 foreach (split /\./, $what) {
5899 $prefix .= sprintf "\\%0.3o%s", length($_), $_;
5900 }
5901 print $datafile "$prefix\\000:$ttl:$stamp:$loc\n" or die $!;
5902
5903 } elsif ($typemap{$type} eq 'PTR') {
5904
5905 $zone = NetAddr::IP->new($zone);
5906 $$recflags{$val}++;
5907 if (!$zone->{isv6} && $zone->masklen > 24) {
5908 ($val) = ($val =~ /\.(\d+)$/);
5909 print $datafile "^$val."._ZONE($zone, 'ZONE', 'r', '.').'.in-addr.arpa'.
5910 ":$host:$ttl:$stamp:$loc\n" or die $!;
5911 } else {
5912 $val = NetAddr::IP->new($val);
5913 print $datafile "^".
5914 _ZONE($val, 'ZONE', 'r', '.').($val->{isv6} ? '.ip6.arpa' : '.in-addr.arpa').
5915 ":$host:$ttl:$stamp:$loc\n" or die $!;
5916 }
5917
5918 } elsif ($type == 65280) { # A+PTR
5919
5920 $$recflags{$val}++;
5921 print $datafile "=$host:$val:$ttl:$stamp:$loc\n" or die $!;
5922
5923 } elsif ($type == 65281) { # AAAA+PTR
5924
5925 $$recflags{$val}++;
5926 # treat these as two separate records. since tinydns doesn't have
5927 # a native combined type, we have to create them separately anyway.
5928 # print both; a dangling record is harmless, and impossible via web
5929 # UI anyway
5930 _printrec_tiny($datafile,$revrec,$recflags,$zone,$host,28,$val,$dist,$weight,$port,$ttl,$loc,$stamp);
5931 _printrec_tiny($datafile,$revrec,$recflags,$zone,$host,12,$val,$dist,$weight,$port,$ttl,$loc,$stamp);
5932##fixme: add a config flag to indicate use of the patch from http://www.fefe.de/dns/
5933# type 6 is for AAAA+PTR, type 3 is for AAAA
5934
5935 } elsif ($type == 65282) { # PTR template
5936
5937 # only useful for v4 with standard DNS software, since this expands all
5938 # IPs in $zone (or possibly $val?) with autogenerated records
5939 $val = NetAddr::IP->new($val);
5940 return if $val->{isv6};
5941
5942 if ($val->masklen <= 16) {
5943 foreach my $sub ($val->split(16)) {
5944 __publish_subnet($sub, $recflags, $host, $datafile, $ttl, $stamp, $loc, 1);
5945 }
5946 } else {
5947 __publish_subnet($val, $recflags, $host, $datafile, $ttl, $stamp, $loc, 1);
5948 }
5949
5950 } elsif ($type == 65283) { # A+PTR template
5951
5952 $val = NetAddr::IP->new($val);
5953 # Just In Case. An A+PTR should be impossible to add to a v6 revzone via API.
5954 return if $val->{isv6};
5955
5956 if ($val->masklen <= 16) {
5957 foreach my $sub ($val->split(16)) {
5958 __publish_subnet($sub, $recflags, $host, $datafile, $ttl, $stamp, $loc, 0);
5959 }
5960 } else {
5961 __publish_subnet($val, $recflags, $host, $datafile, $ttl, $stamp, $loc, 0);
5962 }
5963
5964 } elsif ($type == 65284) { # AAAA+PTR template
5965 # Stub for completeness. Could be exported to DNS software that supports
5966 # some degree of internal automagic in generic-record-creation
5967 # (eg http://search.cpan.org/dist/AllKnowingDNS/ )
5968
5969 } elsif ($type == 65285) { # Delegation
5970 # This is intended for reverse zones, but may prove useful in forward zones.
5971
5972 # All delegations need to create one or more NS records. The NS record handler knows what to do.
5973 _printrec_tiny($datafile,$revrec,$recflags,$zone,$host,$reverse_typemap{'NS'},
5974 $val,$dist,$weight,$port,$ttl,$loc,$stamp);
5975 if ($revrec eq 'y') {
5976 # In the case of a sub-/24 v4 reverse delegation, we need to generate CNAMEs
5977 # to redirect all of the individual IP lookups as well.
5978 # Not sure how this would actually resolve if a /24 or larger was delegated
5979 # one way, and a sub-/24 in that >=/24 was delegated elsewhere...
5980 my $dblock = NetAddr::IP->new($val);
5981 if (!$dblock->{isv6} && $dblock->masklen > 24) {
5982 my @subs = $dblock->split;
5983 foreach (@subs) {
5984 next if $$recflags{"$_"};
5985 my ($oct) = ($_->addr =~ /(\d+)$/);
5986 print $datafile "C"._ZONE($_, 'ZONE.in-addr.arpa', 'r', '.').":$oct.".
5987 _ZONE($dblock, 'ZONE.in-addr.arpa', 'r', '.').":$ttl:$stamp:$loc\n" or die $!;
5988 $$recflags{"$_"}++;
5989 }
5990 }
5991 }
5992
5993##
5994## Uncommon types. These will need better UI support Any Day Sometime Maybe(TM).
5995##
5996
5997 } elsif ($type == 44) { # SSHFP
5998 my ($algo,$fpt,$fp) = split /\s+/, $val;
5999
6000 my $rec = sprintf ":$host:44:\\%0.3o\\%0.3o", $algo, $fpt;
6001 while (my ($byte) = ($fp =~ /^(..)/) ) {
6002 $rec .= sprintf "\\%0.3o", hex($byte);
6003 $fp =~ s/^..//;
6004 }
6005 print $datafile "$rec:$ttl:$stamp:$loc\n" or die $!;
6006
6007 } else {
6008 # raw record. we don't know what's in here, so we ASS-U-ME the user has
6009 # put it in correctly, since either the user is messing directly with the
6010 # database, or the record was imported via AXFR
6011 # <split by char>
6012 # convert anything not a-zA-Z0-9.- to octal coding
6013
6014##fixme: add flag to export "unknown" record types - note we'll probably end up
6015# mangling them since they were written to the DB from Net::DNS::RR::<type>->rdatastr.
6016 #print $datafile ":$host:$type:$val:$ttl:$stamp:$loc\n";
6017
6018 } # record type if-else
6019
6020} # end _printrec_tiny()
6021
6022
6023## DNSDB::mailNotify()
6024# Sends notification mail to recipients regarding a DNSDB operation
6025sub mailNotify {
6026 my $self = shift;
6027 my $dbh = $self->{dbh};
6028 my ($subj,$message) = @_;
6029
6030 return if $self->{mailhost} eq 'smtp.example.com'; # do nothing if still using default SMTP host.
6031
6032 my $mailer = Net::SMTP->new($self->{mailhost}, Hello => "dnsadmin.$self->{domain}");
6033
6034 my $mailsender = ($self->{mailsender} ? $self->{mailsender} : $self->{mailnotify});
6035
6036 $mailer->mail($mailsender);
6037 $mailer->to($self->{mailnotify});
6038 $mailer->data("From: \"$self->{mailname}\" <$mailsender>\n",
6039 "To: <$self->{mailnotify}>\n",
6040 "Date: ".strftime("%a, %d %b %Y %H:%M:%S %z",localtime)."\n",
6041 "Subject: $subj\n",
6042 "X-Mailer: DNSAdmin v".$DNSDB::VERSION." Notify\n",
6043 "Organization: $self->{orgname}\n",
6044 "\n$message\n");
6045 $mailer->quit;
6046}
6047
6048# shut Perl up
60491;
Note: See TracBrowser for help on using the repository browser.