Merge pull request #2860 from indrajitr/ddclient-update-20240119

ddclient: T5966: Adjust dynamic dns config address subpath

4 files changed, 211 insertions, 155 deletions

diff --git a/src/conf_mode/service_dns_dynamic.py b/src/conf_mode/service_dns_dynamic.py
index 845aaa1b5..a551a9891 100755
--- a/src/conf_mode/service_dns_dynamic.py
+++ b/src/conf_mode/service_dns_dynamic.py
@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 #
-# Copyright (C) 2018-2023 VyOS maintainers and contributors
+# Copyright (C) 2018-2024 VyOS maintainers and contributors
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License version 2 or later as
@@ -87,31 +87,36 @@ def verify(dyndns):
             if field not in config:
                 raise ConfigError(f'"{field.replace("_", "-")}" {error_msg_req}')
 
-        # If dyndns address is an interface, ensure
-        # that the interface exists (or just warn if dynamic interface)
-        # and that web-options are not set
-        if config['address'] != 'web':
+        if not any(x in config['address'] for x in ['interface', 'web']):
+            raise ConfigError(f'Either "interface" or "web" {error_msg_req} '
+                              f'with protocol "{config["protocol"]}"')
+        if all(x in config['address'] for x in ['interface', 'web']):
+            raise ConfigError(f'Both "interface" and "web" at the same time {error_msg_uns} '
+                              f'with protocol "{config["protocol"]}"')
+
+        # If dyndns address is an interface, ensure that the interface exists
+        # and warn if a non-active dynamic interface is used
+        if 'interface' in config['address']:
             tmp = re.compile(dynamic_interface_pattern)
             # exclude check interface for dynamic interfaces
-            if tmp.match(config["address"]):
-                if not interface_exists(config["address"]):
-                    Warning(f'Interface "{config["address"]}" does not exist yet and cannot '
-                            f'be used for Dynamic DNS service "{service}" until it is up!')
+            if tmp.match(config['address']['interface']):
+                if not interface_exists(config['address']['interface']):
+                    Warning(f'Interface "{config["address"]["interface"]}" does not exist yet and '
+                            f'cannot be used for Dynamic DNS service "{service}" until it is up!')
             else:
