Fabio/ddclient
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

group_hosts_by: Return the common group configuration

Browse source 
This should make it easier to detect missing attribute names passed to
`group_hosts_by`.
This commit is contained in:
Richard Hansen 2024-07-12 17:37:07 -04:00
parent b8df93febe
commit 8a65264841
2 changed files with 90 additions and 66 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

110
ddclient.in
View file

@ -3462,13 +3462,15 @@ sub group_hosts_by {
my %attrs = map({ ($_ => undef); } @attrs); my %attrs = map({ ($_ => undef); } @attrs);
@attrs = sort(keys(%attrs)); @attrs = sort(keys(%attrs));
my %groups; my %groups;
my %cfgs;
my $d = Data::Dumper->new([])->Indent(0)->Sortkeys(1)->Terse(1)->Useqq(1); my $d = Data::Dumper->new([])->Indent(0)->Sortkeys(1)->Terse(1)->Useqq(1);
for my $h (@$hosts) { for my $h (@$hosts) {
my %cfg = map({ ($_ => $config{$h}{$_}); } grep(exists($config{$h}{$_}), @attrs)); my %cfg = map({ ($_ => $config{$h}{$_}); } grep(exists($config{$h}{$_}), @attrs));
my $sig = $d->Reset()->Values([\%cfg])->Dump(); my $sig = $d->Reset()->Values([\%cfg])->Dump();
push(@{$groups{$sig}}, $h); push(@{$groups{$sig}}, $h);
$cfgs{$sig} = \%cfg;
} }
return values(%groups); return map({ {cfg => $cfgs{$_}, hosts => $groups{$_}}; } keys(%groups));
} }
###################################################################### ######################################################################
@ -4026,23 +4028,23 @@ sub nic_dyndns2_update {
'nochg' => 'No update required; unnecessary attempts to change to the current address are considered abusive', 'nochg' => 'No update required; unnecessary attempts to change to the current address are considered abusive',
); );
for my $group (@groups) { for my $group (@groups) {
my @hosts = @$group; my @hosts = @{$group->{hosts}};
my %groupcfg = %{$group->{cfg}};
my $hosts = join(',', @hosts); my $hosts = join(',', @hosts);
my $h = $hosts[0]; my $ipv4 = $groupcfg{'wantipv4'};
my $ipv4 = $config{$h}{'wantipv4'}; my $ipv6 = $groupcfg{'wantipv6'};
my $ipv6 = $config{$h}{'wantipv6'};
delete $config{$_}{'wantipv4'} for @hosts; delete $config{$_}{'wantipv4'} for @hosts;
delete $config{$_}{'wantipv6'} for @hosts; delete $config{$_}{'wantipv6'} for @hosts;
info("setting IPv4 address to %s for %s", $ipv4, $hosts) if $ipv4; info("setting IPv4 address to %s for %s", $ipv4, $hosts) if $ipv4;
info("setting IPv6 address to %s for %s", $ipv6, $hosts) if $ipv6; info("setting IPv6 address to %s for %s", $ipv6, $hosts) if $ipv6;
verbose("UPDATE:", "updating %s", $hosts); verbose("UPDATE:", "updating %s", $hosts);
## Select the DynDNS system to update ## Select the DynDNS system to update
my $url = "http://$config{$h}{'server'}$config{$h}{'script'}?system="; my $url = "http://$groupcfg{'server'}$groupcfg{'script'}?system=";
if ($config{$h}{'custom'}) { if ($groupcfg{'custom'}) {
warning("updating %s: 'custom' and 'static' may not be used together. ('static' ignored)", $hosts) warning("updating %s: 'custom' and 'static' may not be used together. ('static' ignored)", $hosts)
if $config{$h}{'static'}; if $groupcfg{'static'};
$url .= 'custom'; $url .= 'custom';
} elsif ($config{$h}{'static'}) { } elsif ($groupcfg{'static'}) {
$url .= 'statdns'; $url .= 'statdns';
} else { } else {
$url .= 'dyndns'; $url .= 'dyndns';
@ -4055,19 +4057,19 @@ sub nic_dyndns2_update {
$url .= $ipv6; $url .= $ipv6;
} }
## some args are not valid for a custom domain. ## some args are not valid for a custom domain.
$url .= "&wildcard=ON" if ynu($config{$h}{'wildcard'}, 1, 0, 0); $url .= "&wildcard=ON" if ynu($groupcfg{'wildcard'}, 1, 0, 0);
if ($config{$h}{'mx'}) { if ($groupcfg{'mx'}) {
$url .= "&mx=$config{$h}{'mx'}"; $url .= "&mx=$groupcfg{'mx'}";
$url .= "&backmx=" . ynu($config{$h}{'backupmx'}, 'YES', 'NO'); $url .= "&backmx=" . ynu($groupcfg{'backupmx'}, 'YES', 'NO');
} }
my $reply = geturl( my $reply = geturl(
proxy => opt('proxy'), proxy => opt('proxy'),
url => $url, url => $url,
login => $config{$h}{'login'}, login => $groupcfg{'login'},
password => $config{$h}{'password'}, password => $groupcfg{'password'},
) // ''; ) // '';
if ($reply eq '') { if ($reply eq '') {
failed("updating %s: Could not connect to %s.", $hosts, $config{$h}{'server'}); failed("updating %s: Could not connect to %s.", $hosts, $groupcfg{'server'});
next; next;
} }
next if !header_ok($hosts, $reply); next if !header_ok($hosts, $reply);
@ -4124,7 +4126,7 @@ sub nic_dyndns2_update {
} }
} }
} }
failed("updating %s: Could not connect to %s.", $hosts, $config{$h}{'server'}) failed("updating %s: Could not connect to %s.", $hosts, $groupcfg{'server'})
if $state ne 'results2'; if $state ne 'results2';
} }
} }
@ -4300,11 +4302,11 @@ sub nic_noip_update {
'nochg' => 'No update required; unnecessary attempts to change to the current address are considered abusive', 'nochg' => 'No update required; unnecessary attempts to change to the current address are considered abusive',
); );
for my $group (group_hosts_by(\@_, qw(login password server wantipv4 wantipv6))) { for my $group (group_hosts_by(\@_, qw(login password server wantipv4 wantipv6))) {
my @hosts = @$group; my @hosts = @{$group->{hosts}};
my %groupcfg = %{$group->{cfg}};
my $hosts = join(',', @hosts); my $hosts = join(',', @hosts);
my $h = $hosts[0]; my $ipv4 = $groupcfg{'wantipv4'};
my $ipv4 = $config{$h}{'wantipv4'}; my $ipv6 = $groupcfg{'wantipv6'};
my $ipv6 = $config{$h}{'wantipv6'};
delete $config{$_}{'wantipv4'} for @hosts; delete $config{$_}{'wantipv4'} for @hosts;
delete $config{$_}{'wantipv6'} for @hosts; delete $config{$_}{'wantipv6'} for @hosts;
@ -4312,7 +4314,7 @@ sub nic_noip_update {
info("setting IPv6 address to %s for %s", $ipv6, $hosts) if $ipv6; info("setting IPv6 address to %s for %s", $ipv6, $hosts) if $ipv6;
verbose("UPDATE:", "updating %s", $hosts); verbose("UPDATE:", "updating %s", $hosts);
my $url = "https://$config{$h}{'server'}/nic/update?system=noip&hostname=$hosts&myip="; my $url = "https://$groupcfg{'server'}/nic/update?system=noip&hostname=$hosts&myip=";
$url .= $ipv4 if $ipv4; $url .= $ipv4 if $ipv4;
if ($ipv6) { if ($ipv6) {
$url .= "," if $ipv4; $url .= "," if $ipv4;
@ -4322,11 +4324,11 @@ sub nic_noip_update {
my $reply = geturl( my $reply = geturl(
proxy => opt('proxy'), proxy => opt('proxy'),
url => $url, url => $url,
login => $config{$h}{'login'}, login => $groupcfg{'login'},
password => $config{$h}{'password'}, password => $groupcfg{'password'},
) // ''; ) // '';
if ($reply eq '') { if ($reply eq '') {
failed("updating %s: Could not connect to %s.", $hosts, $config{$h}{'server'}); failed("updating %s: Could not connect to %s.", $hosts, $groupcfg{'server'});
next; next;
} }
next if !header_ok($hosts, $reply); next if !header_ok($hosts, $reply);
@ -4392,7 +4394,7 @@ sub nic_noip_update {
} }
} }
} }
failed("updating %s: Could not connect to %s.", $hosts, $config{$h}{'server'}) failed("updating %s: Could not connect to %s.", $hosts, $groupcfg{'server'})
if $state ne 'results2'; if $state ne 'results2';
} }
} }
@ -4632,29 +4634,29 @@ sub nic_zoneedit1_force_update {
sub nic_zoneedit1_update { sub nic_zoneedit1_update {
debug("\nnic_zoneedit1_update -------------------"); debug("\nnic_zoneedit1_update -------------------");
for my $group (group_hosts_by(\@_, qw(login password server zone wantip))) { for my $group (group_hosts_by(\@_, qw(login password server zone wantip))) {
my @hosts = @$group; my @hosts = @{$group->{hosts}};
my %groupcfg = %{$group->{cfg}};
my $hosts = join(',', @hosts); my $hosts = join(',', @hosts);
my $h = $hosts[0]; my $ip = $groupcfg{'wantip'};
my $ip = $config{$h}{'wantip'};
delete $config{$_}{'wantip'} for @hosts; delete $config{$_}{'wantip'} for @hosts;
info("setting IP address to %s for %s", $ip, $hosts); info("setting IP address to %s for %s", $ip, $hosts);
verbose("UPDATE:", "updating %s", $hosts); verbose("UPDATE:", "updating %s", $hosts);
my $url = ''; my $url = '';
$url .= "https://$config{$h}{'server'}/auth/dynamic.html"; $url .= "https://$groupcfg{'server'}/auth/dynamic.html";
$url .= "?host=$hosts"; $url .= "?host=$hosts";
$url .= "&dnsto=$ip" if $ip; $url .= "&dnsto=$ip" if $ip;
$url .= "&zone=$config{$h}{'zone'}" if defined $config{$h}{'zone'}; $url .= "&zone=$groupcfg{'zone'}" if defined $groupcfg{'zone'};
my $reply = geturl( my $reply = geturl(
proxy => opt('proxy'), proxy => opt('proxy'),
url => $url, url => $url,
login => $config{$h}{'login'}, login => $groupcfg{'login'},
password => $config{$h}{'password'}, password => $groupcfg{'password'},
) // ''; ) // '';
if ($reply eq '') { if ($reply eq '') {
failed("updating %s: Could not connect to %s.", $hosts, $config{$h}{'server'}); failed("updating %s: Could not connect to %s.", $hosts, $groupcfg{'server'});
next; next;
} }
next if !header_ok($hosts, $reply); next if !header_ok($hosts, $reply);
@ -4662,6 +4664,7 @@ sub nic_zoneedit1_update {
my @reply = split /\n/, $reply; my @reply = split /\n/, $reply;
# TODO: This is awkward and fragile -- it assumes that each line in the response body # TODO: This is awkward and fragile -- it assumes that each line in the response body
# corresponds with each host in @hosts (and in the same order). # corresponds with each host in @hosts (and in the same order).
my $h = $hosts[0];
for my $line (@reply) { for my $line (@reply) {
if ($h && $line =~ /^[^<]*<(SUCCESS|ERROR)\s+([^>]+)>(.*)/) { if ($h && $line =~ /^[^<]*<(SUCCESS|ERROR)\s+([^>]+)>(.*)/) {
my ($status, $assignments, $rest) = ($1, $2, $3); my ($status, $assignments, $rest) = ($1, $2, $3);
@ -4693,7 +4696,7 @@ sub nic_zoneedit1_update {
} }
} }
# TODO: Shouldn't this log join(',' @hosts) instead of $hosts? # TODO: Shouldn't this log join(',' @hosts) instead of $hosts?
failed("updating %s: no response from %s", $hosts, $config{$h}{'server'}) failed("updating %s: no response from %s", $hosts, $groupcfg{'server'})
if @hosts; if @hosts;
} }
} }
@ -5995,17 +5998,17 @@ EoEXAMPLE
sub nic_nsupdate_update { sub nic_nsupdate_update {
debug("\nnic_nsupdate_update -------------------"); debug("\nnic_nsupdate_update -------------------");
for my $group (group_hosts_by(\@_, qw(login password server tcp zone wantipv4 wantipv6))) { for my $group (group_hosts_by(\@_, qw(login password server tcp zone wantipv4 wantipv6))) {
my @hosts = @$group; my @hosts = @{$group->{hosts}};
my %groupcfg = %{$group->{cfg}};
my $hosts = join(',', @hosts); my $hosts = join(',', @hosts);
my $h = $hosts[0]; my $binary = $groupcfg{'login'};
my $binary = $config{$h}{'login'}; my $keyfile = $groupcfg{'password'};
my $keyfile = $config{$h}{'password'}; my $server = $groupcfg{'server'};
my $server = $config{$h}{'server'};
## nsupdate requires a port number to be separated by whitepace, not colon ## nsupdate requires a port number to be separated by whitepace, not colon
$server =~ s/:/ /; $server =~ s/:/ /;
my $zone = $config{$h}{'zone'}; my $zone = $groupcfg{'zone'};
my $ipv4 = $config{$h}{'wantipv4'}; my $ipv4 = $groupcfg{'wantipv4'};
my $ipv6 = $config{$h}{'wantipv6'}; my $ipv6 = $groupcfg{'wantipv6'};
delete $config{$_}{'wantipv4'} for @hosts; delete $config{$_}{'wantipv4'} for @hosts;
delete $config{$_}{'wantipv6'} for @hosts; delete $config{$_}{'wantipv6'} for @hosts;
@ -6032,7 +6035,7 @@ EoINSTR2
send send
EoINSTR4 EoINSTR4
my $command = "$binary -k $keyfile"; my $command = "$binary -k $keyfile";
$command .= " -v" if ynu($config{$h}{'tcp'}, 1, 0, 0); $command .= " -v" if ynu($groupcfg{'tcp'}, 1, 0, 0);
$command .= " -d" if (opt('debug')); $command .= " -d" if (opt('debug'));
verbose("UPDATE:", "nsupdate command is: %s", $command); verbose("UPDATE:", "nsupdate command is: %s", $command);
verbose("UPDATE:", "nsupdate instructions are:\n%s", $instructions); verbose("UPDATE:", "nsupdate instructions are:\n%s", $instructions);
@ -6108,15 +6111,15 @@ EoEXAMPLE
sub nic_cloudflare_update { sub nic_cloudflare_update {
debug("\nnic_cloudflare_update -------------------"); debug("\nnic_cloudflare_update -------------------");
for my $group (group_hosts_by(\@_, qw(login password))) { for my $group (group_hosts_by(\@_, qw(login password))) {
my @hosts = @$group; my @hosts = @{$group->{hosts}};
my %groupcfg = %{$group->{cfg}};
my $hosts = join(',', @hosts); my $hosts = join(',', @hosts);
my $key = $hosts[0];
my $headers = "Content-Type: application/json\n"; my $headers = "Content-Type: application/json\n";
if ($config{$key}{'login'} eq 'token') { if ($groupcfg{'login'} eq 'token') {
$headers .= "Authorization: Bearer $config{$key}{'password'}\n"; $headers .= "Authorization: Bearer $groupcfg{'password'}\n";
} else { } else {
$headers .= "X-Auth-Email: $config{$key}{'login'}\n"; $headers .= "X-Auth-Email: $groupcfg{'login'}\n";
$headers .= "X-Auth-Key: $config{$key}{'password'}\n"; $headers .= "X-Auth-Key: $groupcfg{'password'}\n";
} }
for my $domain (@hosts) { for my $domain (@hosts) {
@ -7275,10 +7278,11 @@ EoEXAMPLE
sub nic_cloudns_update { sub nic_cloudns_update {
for my $group (group_hosts_by(\@_, qw(dynurl wantip))) { for my $group (group_hosts_by(\@_, qw(dynurl wantip))) {
my @hosts = @$group; my @hosts = @{$group->{hosts}};
my %groupcfg = %{$group->{cfg}};
my $hosts = join(',', @hosts); my $hosts = join(',', @hosts);
my $ip = $config{$hosts[0]}{'wantip'}; my $ip = $groupcfg{'wantip'};
my $dynurl = $config{$hosts[0]}{'dynurl'}; my $dynurl = $groupcfg{'dynurl'};
delete $config{$_}{'wantip'} for @hosts; delete $config{$_}{'wantip'} for @hosts;
# https://www.cloudns.net/wiki/article/36/ says, "If you are behind a proxy and your real # https://www.cloudns.net/wiki/article/36/ says, "If you are behind a proxy and your real
# IP is set in the header X-Forwarded-For you need to add &proxy=1 at the end of the # IP is set in the header X-Forwarded-For you need to add &proxy=1 at the end of the

46
t/group_hosts_by.pl
View file

@ -34,57 +34,77 @@ my @test_cases = (
{ {
desc => 'empty attribute set yields single group with all hosts', desc => 'empty attribute set yields single group with all hosts',
groupby => [qw()], groupby => [qw()],
want => [[$h1, $h2, $h3]], want => [{cfg => {}, hosts => [$h1, $h2, $h3]}],
}, },
{ {
desc => 'common attribute yields single group with all hosts', desc => 'common attribute yields single group with all hosts',
groupby => [qw(common)], groupby => [qw(common)],
want => [[$h1, $h2, $h3]], want => [{cfg => {common => 'common'}, hosts => [$h1, $h2, $h3]}],
}, },
{ {
desc => 'subset share a value', desc => 'subset share a value',
groupby => [qw(h1h2)], groupby => [qw(h1h2)],
want => [[$h1, $h2], [$h3]], want => [
{cfg => {h1h2 => 'h1 and h2'}, hosts => [$h1, $h2]},
{cfg => {h1h2 => 'unique'}, hosts => [$h3]},
],
}, },
{ {
desc => 'all unique', desc => 'all unique',
groupby => [qw(unique)], groupby => [qw(unique)],
want => [[$h1], [$h2], [$h3]], want => [
{cfg => {unique => 'h1'}, hosts => [$h1]},
{cfg => {unique => 'h2'}, hosts => [$h2]},
{cfg => {unique => 'h3'}, hosts => [$h3]},
],
}, },
{ {
desc => 'combination', desc => 'combination',
groupby => [qw(common h1h2)], groupby => [qw(common h1h2)],
want => [[$h1, $h2], [$h3]], want => [
{cfg => {common => 'common', h1h2 => 'h1 and h2'}, hosts => [$h1, $h2]},
{cfg => {common => 'common', h1h2 => 'unique'}, hosts => [$h3]},
],
}, },
{ {
desc => 'falsy values', desc => 'falsy values',
groupby => [qw(falsy)], groupby => [qw(falsy)],
want => [[$h1], [$h2], [$h3]], want => [
{cfg => {falsy => 0}, hosts => [$h1]},
{cfg => {falsy => ''}, hosts => [$h2]},
{cfg => {falsy => undef}, hosts => [$h3]},
],
}, },
{ {
desc => 'set, unset, undef', desc => 'set, unset, undef',
groupby => [qw(maybeunset)], groupby => [qw(maybeunset)],
want => [[$h1], [$h2], [$h3]], want => [
{cfg => {maybeunset => 'unique'}, hosts => [$h1]},
{cfg => {maybeunset => undef}, hosts => [$h2]},
{cfg => {}, hosts => [$h3]},
],
}, },
{ {
desc => 'missing attribute', desc => 'missing attribute',
groupby => [qw(thisdoesnotexist)], groupby => [qw(thisdoesnotexist)],
want => [[$h1, $h2, $h3]], want => [{cfg => {}, hosts => [$h1, $h2, $h3]}],
}, },
); );
for my $tc (@test_cases) { for my $tc (@test_cases) {
my @got = ddclient::group_hosts_by([$h1, $h2, $h3], @{$tc->{groupby}}); my @got = ddclient::group_hosts_by([$h1, $h2, $h3], @{$tc->{groupby}});
# @got is used as a set of sets. Sort everything to make comparison easier. # @got is used as a set of sets. Sort everything to make comparison easier.
$_->{hosts} = [sort(@{$_->{hosts}})] for @got;
@got = sort({ @got = sort({
for (my $i = 0; $i < @$a && $i < @$b; ++$i) { for (my $i = 0; $i < @{$a->{hosts}} && $i < @{$b->{hosts}}; ++$i) {
my $x = $a->[$i] cmp $b->[$i]; my $x = $a->{hosts}[$i] cmp $b->{hosts}[$i];
return $x if $x != 0; return $x if $x != 0;
} }
return @$a <=> @$b; return @{$a->{hosts}} <=> @{$b->{hosts}};
} map({ [sort(@$_)]; } @got)); } @got);
is_deeply(\@got, $tc->{want}, $tc->{desc}) is_deeply(\@got, $tc->{want}, $tc->{desc})
or diag(Data::Dumper->Dump([\@got, $tc->{want}], [qw(got want)])); or diag(Data::Dumper->new([\@got, $tc->{want}],
[qw(got want)])->Sortkeys(1)->Useqq(1)->Dump());
} }
done_testing(); done_testing();