source: trunk/DNSDB.pm@ 725

Last change on this file since 725 was 723, checked in by Kris Deugau, 9 years ago

/trunk

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