-                verify_interface_exists(config['address'])
-            if 'web_options' in config:
-                raise ConfigError(f'"web-options" is applicable only when using HTTP(S) '
-                                  f'web request to obtain the IP address')
-
-        # Warn if using checkip.dyndns.org, as it does not support HTTPS
-        # See: https://github.com/ddclient/ddclient/issues/597
-        if 'web_options' in config:
-            if 'url' not in config['web_options']:
-                raise ConfigError(f'"url" in "web-options" {error_msg_req} '
+                verify_interface_exists(config['address']['interface'])
+
+        if 'web' in config['address']:
+            # If 'skip' is specified, 'url' is required as well
+            if 'skip' in config['address']['web'] and 'url' not in config['address']['web']:
+                raise ConfigError(f'"url" along with "skip" {error_msg_req} '
                                   f'with protocol "{config["protocol"]}"')
-            elif re.search("^(https?://)?checkip\.dyndns\.org", config['web_options']['url']):
-                Warning(f'"checkip.dyndns.org" does not support HTTPS requests for IP address '
-                        f'lookup. Please use a different IP address lookup service.')
+            if 'url' in config['address']['web']:
+                # Warn if using checkip.dyndns.org, as it does not support HTTPS
+                # See: https://github.com/ddclient/ddclient/issues/597
+                if re.search("^(https?://)?checkip\.dyndns\.org", config['address']['web']['url']):
+                    Warning(f'"checkip.dyndns.org" does not support HTTPS requests for IP address '
+                            f'lookup. Please use a different IP address lookup service.')
 
         # RFC2136 uses 'key' instead of 'password'
         if config['protocol'] != 'nsupdate' and 'password' not in config:
diff --git a/src/migration-scripts/dns-dynamic/3-to-4 b/src/migration-scripts/dns-dynamic/3-to-4
new file mode 100755
index 000000000..b888a3b6b
--- /dev/null
+++ b/src/migration-scripts/dns-dynamic/3-to-4
@@ -0,0 +1,76 @@
+#!/usr/bin/env python3
+
+# Copyright (C) 2024 VyOS maintainers and contributors
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 2 or later as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# T5966:
+# - migrate "service dns dynamic name <service> address <interface>"
+#        to "service dns dynamic name <service> address interface <interface>"
+#      when <interface> != 'web'
+# - migrate "service dns dynamic name <service> web-options ..."
+#        to "service dns dynamic name <service> address web ..."
+#      when <interface> == 'web'
+
+import sys
+from vyos.configtree import ConfigTree
+
+if len(sys.argv) < 2:
+    print("Must specify file name!")
+    sys.exit(1)
+
+file_name = sys.argv[1]
+
+with open(file_name, 'r') as f:
+    config_file = f.read()
+
+config = ConfigTree(config_file)
+
+base_path = ['service', 'dns', 'dynamic', 'name']
+
+if not config.exists(base_path):
+    # Nothing to do
+    sys.exit(0)
+
+for service in config.list_nodes(base_path):
+
+    service_path = base_path + [service]
+
+    if config.exists(service_path + ['address']):
+        address = config.return_value(service_path + ['address'])
+        # 'address' is not a leaf node anymore, delete it first
+        config.delete(service_path + ['address'])
+
+        # When address is an interface (not 'web'), move it to 'address interface'
+        if address != 'web':
+            config.set(service_path + ['address', 'interface'], address)
+
+        else: # address == 'web'
+            # Relocate optional 'web-options' directly under 'address web'
+            if config.exists(service_path + ['web-options']):
+                # config.copy does not recursively create a path, so initialize it
+                config.set(service_path + ['address'])
+                config.copy(service_path + ['web-options'],
+                            service_path + ['address', 'web'])
+                config.delete(service_path + ['web-options'])
+
+            # ensure that valueless 'address web' still exists even if there are no 'web-options'
+            if not config.exists(service_path + ['address', 'web']):
+                config.set(service_path + ['address', 'web'])
+
+try:
+    with open(file_name, 'w') as f:
+        f.write(config.to_string())
+except OSError as e:
+    print("Failed to save the modified config: {}".format(e))
+    sys.exit(1)
diff --git a/src/op_mode/dns.py b/src/op_mode/dns.py
index 309bef3b9..16c462f23 100755
--- a/src/op_mode/dns.py
+++ b/src/op_mode/dns.py
@@ -15,14 +15,33 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 
-import typing
+import os
 import sys
+import time
+import typing
 import vyos.opmode
 
 from tabulate import tabulate
 from vyos.configquery import ConfigTreeQuery
 from vyos.utils.process import cmd, rc_cmd
+from vyos.template import is_ipv4, is_ipv6
+
+_dynamic_cache_file = r'/run/ddclient/ddclient.cache'
+
+_dynamic_status_columns = {
+    'host':        'Hostname',
+    'ipv4':        'IPv4 address',
+    'status-ipv4': 'IPv4 status',
+    'ipv6':        'IPv6 address',
+    'status-ipv6': 'IPv6 status',
+    'mtime':       'Last update',
+}
 
+_forwarding_statistics_columns = {
+    'cache-entries':     'Cache entries',
+    'max-cache-entries': 'Max cache entries',
+    'cache-size':        'Cache size',
+}
 
 def _forwarding_data_to_dict(data, sep="\t") -> dict:
     """
@@ -50,37 +69,106 @@ def _forwarding_data_to_dict(data, sep="\t") -> dict:
             dictionary[key] = value
     return dictionary
 
+def _get_dynamic_host_records_raw() -> dict:
+
+    data = []
+
+    if os.path.isfile(_dynamic_cache_file): # A ddclient status file might not always exist
+        with open(_dynamic_cache_file, 'r') as f:
+            for line in f:
+                if line.startswith('#'):
+                    continue
+
+                props = {}
+                # ddclient cache rows have properties in 'key=value' format separated by comma
+                # we pick up the ones we are interested in
+                for kvraw in line.split(' ')[0].split(','):
+                    k, v = kvraw.split('=')
+                    if k in list(_dynamic_status_columns.keys()) + ['ip', 'status']:  # ip and status are legacy keys
+                        props[k] = v
+
+                # Extract IPv4 and IPv6 address and status from legacy keys
+                # Dual-stack isn't supported in legacy format, 'ip' and 'status' are for one of IPv4 or IPv6
+                if 'ip' in props:
+                    if is_ipv4(props['ip']):
+                        props['ipv4'] = props['ip']
+                        props['status-ipv4'] = props['status']
+                    elif is_ipv6(props['ip']):
+                        props['ipv6'] = props['ip']
+                        props['status-ipv6'] = props['status']
+                    del props['ip']
+
+                # Convert mtime to human readable format
+                if 'mtime' in props:
+                    props['mtime'] = time.strftime(
+                        "%Y-%m-%d %H:%M:%S", time.localtime(int(props['mtime'], base=10)))
+
+                data.append(props)
+
+    return data
+
+def _get_dynamic_host_records_formatted(data):
+    data_entries = []
+    for entry in data:
+        data_entries.append([entry.get(key) for key in _dynamic_status_columns.keys()])
+    header = _dynamic_status_columns.values()
+    output = tabulate(data_entries, header, numalign='left')
+    return output
 
 def _get_forwarding_statistics_raw() -> dict:
     command = cmd('rec_control get-all')
     data = _forwarding_data_to_dict(command)
-    data['cache-size'] = "{0:.2f}".format( int(
+    data['cache-size'] = "{0:.2f} kbytes".format( int(
         cmd('rec_control get cache-bytes')) / 1024 )
     return data
 
-
 def _get_forwarding_statistics_formatted(data):
-    cache_entries = data.get('cache-entries')
-    max_cache_entries = data.get('max-cache-entries')
-    cache_size = data.get('cache-size')
-    data_entries = [[cache_entries, max_cache_entries, f'{cache_size} kbytes']]
-    headers = ["Cache entries", "Max cache entries" , "Cache size"]
-    output = tabulate(data_entries, headers, numalign="left")
+    data_entries = []
+    data_entries.append([data.get(key) for key in _forwarding_statistics_columns.keys()])
+    header = _forwarding_statistics_columns.values()
+    output = tabulate(data_entries, header, numalign='left')
     return output
 
-def _verify_forwarding(func):
-    """Decorator checks if DNS Forwarding config exists"""
+def _verify(target):
+    """Decorator checks if config for DNS related service exists"""
     from functools import wraps
 
-    @wraps(func)
-    def _wrapper(*args, **kwargs):
-        config = ConfigTreeQuery()
-        if not config.exists('service dns forwarding'):
-            raise vyos.opmode.UnconfiguredSubsystem('DNS Forwarding is not configured')
-        return func(*args, **kwargs)
-    return _wrapper
+    if target not in ['dynamic', 'forwarding']:
+        raise ValueError('Invalid target')
+
+    def _verify_target(func):
+        @wraps(func)
+        def _wrapper(*args, **kwargs):
+            config = ConfigTreeQuery()
+            if not config.exists(f'service dns {target}'):
+                _prefix = f'Dynamic DNS' if target == 'dynamic' else 'DNS Forwarding'
+                raise vyos.opmode.UnconfiguredSubsystem(f'{_prefix} is not configured')
+            return func(*args, **kwargs)
+        return _wrapper
+    return _verify_target
+
+@_verify('dynamic')
+def show_dynamic_status(raw: bool):
+    host_data = _get_dynamic_host_records_raw()
+    if raw:
+        return host_data
+    else:
+        return _get_dynamic_host_records_formatted(host_data)
 
-@_verify_forwarding
+@_verify('dynamic')
+def reset_dynamic():
+    """
+    Reset Dynamic DNS cache
+    """
+    if os.path.exists(_dynamic_cache_file):
+        os.remove(_dynamic_cache_file)
+    rc, output = rc_cmd('systemctl restart ddclient.service')
+    if rc != 0:
+        print(output)
+        return None
+    print(f'Dynamic DNS state reset!')
+
+@_verify('forwarding')
 def show_forwarding_statistics(raw: bool):
     dns_data = _get_forwarding_statistics_raw()
     if raw:
@@ -88,7 +176,7 @@ def show_forwarding_statistics(raw: bool):
     else:
         return _get_forwarding_statistics_formatted(dns_data)
 
-@_verify_forwarding
+@_verify('forwarding')
 def reset_forwarding(all: bool, domain: typing.Optional[str]):
     """
     Reset DNS Forwarding cache
diff --git a/src/op_mode/dns_dynamic.py b/src/op_mode/dns_dynamic.py
deleted file mode 100755
index 12aa5494a..000000000
--- a/src/op_mode/dns_dynamic.py
+++ /dev/null
@@ -1,113 +0,0 @@
-#!/usr/bin/env python3
-#
-# Copyright (C) 2018-2023 VyOS maintainers and contributors
-#
-# This program is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License version 2 or later as
-# published by the Free Software Foundation.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-import os
-import argparse
-import sys
-import time
-from tabulate import tabulate
-
-from vyos.config import Config
-from vyos.template import is_ipv4, is_ipv6
-from vyos.utils.process import call
-
-cache_file = r'/run/ddclient/ddclient.cache'
-
-columns = {
-    'host':        'Hostname',
-    'ipv4':        'IPv4 address',
-    'status-ipv4': 'IPv4 status',
-    'ipv6':        'IPv6 address',
-    'status-ipv6': 'IPv6 status',
-    'mtime':       'Last update',
-}
-
-
-def _get_formatted_host_records(host_data):
-    data_entries = []
-    for entry in host_data:
-        data_entries.append([entry.get(key) for key in columns.keys()])
-
-    header = columns.values()
-    output = tabulate(data_entries, header, numalign='left')
-    return output
-
-
-def show_status():
-    # A ddclient status file might not always exist
-    if not os.path.exists(cache_file):
-        sys.exit(0)
-
-    data = []
-
-    with open(cache_file, 'r') as f:
-        for line in f:
-            if line.startswith('#'):
-                continue
-
-            props = {}
-            # ddclient cache rows have properties in 'key=value' format separated by comma
-            # we pick up the ones we are interested in
-            for kvraw in line.split(' ')[0].split(','):
-                k, v = kvraw.split('=')
-                if k in list(columns.keys()) + ['ip', 'status']:  # ip and status are legacy keys
-                    props[k] = v
-
-            # Extract IPv4 and IPv6 address and status from legacy keys
-            # Dual-stack isn't supported in legacy format, 'ip' and 'status' are for one of IPv4 or IPv6
-            if 'ip' in props:
-                if is_ipv4(props['ip']):
-                    props['ipv4'] = props['ip']
-                    props['status-ipv4'] = props['status']
-                elif is_ipv6(props['ip']):
-                    props['ipv6'] = props['ip']
-                    props['status-ipv6'] = props['status']
-                del props['ip']
-
-            # Convert mtime to human readable format
-            if 'mtime' in props:
-                props['mtime'] = time.strftime(
-                    "%Y-%m-%d %H:%M:%S", time.localtime(int(props['mtime'], base=10)))
-
-            data.append(props)
-
-    print(_get_formatted_host_records(data))
-
-
-def update_ddns():
-    call('systemctl stop ddclient.service')
-    if os.path.exists(cache_file):
-        os.remove(cache_file)
-    call('systemctl start ddclient.service')
-
-
-if __name__ == '__main__':
-    parser = argparse.ArgumentParser()
-    group = parser.add_mutually_exclusive_group()
-    group.add_argument("--status", help="Show DDNS status", action="store_true")
-    group.add_argument("--update", help="Update DDNS on a given interface", action="store_true")
-    args = parser.parse_args()
-
-    # Do nothing if service is not configured
-    c = Config()
-    if not c.exists_effective('service dns dynamic'):
-        print("Dynamic DNS not configured")
-        sys.exit(1)
-
-    if args.status:
-        show_status()
-    elif args.update:
-        update_ddns()