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

Merge pull request #693 from rhansen/vars

Browse source 
Variable fixes: required vs. optional, default values
This commit is contained in:
Richard Hansen 2024-06-28 16:18:26 -04:00 committed by GitHub
commit 76900c708c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 128 additions and 91 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
Makefile.am
View file

@ -77,6 +77,7 @@ handwritten_tests = \
t/parse_assignments.pl \ t/parse_assignments.pl \
t/skip.pl \ t/skip.pl \
t/ssl-validate.pl \ t/ssl-validate.pl \
t/variable_defaults.pl \
t/write_recap.pl t/write_recap.pl
generated_tests = \ generated_tests = \
t/version.pl t/version.pl

186
ddclient.in
View file

@ -132,7 +132,7 @@ my $last_emailbody = '';
## If run as *d (e.g., ddclientd) then daemonize by default (but allow ## If run as *d (e.g., ddclientd) then daemonize by default (but allow
## flags and options to override). ## flags and options to override).
my $daemon_default = ($programd =~ /d$/) ? interval('5m') : 0; my $daemon_default = ($programd =~ /d$/) ? interval('5m') : undef;
use vars qw($file $lineno); use vars qw($file $lineno);
local $file = ''; local $file = '';
@ -556,13 +556,13 @@ sub setv {
'minimum' => shift, 'minimum' => shift,
}; };
} }
my %variables = ( our %variables = (
'global-defaults' => { 'global-defaults' => {
'daemon' => setv(T_DELAY, 0, 0, $daemon_default, interval('60s')), 'daemon' => setv(T_DELAY, 0, 0, $daemon_default, interval('60s')),
'foreground' => setv(T_BOOL, 0, 0, 0, undef), 'foreground' => setv(T_BOOL, 0, 0, 0, undef),
'file' => setv(T_FILE, 0, 0, "$etc/$program.conf", undef), 'file' => setv(T_FILE, 0, 0, "$etc/$program.conf", undef),
'cache' => setv(T_FILE, 0, 0, "$cachedir/$program.cache", undef), 'cache' => setv(T_FILE, 0, 0, "$cachedir/$program.cache", undef),
'pid' => setv(T_FILE, 0, 0, "", undef), 'pid' => setv(T_FILE, 0, 0, undef, undef),
'proxy' => setv(T_FQDNP, 0, 0, undef, undef), 'proxy' => setv(T_FQDNP, 0, 0, undef, undef),
'protocol' => setv(T_PROTO, 0, 0, 'dyndns2', undef), 'protocol' => setv(T_PROTO, 0, 0, 'dyndns2', undef),
@ -581,18 +581,18 @@ my %variables = (
'webv4-skip' => setv(T_STRING,0, 0, undef, undef), 'webv4-skip' => setv(T_STRING,0, 0, undef, undef),
'webv6' => setv(T_STRING,0, 0, 'ipify-ipv6', undef), 'webv6' => setv(T_STRING,0, 0, 'ipify-ipv6', undef),
'webv6-skip' => setv(T_STRING,0, 0, undef, undef), 'webv6-skip' => setv(T_STRING,0, 0, undef, undef),
'fw' => setv(T_ANY, 0, 0, '', undef), 'fw' => setv(T_ANY, 0, 0, undef, undef),
'fw-skip' => setv(T_STRING,0, 0, undef, undef), 'fw-skip' => setv(T_STRING,0, 0, undef, undef),
'fwv4' => setv(T_ANY, 0, 0, '', undef), 'fwv4' => setv(T_ANY, 0, 0, undef, undef),
'fwv4-skip' => setv(T_STRING,0, 0, undef, undef), 'fwv4-skip' => setv(T_STRING,0, 0, undef, undef),
'fwv6' => setv(T_ANY, 0, 0, '', undef), 'fwv6' => setv(T_ANY, 0, 0, undef, undef),
'fwv6-skip' => setv(T_STRING,0, 0, undef, undef), 'fwv6-skip' => setv(T_STRING,0, 0, undef, undef),
'fw-login' => setv(T_LOGIN, 1, 0, '', undef), 'fw-login' => setv(T_LOGIN, 0, 0, undef, undef),
'fw-password' => setv(T_PASSWD,1, 0, '', undef), 'fw-password' => setv(T_PASSWD,0, 0, undef, undef),
'cmd' => setv(T_PROG, 0, 0, '', undef), 'cmd' => setv(T_PROG, 0, 0, undef, undef),
'cmd-skip' => setv(T_STRING,0, 0, undef, undef), 'cmd-skip' => setv(T_STRING,0, 0, undef, undef),
'cmdv4' => setv(T_PROG, 0, 0, '', undef), 'cmdv4' => setv(T_PROG, 0, 0, undef, undef),
'cmdv6' => setv(T_PROG, 0, 0, '', undef), 'cmdv6' => setv(T_PROG, 0, 0, undef, undef),
'timeout' => setv(T_DELAY, 0, 0, interval('120s'), interval('120s')), 'timeout' => setv(T_DELAY, 0, 0, interval('120s'), interval('120s')),
'retry' => setv(T_BOOL, 0, 0, 0, undef), 'retry' => setv(T_BOOL, 0, 0, 0, undef),
@ -601,8 +601,8 @@ my %variables = (
'syslog' => setv(T_BOOL, 0, 0, 0, undef), 'syslog' => setv(T_BOOL, 0, 0, 0, undef),
'facility' => setv(T_STRING,0, 0, 'daemon', undef), 'facility' => setv(T_STRING,0, 0, 'daemon', undef),
'priority' => setv(T_STRING,0, 0, 'notice', undef), 'priority' => setv(T_STRING,0, 0, 'notice', undef),
'mail' => setv(T_EMAIL, 0, 0, '', undef), 'mail' => setv(T_EMAIL, 0, 0, undef, undef),
'mail-failure' => setv(T_EMAIL, 0, 0, '', undef), 'mail-failure' => setv(T_EMAIL, 0, 0, undef, undef),
'max-warn' => setv(T_NUMBER,0, 0, 1, undef), 'max-warn' => setv(T_NUMBER,0, 0, 1, undef),
'exec' => setv(T_BOOL, 0, 0, 1, undef), 'exec' => setv(T_BOOL, 0, 0, 1, undef),
@ -611,18 +611,18 @@ my %variables = (
'quiet' => setv(T_BOOL, 0, 0, 0, undef), 'quiet' => setv(T_BOOL, 0, 0, 0, undef),
'help' => setv(T_BOOL, 0, 0, 0, undef), 'help' => setv(T_BOOL, 0, 0, 0, undef),
'test' => setv(T_BOOL, 0, 0, 0, undef), 'test' => setv(T_BOOL, 0, 0, 0, undef),
'geturl' => setv(T_STRING,0, 0, '', undef), 'geturl' => setv(T_STRING,0, 0, undef, undef),
'postscript' => setv(T_POSTS, 0, 0, '', undef), 'postscript' => setv(T_POSTS, 0, 0, undef, undef),
'ssl_ca_dir' => setv(T_FILE, 0, 0, undef, undef), 'ssl_ca_dir' => setv(T_FILE, 0, 0, undef, undef),
'ssl_ca_file' => setv(T_FILE, 0, 0, undef, undef), 'ssl_ca_file' => setv(T_FILE, 0, 0, undef, undef),
'redirect' => setv(T_NUMBER,0, 0, 0, undef) 'redirect' => setv(T_NUMBER,0, 0, 0, undef)
}, },
'protocol-common-defaults' => { 'protocol-common-defaults' => {
'server' => setv(T_FQDNP, 1, 0, 'members.dyndns.org', undef), 'server' => setv(T_FQDNP, 0, 0, 'members.dyndns.org', undef),
'login' => setv(T_LOGIN, 1, 0, '', undef), 'login' => setv(T_LOGIN, 1, 0, undef, undef),
'password' => setv(T_PASSWD,1, 0, '', undef), 'password' => setv(T_PASSWD,1, 0, undef, undef),
'host' => setv(T_STRING,1, 1, '', undef), 'host' => setv(T_STRING,1, 1, undef, undef),
'use' => setv(T_USE, 0, 0, 'ip', undef), 'use' => setv(T_USE, 0, 0, 'ip', undef),
'usev4' => setv(T_USEV4, 0, 0, 'disabled', undef), 'usev4' => setv(T_USEV4, 0, 0, 'disabled', undef),
@ -637,19 +637,19 @@ my %variables = (
'webv4-skip' => setv(T_STRING,0, 0, undef, undef), 'webv4-skip' => setv(T_STRING,0, 0, undef, undef),
'webv6' => setv(T_STRING,0, 0, 'ipify-ipv6', undef), 'webv6' => setv(T_STRING,0, 0, 'ipify-ipv6', undef),
'webv6-skip' => setv(T_STRING,0, 0, undef, undef), 'webv6-skip' => setv(T_STRING,0, 0, undef, undef),
'fw' => setv(T_ANY, 0, 0, '', undef), 'fw' => setv(T_ANY, 0, 0, undef, undef),
'fw-skip' => setv(T_STRING,0, 0, undef, undef), 'fw-skip' => setv(T_STRING,0, 0, undef, undef),
'fw-login' => setv(T_LOGIN, 0, 0, '', undef), 'fw-login' => setv(T_LOGIN, 0, 0, undef, undef),
'fw-password' => setv(T_PASSWD,0, 0, '', undef), 'fw-password' => setv(T_PASSWD,0, 0, undef, undef),
'fw-ssl-validate' => setv(T_BOOL, 0, 0, 1, undef), 'fw-ssl-validate' => setv(T_BOOL, 0, 0, 1, undef),
'fwv4' => setv(T_ANY, 0, 0, '', undef), 'fwv4' => setv(T_ANY, 0, 0, undef, undef),
'fwv4-skip' => setv(T_STRING,0, 0, undef, undef), 'fwv4-skip' => setv(T_STRING,0, 0, undef, undef),
'fwv6' => setv(T_ANY, 0, 0, '', undef), 'fwv6' => setv(T_ANY, 0, 0, undef, undef),
'fwv6-skip' => setv(T_STRING,0, 0, undef, undef), 'fwv6-skip' => setv(T_STRING,0, 0, undef, undef),
'cmd' => setv(T_PROG, 0, 0, '', undef), 'cmd' => setv(T_PROG, 0, 0, undef, undef),
'cmd-skip' => setv(T_STRING,0, 0, undef, undef), 'cmd-skip' => setv(T_STRING,0, 0, undef, undef),
'cmdv4' => setv(T_PROG, 0, 0, '', undef), 'cmdv4' => setv(T_PROG, 0, 0, undef, undef),
'cmdv6' => setv(T_PROG, 0, 0, '', undef), 'cmdv6' => setv(T_PROG, 0, 0, undef, undef),
'min-interval' => setv(T_DELAY, 0, 0, interval('30s'), 0), 'min-interval' => setv(T_DELAY, 0, 0, interval('30s'), 0),
'max-interval' => setv(T_DELAY, 0, 0, interval('25d'), 0), 'max-interval' => setv(T_DELAY, 0, 0, interval('25d'), 0),
'min-error-interval' => setv(T_DELAY, 0, 0, interval('5m'), 0), 'min-error-interval' => setv(T_DELAY, 0, 0, interval('5m'), 0),
@ -668,7 +668,7 @@ my %variables = (
# Timestamp (seconds since epoch) indicating the earliest time the next update is # Timestamp (seconds since epoch) indicating the earliest time the next update is
# permitted. # permitted.
# TODO: Create a timestamp type and change this to that type. # TODO: Create a timestamp type and change this to that type.
'wtime' => setv(T_DELAY, 0, 1, 0, interval('30s')), 'wtime' => setv(T_NUMBER,0, 1, undef, undef),
# Timestamp (seconds since epoch) indicating when an IP address was last sent to the DDNS # Timestamp (seconds since epoch) indicating when an IP address was last sent to the DDNS
# service, even if the IP address was not different from what was already stored. # service, even if the IP address was not different from what was already stored.
# TODO: Create a timestamp type and change this to that type. # TODO: Create a timestamp type and change this to that type.
@ -701,12 +701,12 @@ my %variables = (
}, },
'dyndns-common-defaults' => { 'dyndns-common-defaults' => {
'backupmx' => setv(T_BOOL, 0, 1, 0, undef), 'backupmx' => setv(T_BOOL, 0, 1, 0, undef),
'mx' => setv(T_OFQDN, 0, 1, '', undef), 'mx' => setv(T_OFQDN, 0, 1, undef, undef),
'static' => setv(T_BOOL, 0, 1, 0, undef), 'static' => setv(T_BOOL, 0, 1, 0, undef),
'wildcard' => setv(T_BOOL, 0, 1, 0, undef), 'wildcard' => setv(T_BOOL, 0, 1, 0, undef),
}, },
); );
my %protocols = ( our %protocols = (
'1984' => { '1984' => {
'force_update' => undef, 'force_update' => undef,
'update' => \&nic_1984_update, 'update' => \&nic_1984_update,
@ -714,7 +714,7 @@ my %protocols = (
'variables' => { 'variables' => {
%{$variables{'protocol-common-defaults'}}, %{$variables{'protocol-common-defaults'}},
'login' => undef, 'login' => undef,
'server' => setv(T_FQDNP, 1, 0, 'api.1984.is', undef), 'server' => setv(T_FQDNP, 0, 0, 'api.1984.is', undef),
}, },
}, },
'changeip' => { 'changeip' => {
@ -723,8 +723,8 @@ my %protocols = (
'examples' => \&nic_changeip_examples, 'examples' => \&nic_changeip_examples,
'variables' => { 'variables' => {
%{$variables{'protocol-common-defaults'}}, %{$variables{'protocol-common-defaults'}},
'min-interval' => setv(T_DELAY, 0, 0, 0, interval('5m')), 'min-interval' => setv(T_DELAY, 0, 0, interval('5m'), interval('5m')),
'server' => setv(T_FQDNP, 1, 0, 'nic.changeip.com', undef), 'server' => setv(T_FQDNP, 0, 0, 'nic.changeip.com', undef),
}, },
}, },
'cloudflare' => { 'cloudflare' => {
@ -736,12 +736,12 @@ my %protocols = (
'backupmx' => setv(T_BOOL, 0, 1, 0, undef), 'backupmx' => setv(T_BOOL, 0, 1, 0, undef),
'login' => setv(T_LOGIN, 0, 0, 'token', undef), 'login' => setv(T_LOGIN, 0, 0, 'token', undef),
'min-interval' => setv(T_DELAY, 0, 0, interval('5m'), 0), 'min-interval' => setv(T_DELAY, 0, 0, interval('5m'), 0),
'mx' => setv(T_OFQDN, 0, 1, '', undef), 'mx' => setv(T_OFQDN, 0, 1, undef, undef),
'server' => setv(T_FQDNP, 1, 0, 'api.cloudflare.com/client/v4', undef), 'server' => setv(T_FQDNP, 0, 0, 'api.cloudflare.com/client/v4', undef),
'static' => setv(T_BOOL, 0, 1, 0, undef), 'static' => setv(T_BOOL, 0, 1, 0, undef),
'ttl' => setv(T_NUMBER, 1, 0, 1, undef), 'ttl' => setv(T_NUMBER, 0, 0, 1, undef),
'wildcard' => setv(T_BOOL, 0, 1, 0, undef), 'wildcard' => setv(T_BOOL, 0, 1, 0, undef),
'zone' => setv(T_FQDN, 1, 0, '', undef), 'zone' => setv(T_FQDN, 1, 0, undef, undef),
}, },
}, },
'cloudns' => { 'cloudns' => {
@ -762,8 +762,8 @@ my %protocols = (
'variables' => { 'variables' => {
%{$variables{'protocol-common-defaults'}}, %{$variables{'protocol-common-defaults'}},
'login' => undef, 'login' => undef,
'server' => setv(T_FQDNP, 1, 0, 'api.digitalocean.com', undef), 'server' => setv(T_FQDNP, 0, 0, 'api.digitalocean.com', undef),
'zone' => setv(T_FQDN, 1, 0, '', undef), 'zone' => setv(T_FQDN, 1, 0, undef, undef),
}, },
}, },
'dinahosting' => { 'dinahosting' => {
@ -774,7 +774,7 @@ my %protocols = (
%{$variables{'protocol-common-defaults'}}, %{$variables{'protocol-common-defaults'}},
'min-error-interval' => setv(T_DELAY, 0, 0, interval('8m'), 0), 'min-error-interval' => setv(T_DELAY, 0, 0, interval('8m'), 0),
'script' => setv(T_STRING, 0, 1, '/special/api.php', undef), 'script' => setv(T_STRING, 0, 1, '/special/api.php', undef),
'server' => setv(T_FQDNP, 1, 0, 'dinahosting.com', undef), 'server' => setv(T_FQDNP, 0, 0, 'dinahosting.com', undef),
}, },
}, },
'dnsmadeeasy' => { 'dnsmadeeasy' => {
@ -783,8 +783,8 @@ my %protocols = (
'examples' => \&nic_dnsmadeeasy_examples, 'examples' => \&nic_dnsmadeeasy_examples,
'variables' => { 'variables' => {
%{$variables{'protocol-common-defaults'}}, %{$variables{'protocol-common-defaults'}},
'script' => setv(T_STRING, 1, 1, '/servlet/updateip', undef), 'script' => setv(T_STRING, 0, 1, '/servlet/updateip', undef),
'server' => setv(T_FQDNP, 1, 0, 'cp.dnsmadeeasy.com', undef), 'server' => setv(T_FQDNP, 0, 0, 'cp.dnsmadeeasy.com', undef),
}, },
}, },
'dondominio' => { 'dondominio' => {
@ -793,7 +793,7 @@ my %protocols = (
'examples' => \&nic_dondominio_examples, 'examples' => \&nic_dondominio_examples,
'variables' => { 'variables' => {
%{$variables{'protocol-common-defaults'}}, %{$variables{'protocol-common-defaults'}},
'server' => setv(T_FQDNP, 1, 0, 'dondns.dondominio.com', undef), 'server' => setv(T_FQDNP, 0, 0, 'dondns.dondominio.com', undef),
}, },
}, },
'dslreports1' => { 'dslreports1' => {
@ -802,7 +802,7 @@ my %protocols = (
'examples' => \&nic_dslreports1_examples, 'examples' => \&nic_dslreports1_examples,
'variables' => { 'variables' => {
%{$variables{'protocol-common-defaults'}}, %{$variables{'protocol-common-defaults'}},
'server' => setv(T_FQDNP, 1, 0, 'www.dslreports.com', undef), 'server' => setv(T_FQDNP, 0, 0, 'www.dslreports.com', undef),
}, },
}, },
'domeneshop' => { 'domeneshop' => {
@ -811,7 +811,7 @@ my %protocols = (
'examples' => \&nic_domeneshop_examples, 'examples' => \&nic_domeneshop_examples,
'variables' => { 'variables' => {
%{$variables{'protocol-common-defaults'}}, %{$variables{'protocol-common-defaults'}},
'server' => setv(T_FQDNP, 1, 0, 'api.domeneshop.no', undef), 'server' => setv(T_FQDNP, 0, 0, 'api.domeneshop.no', undef),
}, },
}, },
'duckdns' => { 'duckdns' => {
@ -821,7 +821,7 @@ my %protocols = (
'variables' => { 'variables' => {
%{$variables{'protocol-common-defaults'}}, %{$variables{'protocol-common-defaults'}},
'login' => undef, 'login' => undef,
'server' => setv(T_FQDNP, 1, 0, 'www.duckdns.org', undef), 'server' => setv(T_FQDNP, 0, 0, 'www.duckdns.org', undef),
}, },
}, },
'dyndns1' => { 'dyndns1' => {
@ -841,7 +841,7 @@ my %protocols = (
%{$variables{'protocol-common-defaults'}}, %{$variables{'protocol-common-defaults'}},
%{$variables{'dyndns-common-defaults'}}, %{$variables{'dyndns-common-defaults'}},
'custom' => setv(T_BOOL, 0, 1, 0, undef), 'custom' => setv(T_BOOL, 0, 1, 0, undef),
'script' => setv(T_STRING, 1, 1, '/nic/update', undef), 'script' => setv(T_STRING, 0, 1, '/nic/update', undef),
}, },
}, },
'easydns' => { 'easydns' => {
@ -852,9 +852,9 @@ my %protocols = (
%{$variables{'protocol-common-defaults'}}, %{$variables{'protocol-common-defaults'}},
'backupmx' => setv(T_BOOL, 0, 1, 0, undef), 'backupmx' => setv(T_BOOL, 0, 1, 0, undef),
'min-interval' => setv(T_DELAY, 0, 0, interval('5m'), 0), 'min-interval' => setv(T_DELAY, 0, 0, interval('5m'), 0),
'mx' => setv(T_OFQDN, 0, 1, '', undef), 'mx' => setv(T_OFQDN, 0, 1, undef, undef),
'server' => setv(T_FQDNP, 1, 0, 'api.cp.easydns.com', undef), 'server' => setv(T_FQDNP, 0, 0, 'api.cp.easydns.com', undef),
'script' => setv(T_STRING, 1, 1, '/dyn/generic.php', undef), 'script' => setv(T_STRING, 0, 1, '/dyn/generic.php', undef),
'wildcard' => setv(T_BOOL, 0, 1, 0, undef), 'wildcard' => setv(T_BOOL, 0, 1, 0, undef),
}, },
}, },
@ -864,8 +864,8 @@ my %protocols = (
'examples' => \&nic_freedns_examples, 'examples' => \&nic_freedns_examples,
'variables' => { 'variables' => {
%{$variables{'protocol-common-defaults'}}, %{$variables{'protocol-common-defaults'}},
'min-interval' => setv(T_DELAY, 0, 0, 0, interval('5m')), 'min-interval' => setv(T_DELAY, 0, 0, interval('5m'), interval('5m')),
'server' => setv(T_FQDNP, 1, 0, 'freedns.afraid.org', undef), 'server' => setv(T_FQDNP, 0, 0, 'freedns.afraid.org', undef),
}, },
}, },
'freemyip' => { 'freemyip' => {
@ -875,7 +875,7 @@ my %protocols = (
'variables' => { 'variables' => {
%{$variables{'protocol-common-defaults'}}, %{$variables{'protocol-common-defaults'}},
'login' => undef, 'login' => undef,
'server' => setv(T_FQDNP, 1, 0, 'freemyip.com', undef), 'server' => setv(T_FQDNP, 0, 0, 'freemyip.com', undef),
}, },
}, },
'gandi' => { 'gandi' => {
@ -885,9 +885,9 @@ my %protocols = (
'variables' => { 'variables' => {
%{$variables{'protocol-common-defaults'}}, %{$variables{'protocol-common-defaults'}},
'login' => undef, 'login' => undef,
'min-interval' => setv(T_DELAY, 0, 0, 0, interval('5m')), 'min-interval' => setv(T_DELAY, 0, 0, interval('5m'), interval('5m')),
'server' => setv(T_FQDNP, 1, 0, 'api.gandi.net', undef), 'server' => setv(T_FQDNP, 0, 0, 'api.gandi.net', undef),
'script' => setv(T_STRING, 1, 1, '/v5', undef), 'script' => setv(T_STRING, 0, 1, '/v5', undef),
'use-personal-access-token' => setv(T_BOOL, 0, 0, 0, undef), 'use-personal-access-token' => setv(T_BOOL, 0, 0, 0, undef),
'ttl' => setv(T_DELAY, 0, 0, undef, interval('5m')), 'ttl' => setv(T_DELAY, 0, 0, undef, interval('5m')),
'zone' => setv(T_FQDN, 1, 0, undef, undef), 'zone' => setv(T_FQDN, 1, 0, undef, undef),
@ -900,9 +900,9 @@ my %protocols = (
'variables' => { 'variables' => {
%{$variables{'protocol-common-defaults'}}, %{$variables{'protocol-common-defaults'}},
'min-interval' => setv(T_DELAY, 0, 0, interval('5m'), 0), 'min-interval' => setv(T_DELAY, 0, 0, interval('5m'), 0),
'server' => setv(T_FQDNP, 1, 0, 'api.godaddy.com/v1/domains', undef), 'server' => setv(T_FQDNP, 0, 0, 'api.godaddy.com/v1/domains', undef),
'ttl' => setv(T_NUMBER, 1, 0, 600, undef), 'ttl' => setv(T_NUMBER, 0, 0, 600, undef),
'zone' => setv(T_FQDN, 1, 0, '', undef), 'zone' => setv(T_FQDN, 1, 0, undef, undef),
}, },
}, },
'googledomains' => { 'googledomains' => {
@ -912,7 +912,7 @@ my %protocols = (
'variables' => { 'variables' => {
%{$variables{'protocol-common-defaults'}}, %{$variables{'protocol-common-defaults'}},
'min-interval' => setv(T_DELAY, 0, 0, interval('5m'), 0), 'min-interval' => setv(T_DELAY, 0, 0, interval('5m'), 0),
'server' => setv(T_FQDNP, 1, 0, 'domains.google.com', undef), 'server' => setv(T_FQDNP, 0, 0, 'domains.google.com', undef),
}, },
}, },
'hetzner' => { 'hetzner' => {
@ -923,9 +923,9 @@ my %protocols = (
%{$variables{'protocol-common-defaults'}}, %{$variables{'protocol-common-defaults'}},
'login' => setv(T_LOGIN, 0, 0, 'token', undef), 'login' => setv(T_LOGIN, 0, 0, 'token', undef),
'min-interval' => setv(T_DELAY, 0, 0, interval('1m'), 0), 'min-interval' => setv(T_DELAY, 0, 0, interval('1m'), 0),
'server' => setv(T_FQDNP, 1, 0, 'dns.hetzner.com/api/v1', undef), 'server' => setv(T_FQDNP, 0, 0, 'dns.hetzner.com/api/v1', undef),
'ttl' => setv(T_NUMBER, 0, 0, 60, 60), 'ttl' => setv(T_NUMBER, 0, 0, 60, 60),
'zone' => setv(T_FQDN, 1, 0, '', undef), 'zone' => setv(T_FQDN, 1, 0, undef, undef),
}, },
}, },
'mythicdyn' => { 'mythicdyn' => {
@ -935,7 +935,7 @@ my %protocols = (
'variables' => { 'variables' => {
%{$variables{'protocol-common-defaults'}}, %{$variables{'protocol-common-defaults'}},
'min-interval' => setv(T_DELAY, 0, 0, interval('5m'), 0), 'min-interval' => setv(T_DELAY, 0, 0, interval('5m'), 0),
'server' => setv(T_FQDNP, 1, 0, 'api.mythic-beasts.com', undef), 'server' => setv(T_FQDNP, 0, 0, 'api.mythic-beasts.com', undef),
}, },
}, },
'namecheap' => { 'namecheap' => {
@ -944,8 +944,8 @@ my %protocols = (
'examples' => \&nic_namecheap_examples, 'examples' => \&nic_namecheap_examples,
'variables' => { 'variables' => {
%{$variables{'protocol-common-defaults'}}, %{$variables{'protocol-common-defaults'}},
'min-interval' => setv(T_DELAY, 0, 0, 0, interval('5m')), 'min-interval' => setv(T_DELAY, 0, 0, interval('5m'), interval('5m')),
'server' => setv(T_FQDNP, 1, 0, 'dynamicdns.park-your-domain.com', undef), 'server' => setv(T_FQDNP, 0, 0, 'dynamicdns.park-your-domain.com', undef),
}, },
}, },
'nfsn' => { 'nfsn' => {
@ -954,9 +954,9 @@ my %protocols = (
'examples' => \&nic_nfsn_examples, 'examples' => \&nic_nfsn_examples,
'variables' => { 'variables' => {
%{$variables{'protocol-common-defaults'}}, %{$variables{'protocol-common-defaults'}},
'min_interval' => setv(T_FQDNP, 0, 0, 0, interval('5m')), 'min-interval' => setv(T_DELAY, 0, 0, interval('5m'), interval('5m')),
'server' => setv(T_FQDNP, 1, 0, 'api.nearlyfreespeech.net', undef), 'server' => setv(T_FQDNP, 0, 0, 'api.nearlyfreespeech.net', undef),
'ttl' => setv(T_NUMBER, 1, 0, 300, undef), 'ttl' => setv(T_NUMBER, 0, 0, 300, undef),
'zone' => setv(T_FQDN, 1, 0, undef, undef), 'zone' => setv(T_FQDN, 1, 0, undef, undef),
}, },
}, },
@ -967,7 +967,7 @@ my %protocols = (
'variables' => { 'variables' => {
%{$variables{'protocol-common-defaults'}}, %{$variables{'protocol-common-defaults'}},
'login' => undef, 'login' => undef,
'server' => setv(T_FQDNP, 1, 0, 'njal.la', undef), 'server' => setv(T_FQDNP, 0, 0, 'njal.la', undef),
'quietreply' => setv(T_BOOL, 0, 1, 0, undef), 'quietreply' => setv(T_BOOL, 0, 1, 0, undef),
}, },
}, },
@ -978,7 +978,7 @@ my %protocols = (
'variables' => { 'variables' => {
%{$variables{'protocol-common-defaults'}}, %{$variables{'protocol-common-defaults'}},
'custom' => setv(T_BOOL, 0, 1, 0, undef), 'custom' => setv(T_BOOL, 0, 1, 0, undef),
'server' => setv(T_FQDNP, 1, 0, 'dynupdate.no-ip.com', undef), 'server' => setv(T_FQDNP, 0, 0, 'dynupdate.no-ip.com', undef),
'static' => setv(T_BOOL, 0, 1, 0, undef), 'static' => setv(T_BOOL, 0, 1, 0, undef),
}, },
}, },
@ -988,10 +988,10 @@ my %protocols = (
'examples' => \&nic_nsupdate_examples, 'examples' => \&nic_nsupdate_examples,
'variables' => { 'variables' => {
%{$variables{'protocol-common-defaults'}}, %{$variables{'protocol-common-defaults'}},
'login' => setv(T_LOGIN, 1, 0, '/usr/bin/nsupdate', undef), 'login' => setv(T_LOGIN, 0, 0, '/usr/bin/nsupdate', undef),
'tcp' => setv(T_BOOL, 0, 1, 0, undef), 'tcp' => setv(T_BOOL, 0, 1, 0, undef),
'ttl' => setv(T_NUMBER, 0, 1, 600, undef), 'ttl' => setv(T_NUMBER, 0, 1, 600, undef),
'zone' => setv(T_STRING, 1, 1, '', undef), 'zone' => setv(T_STRING, 1, 1, undef, undef),
}, },
}, },
'ovh' => { 'ovh' => {
@ -1000,8 +1000,8 @@ my %protocols = (
'examples' => \&nic_ovh_examples, 'examples' => \&nic_ovh_examples,
'variables' => { 'variables' => {
%{$variables{'protocol-common-defaults'}}, %{$variables{'protocol-common-defaults'}},
'script' => setv(T_STRING, 1, 1, '/nic/update', undef), 'script' => setv(T_STRING, 0, 1, '/nic/update', undef),
'server' => setv(T_FQDNP, 1, 0, 'www.ovh.com', undef), 'server' => setv(T_FQDNP, 0, 0, 'www.ovh.com', undef),
}, },
}, },
'porkbun' => { 'porkbun' => {
@ -1012,9 +1012,9 @@ my %protocols = (
%{$variables{'protocol-common-defaults'}}, %{$variables{'protocol-common-defaults'}},
'login' => undef, 'login' => undef,
'password' => undef, 'password' => undef,
'apikey' => setv(T_PASSWD, 1, 0, '', undef), 'apikey' => setv(T_PASSWD, 1, 0, undef, undef),
'secretapikey' => setv(T_PASSWD, 1, 0, '', undef), 'secretapikey' => setv(T_PASSWD, 1, 0, undef, undef),
'root-domain' => setv(T_OFQDN, 0, 0, '', undef), 'root-domain' => setv(T_OFQDN, 0, 0, undef, undef),
'on-root-domain' => setv(T_BOOL, 0, 0, 0, undef), 'on-root-domain' => setv(T_BOOL, 0, 0, 0, undef),
}, },
}, },
@ -1024,8 +1024,8 @@ my %protocols = (
'examples' => \&nic_sitelutions_examples, 'examples' => \&nic_sitelutions_examples,
'variables' => { 'variables' => {
%{$variables{'protocol-common-defaults'}}, %{$variables{'protocol-common-defaults'}},
'server' => setv(T_FQDNP, 1, 0, 'www.sitelutions.com', undef), 'server' => setv(T_FQDNP, 0, 0, 'www.sitelutions.com', undef),
'min-interval' => setv(T_DELAY, 0, 0, 0, interval('5m')), 'min-interval' => setv(T_DELAY, 0, 0, interval('5m'), interval('5m')),
}, },
}, },
'woima' => { 'woima' => {
@ -1036,9 +1036,9 @@ my %protocols = (
%{$variables{'protocol-common-defaults'}}, %{$variables{'protocol-common-defaults'}},
'backupmx' => setv(T_BOOL, 0, 1, 0, undef), 'backupmx' => setv(T_BOOL, 0, 1, 0, undef),
'custom' => setv(T_BOOL, 0, 1, 0, undef), 'custom' => setv(T_BOOL, 0, 1, 0, undef),
'mx' => setv(T_OFQDN, 0, 1, '', undef), 'mx' => setv(T_OFQDN, 0, 1, undef, undef),
'script' => setv(T_STRING, 1, 1, '/nic/update', undef), 'script' => setv(T_STRING, 0, 1, '/nic/update', undef),
'server' => setv(T_FQDNP, 1, 0, 'dyn.woima.fi', undef), 'server' => setv(T_FQDNP, 0, 0, 'dyn.woima.fi', undef),
'static' => setv(T_BOOL, 0, 1, 0, undef), 'static' => setv(T_BOOL, 0, 1, 0, undef),
'wildcard' => setv(T_BOOL, 0, 1, 0, undef), 'wildcard' => setv(T_BOOL, 0, 1, 0, undef),
}, },
@ -1050,7 +1050,7 @@ my %protocols = (
'variables' => { 'variables' => {
%{$variables{'protocol-common-defaults'}}, %{$variables{'protocol-common-defaults'}},
'min-interval' => setv(T_DELAY, 0, 0, interval('5m'), 0), 'min-interval' => setv(T_DELAY, 0, 0, interval('5m'), 0),
'server' => setv(T_FQDNP, 1, 0, 'pddimp.yandex.ru', undef), 'server' => setv(T_FQDNP, 0, 0, 'pddimp.yandex.ru', undef),
}, },
}, },
'zoneedit1' => { 'zoneedit1' => {
@ -1060,7 +1060,7 @@ my %protocols = (
'variables' => { 'variables' => {
%{$variables{'protocol-common-defaults'}}, %{$variables{'protocol-common-defaults'}},
'min-interval' => setv(T_DELAY, 0, 0, interval('10m'), 0), 'min-interval' => setv(T_DELAY, 0, 0, interval('10m'), 0),
'server' => setv(T_FQDNP, 1, 0, 'dynamic.zoneedit.com', undef), 'server' => setv(T_FQDNP, 0, 0, 'dynamic.zoneedit.com', undef),
'zone' => setv(T_OFQDN, 0, 0, undef, undef), 'zone' => setv(T_OFQDN, 0, 0, undef, undef),
}, },
}, },
@ -1071,7 +1071,7 @@ my %protocols = (
'variables' => { 'variables' => {
%{$variables{'protocol-common-defaults'}}, %{$variables{'protocol-common-defaults'}},
'login' => undef, 'login' => undef,
'server' => setv(T_FQDNP, 1, 0, 'dynamicdns.key-systems.net', undef), 'server' => setv(T_FQDNP, 0, 0, 'dynamicdns.key-systems.net', undef),
}, },
}, },
'dnsexit2' => { 'dnsexit2' => {
@ -1082,9 +1082,9 @@ my %protocols = (
%{$variables{'protocol-common-defaults'}}, %{$variables{'protocol-common-defaults'}},
'login' => undef, 'login' => undef,
'ssl' => setv(T_BOOL, 0, 0, 1, undef), 'ssl' => setv(T_BOOL, 0, 0, 1, undef),
'server' => setv(T_FQDNP, 1, 0, 'api.dnsexit.com', undef), 'server' => setv(T_FQDNP, 0, 0, 'api.dnsexit.com', undef),
'path' => setv(T_STRING, 0, 0, '/dns/', undef), 'path' => setv(T_STRING, 0, 0, '/dns/', undef),
'ttl' => setv(T_NUMBER, 1, 0, 5, 0), 'ttl' => setv(T_NUMBER, 0, 0, 5, 0),
'zone' => setv(T_STRING, 0, 0, undef, undef), 'zone' => setv(T_STRING, 0, 0, undef, undef),
}, },
}, },
@ -1095,7 +1095,7 @@ my %protocols = (
'variables' => { 'variables' => {
%{$variables{'protocol-common-defaults'}}, %{$variables{'protocol-common-defaults'}},
'login' => undef, 'login' => undef,
'server' => setv(T_FQDNP, 1, 0, 'dyndns.regfish.de', undef), 'server' => setv(T_FQDNP, 0, 0, 'dyndns.regfish.de', undef),
}, },
}, },
'enom' => { 'enom' => {
@ -1104,8 +1104,8 @@ my %protocols = (
'examples' => \&nic_enom_examples, 'examples' => \&nic_enom_examples,
'variables' => { 'variables' => {
%{$variables{'protocol-common-defaults'}}, %{$variables{'protocol-common-defaults'}},
'server' => setv(T_FQDNP, 1, 0, 'dynamic.name-services.com', undef), 'server' => setv(T_FQDNP, 0, 0, 'dynamic.name-services.com', undef),
'min-interval' => setv(T_DELAY, 0, 0, 0, interval('5m')), 'min-interval' => setv(T_DELAY, 0, 0, interval('5m'), interval('5m')),
}, },
}, },
'infomaniak' => { 'infomaniak' => {
@ -2562,6 +2562,10 @@ sub check_value {
if (!defined $value && !$required) { if (!defined $value && !$required) {
; ;
} elsif (!defined($value) && $required) {
# None of the types have 'undef' as a valid value, so check definedness once here for
# convenience.
die("$type is required\n");
} elsif ($type eq T_DELAY) { } elsif ($type eq T_DELAY) {
$value = interval($value); $value = interval($value);
@ -7216,7 +7220,7 @@ sub nic_porkbun_update {
for my $host (@_) { for my $host (@_) {
my ($sub_domain, $domain); my ($sub_domain, $domain);
if ($config{$host}{'root-domain'} ne '') { if ($config{$host}{'root-domain'}) {
# Process 'root-domain' option # Process 'root-domain' option
$domain = $config{$host}{'root-domain'}; $domain = $config{$host}{'root-domain'};
$sub_domain = $host; $sub_domain = $host;

32
t/variable_defaults.pl Normal file
View file

@ -0,0 +1,32 @@
use Test::More;
SKIP: { eval { require Test::Warnings; } or skip($@, 1); }
eval { require 'ddclient'; } or BAIL_OUT($@);
my %variable_collections = (
map({ ($_ => $ddclient::variables{$_}) } grep($_ ne 'merged', keys(%ddclient::variables))),
map({ ("protocol=$_" => $ddclient::protocols{$_}{variables}); } keys(%ddclient::protocols)),
);
my %seen;
my @test_cases = (
map({
my $vcn = $_;
my $vc = $variable_collections{$_};
map({
my $def = $vc->{$_};
my $seen = exists($seen{$def});
$seen{$def} = undef;
({desc => "$vcn $_", def => $vc->{$_}}) x !$seen;
} sort(keys(%$vc)));
} sort(keys(%variable_collections))),
);
for my $tc (@test_cases) {
if ($tc->{def}{required}) {
is($tc->{def}{default}, undef, "'$tc->{desc}' (required) has no default");
} else {
my $norm;
my $valid = eval { $norm = ddclient::check_value($tc->{def}{default}, $tc->{def}); 1; };
ok($valid, "'$tc->{desc}' (optional) has a valid default");
is($norm, $tc->{def}{default}, "'$tc->{desc}' default normalizes to itself") if $valid;
}
}
done_testing();