source: trunk/DNSDB.pm@ 630

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

/trunk

Add a bit more validation in _validate_65280() (A+PTR) Just In Case.
See #53.

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