dhcpv6-server: T2406: merge sip-server-{address,name} to sip-server node

The subnet specific nodes sip-server-address & sip-server-name do the same for
the user - specify a SIP server. Only the backend is rendered in a different
way, as ISC DHCPv6 expects different options. There is absolutely no need for
the user to distinguish between both two nodes.

3 files changed, 79 insertions, 23 deletions

diff --git a/interface-definitions/dhcpv6-server.xml.in b/interface-definitions/dhcpv6-server.xml.in
index 7d4c0de23..03c826cbf 100644
--- a/interface-definitions/dhcpv6-server.xml.in
+++ b/interface-definitions/dhcpv6-server.xml.in
@@ -243,29 +243,24 @@
                       </tagNode>
                     </children>
                   </node>
-                  <leafNode name="sip-server-address">
+                  <leafNode name="sip-server">
                     <properties>
                       <help>IPv6 address of SIP server</help>
                       <valueHelp>
                         <format>ipv6</format>
                         <description>IPv6 address of SIP server</description>
                       </valueHelp>
+                      <valueHelp>
+                        <format>hostname</format>
+                        <description>FQDN of SIP server</description>
+                      </valueHelp>
                       <constraint>
                         <validator name="ipv6-address"/>
+                        <validator name="fqdn"/>
                       </constraint>
                       <multi/>
                     </properties>
                   </leafNode>
-                  <leafNode name="sip-server-name">
-                    <properties>
-                      <help>SIP server name</help>
-                      <constraint>
-                        <regex>[-_a-zA-Z0-9.]+</regex>
-                      </constraint>
-                      <constraintErrorMessage>Invalid SIP server name. May only contain letters, numbers and .-_</constraintErrorMessage>
-                      <multi/>
-                    </properties>
-                  </leafNode>
                   <leafNode name="sntp-server">
                     <properties>
                       <help>IPv6 address of an SNTP server for client to use</help>
diff --git a/src/conf_mode/dhcpv6_server.py b/src/conf_mode/dhcpv6_server.py
index 07e936906..6bfee94a1 100755
--- a/src/conf_mode/dhcpv6_server.py
+++ b/src/conf_mode/dhcpv6_server.py
@@ -23,7 +23,7 @@ from copy import deepcopy
 from vyos.config import Config
 from vyos.template import render
 from vyos.util import call
-from vyos.validate import is_subnet_connected
+from vyos.validate import is_subnet_connected, is_ipv6
 from vyos import ConfigError
 
 config_file = r'/run/dhcp-server/dhcpdv6.conf'
@@ -37,10 +37,11 @@ default_config_data = {
 def get_config():
     dhcpv6 = deepcopy(default_config_data)
     conf = Config()
-    if not conf.exists('service dhcpv6-server'):
+    base = ['service', 'dhcpv6-server']
+    if not conf.exists(base):
         return None
     else:
-        conf.set_level('service dhcpv6-server')
+        conf.set_level(base)
 
     # Check for global disable of DHCPv6 service
     if conf.exists('disable'):
@@ -121,8 +122,8 @@ def get_config():
                     # The domain-search option specifies a 'search list' of Domain Names to be used
                     # by the client to locate not-fully-qualified domain names.
                     if conf.exists('domain-search'):
-                        for domain in conf.return_values('domain-search'):
-                            subnet['domain_search'].append('"' + domain + '"')
+                        for value in conf.return_values('domain-search'):
+                            subnet['domain_search'].append(f'"{value}"')
 
                     # IPv6 address valid lifetime
                     #  (at the end the address is no longer usable by the client)
@@ -166,13 +167,12 @@ def get_config():
                         print('TODO: This option is actually not implemented right now!')
 
                     # Local SIP server that is to be used for all outbound SIP requests - IPv6 address
-                    if conf.exists('sip-server-address'):
-                        subnet['sip_address'] = conf.return_values('sip-server-address')
-
-                    # Local SIP server that is to be used for all outbound SIP requests - hostname
-                    if conf.exists('sip-server-name'):
-                        for hostname in conf.return_values('sip-server-name'):
-                            subnet['sip_hostname'].append('"' + hostname + '"')
+                    if conf.exists('sip-server'):
+                        for value in conf.return_values('sip-server'):
+                            if is_ipv6(value):
+                                subnet['sip_address'].append(value)
+                            else:
+                                subnet['sip_hostname'].append(f'"{value}"')
 
                     # List of local SNTP servers available for the client to synchronize their clocks
                     if conf.exists('sntp-server'):
diff --git a/src/migration-scripts/dhcpv6-server/0-to-1 b/src/migration-scripts/dhcpv6-server/0-to-1
new file mode 100755
index 000000000..6f1150da1
--- /dev/null
+++ b/src/migration-scripts/dhcpv6-server/0-to-1
@@ -0,0 +1,61 @@
+#!/usr/bin/env python3
+#
+# Copyright (C) 2020 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/>.
+
+# combine both sip-server-address and sip-server-name nodes to common sip-server
+
+from sys import argv, exit
+from vyos.configtree import ConfigTree
+
+if (len(argv) < 1):
+    print("Must specify file name!")
+    exit(1)
+
+file_name = argv[1]
+
+with open(file_name, 'r') as f:
+    config_file = f.read()
+
+config = ConfigTree(config_file)
+base = ['service', 'dhcpv6-server', 'shared-network-name']
+if not config.exists(base):
+    # Nothing to do
+    exit(0)
+else:
+    # we need to run this for every configured network
+    for network in config.list_nodes(base):
+        for subnet in config.list_nodes(base + [network, 'subnet']):
+            sip_server = []
+
+            # Do we have 'sip-server-address' configured?
+            if config.exists(base + [network, 'subnet', subnet, 'sip-server-address']):
+                sip_server += config.return_values(base + [network, 'subnet', subnet, 'sip-server-address'])
+                config.delete(base + [network, 'subnet', subnet, 'sip-server-address'])
+
+            # Do we have 'sip-server-name' configured?
+            if config.exists(base + [network, 'subnet', subnet, 'sip-server-name']):
+                sip_server += config.return_values(base + [network, 'subnet', subnet, 'sip-server-name'])
+                config.delete(base + [network, 'subnet', subnet, 'sip-server-name'])
+
+            # Write new CLI value for sip-server
+            for server in sip_server:
+                config.set(base + [network, 'subnet', subnet, 'sip-server'], value=server, replace=False)
+
+    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))
+        exit(1)