source: trunk/DNSDB.pm@ 508

Last change on this file since 508 was 508, checked in by Kris Deugau, 11 years ago

/trunk

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