Release version 4.0 of the dynamic DNS client for netcup DNS API

Author: stecklars

.gitignore

@@ -1 +1,2 @@
 config.php
+.php-cs-fixer.cache

README.md

@@ -15,7 +15,9 @@
 ### Implemented
 * All necessary API functions for DNS actions implemented (REST API)
 * Determines correct public IP address, uses fallback API for determining the IP address, in case main API does return invalid / no IP
-* IPv6 Support
+* Automatically retries API requests on errors
+* IPv4 and IPv6 Support (can be individually enabled / disabled)
+* Possible to manually provide IPv4 / IPv6 address to set as a CLI option
 * Update everything you want in one go: Every combination of domains, subdomains, domain root, and domain wildcard is possible
 * Creation of DNS record, if it doesn't already exist
 * If configured, lowers TTL to 300 seconds for the domain on each run, if necessary
@@ -51,119 +53,13 @@ You should probably run this script every few minutes, so that your IP is update
 ### CLI options
 Just add these Options after the command like `./update.php --quiet`
 
-| option        | function                                                  |
-| ------------- |----------------------------------------------------------:|
-| --quiet       | The script won't output notices, only errors and warnings |
-
-## Example outputs
-```
-$ ./update.php
-[2022/01/20 00:35:02 +0000][NOTICE] =============================================
-[2022/01/20 00:35:02 +0000][NOTICE] Running dynamic DNS client for netcup 3.0
-[2022/01/20 00:35:02 +0000][NOTICE] This script is not affiliated with netcup.
-[2022/01/20 00:35:02 +0000][NOTICE] =============================================
-
-[2022/01/20 00:35:02 +0000][NOTICE] Logged in successfully!
-[2022/01/20 00:35:02 +0000][NOTICE] Updating DNS records for domain "myfirstdomain.com"
-[2022/01/20 00:35:03 +0000][NOTICE] Successfully received Domain info.
-[2022/01/20 00:35:03 +0000][NOTICE] Lowered TTL to 300 seconds successfully.
-[2022/01/20 00:35:03 +0000][NOTICE] Successfully received DNS record data.
-[2022/01/20 00:35:03 +0000][NOTICE] Updating DNS records for subdomain "subdomain1" of domain "myfirstdomain.com".
-[2022/01/20 00:35:03 +0000][NOTICE] A record for host subdomain1 doesn't exist, creating necessary DNS record.
-[2022/01/20 00:35:03 +0000][NOTICE] IPv4 address has changed. Before: newly created Record; Now: 5.6.7.8
-[2022/01/20 00:35:03 +0000][NOTICE] IPv4 address updated successfully!
-[2022/01/20 00:35:03 +0000][NOTICE] AAAA record for host subdomain1 doesn't exist, creating necessary DNS record.
-[2022/01/20 00:35:03 +0000][NOTICE] IPv6 address has changed. Before: newly created Record; Now: 2001:db8:85a3:0:0:8a2e:370:7334
-[2022/01/20 00:35:03 +0000][NOTICE] IPv6 address updated successfully!
-[2022/01/20 00:35:03 +0000][NOTICE] Updating DNS records for subdomain "subdomain2" of domain "myfirstdomain.com".
-[2022/01/20 00:35:03 +0000][NOTICE] A record for host subdomain2 doesn't exist, creating necessary DNS record.
-[2022/01/20 00:35:03 +0000][NOTICE] IPv4 address has changed. Before: newly created Record; Now: 5.6.7.8
-[2022/01/20 00:35:03 +0000][NOTICE] IPv4 address updated successfully!
-[2022/01/20 00:35:03 +0000][NOTICE] AAAA record for host subdomain2 doesn't exist, creating necessary DNS record.
-[2022/01/20 00:35:03 +0000][NOTICE] IPv6 address has changed. Before: newly created Record; Now: 2001:db8:85a3:0:0:8a2e:370:7334
-[2022/01/20 00:35:03 +0000][NOTICE] IPv6 address updated successfully!
-[2022/01/20 00:35:03 +0000][NOTICE] Updating DNS records for domain "myseconddomain.com"
-[2022/01/20 00:35:03 +0000][NOTICE] Successfully received Domain info.
-[2022/01/20 00:35:04 +0000][NOTICE] Successfully received DNS record data.
-[2022/01/20 00:35:04 +0000][NOTICE] Updating DNS records for subdomain "@" of domain "myseconddomain.com".
-[2022/01/20 00:35:04 +0000][NOTICE] A record for host @ doesn't exist, creating necessary DNS record.
-[2022/01/20 00:35:04 +0000][NOTICE] IPv4 address has changed. Before: newly created Record; Now: 5.6.7.8
-[2022/01/20 00:35:04 +0000][NOTICE] IPv4 address updated successfully!
-[2022/01/20 00:35:04 +0000][NOTICE] AAAA record for host @ doesn't exist, creating necessary DNS record.
-[2022/01/20 00:35:04 +0000][NOTICE] IPv6 address has changed. Before: newly created Record; Now: 2001:db8:85a3:0:0:8a2e:370:7334
-[2022/01/20 00:35:04 +0000][NOTICE] IPv6 address updated successfully!
-[2022/01/20 00:35:04 +0000][NOTICE] Updating DNS records for subdomain "*" of domain "myseconddomain.com".
-[2022/01/20 00:35:04 +0000][NOTICE] A record for host * doesn't exist, creating necessary DNS record.
-[2022/01/20 00:35:04 +0000][NOTICE] IPv4 address has changed. Before: newly created Record; Now: 5.6.7.8
-[2022/01/20 00:35:04 +0000][NOTICE] IPv4 address updated successfully!
-[2022/01/20 00:35:04 +0000][NOTICE] AAAA record for host * doesn't exist, creating necessary DNS record.
-[2022/01/20 00:35:04 +0000][NOTICE] IPv6 address has changed. Before: newly created Record; Now: 2001:db8:85a3:0:0:8a2e:370:7334
-[2022/01/20 00:35:04 +0000][NOTICE] IPv6 address updated successfully!
-[2022/01/20 00:35:04 +0000][NOTICE] Logged out successfully!
-```
-```
-$ ./update.php
-[2022/01/20 00:39:00 +0000][NOTICE] =============================================
-[2022/01/20 00:39:00 +0000][NOTICE] Running dynamic DNS client for netcup 3.0
-[2022/01/20 00:39:00 +0000][NOTICE] This script is not affiliated with netcup.
-[2022/01/20 00:39:00 +0000][NOTICE] =============================================
-
-[2022/01/20 00:39:00 +0000][NOTICE] Logged in successfully!
-[2022/01/20 00:39:00 +0000][NOTICE] Updating DNS records for domain "myfirstdomain.com"
-[2022/01/20 00:39:00 +0000][NOTICE] Successfully received Domain info.
-[2022/01/20 00:39:00 +0000][NOTICE] Successfully received DNS record data.
-[2022/01/20 00:39:00 +0000][NOTICE] Updating DNS records for subdomain "subdomain1" of domain "myfirstdomain.com".
-[2022/01/20 00:39:00 +0000][NOTICE] IPv4 address hasn't changed. Current IPv4 address: 5.6.7.8
-[2022/01/20 00:39:00 +0000][NOTICE] IPv6 address hasn't changed. Current IPv6 address: 2001:db8:85a3:0:0:8a2e:370:7334
-[2022/01/20 00:39:00 +0000][NOTICE] Updating DNS records for subdomain "subdomain2" of domain "myfirstdomain.com".
-[2022/01/20 00:39:00 +0000][NOTICE] IPv4 address hasn't changed. Current IPv4 address: 5.6.7.8
-[2022/01/20 00:39:00 +0000][NOTICE] IPv6 address hasn't changed. Current IPv6 address: 2001:db8:85a3:0:0:8a2e:370:7334
-[2022/01/20 00:39:00 +0000][NOTICE] Updating DNS records for domain "myseconddomain.com"
-[2022/01/20 00:39:01 +0000][NOTICE] Successfully received Domain info.
-[2022/01/20 00:39:01 +0000][NOTICE] Successfully received DNS record data.
-[2022/01/20 00:39:01 +0000][NOTICE] Updating DNS records for subdomain "@" of domain "myseconddomain.com".
-[2022/01/20 00:39:01 +0000][NOTICE] IPv4 address hasn't changed. Current IPv4 address: 5.6.7.8
-[2022/01/20 00:39:01 +0000][NOTICE] IPv6 address hasn't changed. Current IPv6 address: 2001:db8:85a3:0:0:8a2e:370:7334
-[2022/01/20 00:39:01 +0000][NOTICE] Updating DNS records for subdomain "*" of domain "myseconddomain.com".
-[2022/01/20 00:39:01 +0000][NOTICE] IPv4 address hasn't changed. Current IPv4 address: 5.6.7.8
-[2022/01/20 00:39:01 +0000][NOTICE] IPv6 address hasn't changed. Current IPv6 address: 2001:db8:85a3:0:0:8a2e:370:7334
-[2022/01/20 00:39:01 +0000][NOTICE] Logged out successfully!
-```
-```
-$ ./update.php
-[2022/01/20 00:40:10 +0000][NOTICE] =============================================
-[2022/01/20 00:40:10 +0000][NOTICE] Running dynamic DNS client for netcup 3.0
-[2022/01/20 00:40:10 +0000][NOTICE] This script is not affiliated with netcup.
-[2022/01/20 00:40:10 +0000][NOTICE] =============================================
-
-[2022/01/20 00:40:10 +0000][NOTICE] Logged in successfully!
-[2022/01/20 00:40:10 +0000][NOTICE] Updating DNS records for domain "myfirstdomain.com"
-[2022/01/20 00:40:10 +0000][NOTICE] Successfully received Domain info.
-[2022/01/20 00:40:10 +0000][NOTICE] Successfully received DNS record data.
-[2022/01/20 00:40:10 +0000][NOTICE] Updating DNS records for subdomain "subdomain1" of domain "myfirstdomain.com".
-[2022/01/20 00:40:10 +0000][NOTICE] IPv4 address has changed. Before: 5.6.7.8; Now: 1.2.3.4
-[2022/01/20 00:40:11 +0000][NOTICE] IPv4 address updated successfully!
-[2022/01/20 00:40:11 +0000][NOTICE] IPv6 address has changed. Before: 2001:db8:85a3:0:0:8a2e:370:7334; Now: 2001:db8:85a3:0:0:8a2e:370:5123
-[2022/01/20 00:40:11 +0000][NOTICE] IPv6 address updated successfully!
-[2022/01/20 00:40:11 +0000][NOTICE] Updating DNS records for subdomain "subdomain2" of domain "myfirstdomain.com".
-[2022/01/20 00:40:11 +0000][NOTICE] IPv4 address has changed. Before: 5.6.7.8; Now: 1.2.3.4
-[2022/01/20 00:40:11 +0000][NOTICE] IPv4 address updated successfully!
-[2022/01/20 00:40:11 +0000][NOTICE] IPv6 address has changed. Before: 2001:db8:85a3:0:0:8a2e:370:7334; Now: 2001:db8:85a3:0:0:8a2e:370:5123
-[2022/01/20 00:40:11 +0000][NOTICE] IPv6 address updated successfully!
-[2022/01/20 00:40:11 +0000][NOTICE] Updating DNS records for domain "myseconddomain.com"
-[2022/01/20 00:40:11 +0000][NOTICE] Successfully received Domain info.
-[2022/01/20 00:40:11 +0000][NOTICE] Successfully received DNS record data.
-[2022/01/20 00:40:11 +0000][NOTICE] Updating DNS records for subdomain "@" of domain "myseconddomain.com".
-[2022/01/20 00:40:11 +0000][NOTICE] IPv4 address has changed. Before: 5.6.7.8; Now: 1.2.3.4
-[2022/01/20 00:40:12 +0000][NOTICE] IPv4 address updated successfully!
-[2022/01/20 00:40:12 +0000][NOTICE] IPv6 address has changed. Before: 2001:db8:85a3:0:0:8a2e:370:7334; Now: 2001:db8:85a3:0:0:8a2e:370:5123
-[2022/01/20 00:40:12 +0000][NOTICE] IPv6 address updated successfully!
-[2022/01/20 00:40:12 +0000][NOTICE] Updating DNS records for subdomain "*" of domain "myseconddomain.com".
-[2022/01/20 00:40:12 +0000][NOTICE] IPv4 address has changed. Before: 5.6.7.8; Now: 1.2.3.4
-[2022/01/20 00:40:12 +0000][NOTICE] IPv4 address updated successfully!
-[2022/01/20 00:40:12 +0000][NOTICE] IPv6 address has changed. Before: 2001:db8:85a3:0:0:8a2e:370:7334; Now: 2001:db8:85a3:0:0:8a2e:370:5123
-[2022/01/20 00:40:12 +0000][NOTICE] IPv6 address updated successfully!
-[2022/01/20 00:40:12 +0000][NOTICE] Logged out successfully!
-```
+| short option | long option        | function                                                  |
+| ------------ | ------------------ |----------------------------------------------------------:|
+| -q           | --quiet            | The script won't output notices, only errors and warnings |
+| -c           | --config           | Manually provide a path to the config file                |
+| -4           | --ipv4             | Manually provide the IPv4 address to set                  |
+| -6           | --ipv6             | Manually provide the IPv6 address to set                  |
+| -h           | --help             | Outputs this help                                         |
+| -v           | --version          | Outputs the current version of the script                 |
 
 If you have ideas on how to improve this script, please don't hesitate to create an issue or provide me with a pull request. Thank you!

config.dist.php

@@ -28,6 +28,11 @@
 // define('HOST', 'server');
 
 
+// If set to true, the script will check for your public IPv4 address and add it as an A-Record / change an existing A-Record for the host.
+// You may want to deactivate this, for example, when using a carrier grade NAT (CGNAT).
+// Most likely though, you should keep this active, unless you know otherwise.
+define('USE_IPV4', true);
+
 // If set to true, the script will check for your public IPv6 address too and add it as an AAAA-Record / change an existing AAAA-Record for the host.
 // Activate this only if you have IPv6 connectivity, or you *WILL* get errors.
 define('USE_IPV6', false);