source: trunk/DNSDB.pm@ 510

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

/trunk

Clear up some error-log garbage. See #25.

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