pppoe-server: T2314: migrate IPv4/IPv6 name-servers to common node

Instead of having "dns-server server-1|server-2" nodes and the same for IPv6
all DNS nameservers are migrated to a common name-servers node.

4 files changed, 134 insertions, 130 deletions

diff --git a/data/templates/pppoe-server/pppoe.config.tmpl b/data/templates/pppoe-server/pppoe.config.tmpl
index f7c639f62..66c8c37ac 100644
--- a/data/templates/pppoe-server/pppoe.config.tmpl
+++ b/data/templates/pppoe-server/pppoe.config.tmpl
@@ -64,32 +64,26 @@ delegate={{ prefix }}
 {% endfor %}
 {% endif %}
 
-{% if dns %}
+{% if dnsv4 %}
 [dns]
-{% if dns[0] %}
-dns1={{dns[0]}}
-{% endif -%}
-{% if dns[1] %}
-dns2={{dns[1]}}
-{% endif -%}
+{% for dns in dnsv4 -%}
+dns{{ loop.index }}={{ dns }}
+{% endfor -%}
 {% endif %}
 
 {% if dnsv6 %}
 [ipv6-dns]
-{% for srv in dnsv6: %}
-{{srv}}
-{% endfor %}
+{% for dns in dnsv6 -%}
+{{ dns }}
+{% endfor -%}
 {% endif %}
 
 {% if wins %}
 [wins]
-{% if wins[0] %}
-wins1={{wins[0]}}
+{% for server in wins -%}
+wins{{ loop.index }}={{ server }}
+{% endfor -%}
 {% endif %}
-{% if wins[1] %}
-wins2={{wins[1]}}
-{% endif -%}
-{% endif -%}
 
 {% if auth_mode == 'local' %}
 [chap-secrets]
diff --git a/interface-definitions/service_pppoe-server.xml.in b/interface-definitions/service_pppoe-server.xml.in
index 39f4093a7..dced54b64 100644
--- a/interface-definitions/service_pppoe-server.xml.in
+++ b/interface-definitions/service_pppoe-server.xml.in
@@ -283,81 +283,24 @@
               </leafNode>
             </children>
           </node>
-          <node name="dns-servers">
+          <leafNode name="name-server">
             <properties>
-              <help>IPv4 Domain Name Service (DNS) server</help>
-            </properties>
-            <children>
-            <leafNode name="server-1">
-              <properties>
-                <help>Primary DNS server</help>
-                <valueHelp>
-                  <format>ipv4</format>
-                  <description>IPv4 address</description>
-                </valueHelp>
-                <constraint>
-                  <validator name="ipv4-address"/>
-                </constraint>
-              </properties>
-            </leafNode>
-            <leafNode name="server-2">
-              <properties>
-                <help>Secondary DNS server</help>
-                <valueHelp>
-                  <format>ipv4</format>
-                  <description>IPv4 address</description>
-                </valueHelp>
-                <constraint>
-                  <validator name="ipv4-address"/>
-                </constraint>
-              </properties>
-            </leafNode>
-            </children>
-          </node>
-           <node name="dnsv6-servers">
-            <properties>
-              <help>IPv6 Domain Name Service (DNS) server</help>
+              <help>Domain Name Server (DNS) propagated to client</help>
+              <valueHelp>
+                <format>ipv4</format>
+                <description>Domain Name Server (DNS) IPv4 address</description>
+              </valueHelp>
+              <valueHelp>
+                <format>ipv6</format>
+                <description>Domain Name Server (DNS) IPv6 address</description>
+              </valueHelp>
+              <constraint>
+                <validator name="ipv4-address"/>
+                <validator name="ipv6-address"/>
+              </constraint>
+              <multi/>
             </properties>
-            <children>
-              <leafNode name="server-1">
-                <properties>
-                  <valueHelp>
-                    <format>ipv6</format>
-                    <description>IPv6 address</description>
-                  </valueHelp>
-                  <help>Primary DNS server</help>
-                  <constraint>
-                    <validator name="ipv6-address"/>
-                  </constraint>
-                </properties>
-              </leafNode>
-              <leafNode name="server-2">
-                <properties>
-                  <valueHelp>
-                    <format>ipv6</format>
-                    <description>IPv6 address</description>
-                  </valueHelp>
-                  <help>Secondary DNS server</help>
-                  <constraint>
-                    <validator name="ipv6-address"/>
-                  </constraint>
-                </properties>
-              </leafNode>
-              <leafNode name="server-3">
-                <properties>
-                  <valueHelp>
-                    <format>ipv6</format>
-                  <description>IPv6 address</description>
-                  </valueHelp>
-                  <help>Tertiary DNS server</help>
-                  <constraint>
-                    <validator name="ipv6-address"/>
-                  </constraint>
-                </properties>
-              </leafNode>
-            </children>
-          </node>
-
+          </leafNode>
           <tagNode name="interface">
             <properties>
               <help>interface(s) to listen on</help>
@@ -439,29 +382,19 @@
               <multi/>
             </properties>
           </leafNode>
-          <node name="wins-servers">
+          <leafNode name="wins-server">
             <properties>
-              <help>Windows Internet Name Service (WINS) server settings</help>
+              <help>Windows Internet Name Service (WINS) servers propagated to client</help>
+              <valueHelp>
+                <format>ipv4</format>
+                <description>Domain Name Server (DNS) IPv4 address</description>
+              </valueHelp>
+              <constraint>
+                <validator name="ipv4-address"/>
+              </constraint>
+              <multi/>
             </properties>
-            <children>
-              <leafNode name="server-1">
-                <properties>
-                  <help>Primary WINS server</help>
-                  <constraint>
-                    <validator name="ipv4-address"/>
-                  </constraint>
-                </properties>
-              </leafNode>
-              <leafNode name="server-2">
-                <properties>
-                  <help>Secondary WINS server</help>
-                  <constraint>
-                    <validator name="ipv4-address"/>
-                  </constraint>
-                </properties>
-              </leafNode>
-            </children>
-          </node>
+          </leafNode>
           <node name="ppp-options">
             <properties>
               <help>Advanced protocol options</help>
diff --git a/src/conf_mode/service_pppoe-server.py b/src/conf_mode/service_pppoe-server.py
index 8b7f5a0e9..238208eff 100755
--- a/src/conf_mode/service_pppoe-server.py
+++ b/src/conf_mode/service_pppoe-server.py
@@ -22,9 +22,10 @@ from stat import S_IRUSR, S_IWUSR, S_IRGRP
 from sys import exit
 
 from vyos.config import Config
-from vyos import ConfigError
-from vyos.util import call
 from vyos.template import render
+from vyos.util import call
+from vyos.validate import is_ipv4
+from vyos import ConfigError
 
 pppoe_conf = r'/run/accel-pppd/pppoe.conf'
 pppoe_chap_secrets = r'/run/accel-pppd/pppoe.chap-secrets'
@@ -40,7 +41,7 @@ default_config_data = {
     'local_users' : [],
 
     'svc_name': [],
-    'dns': [],
+    'dnsv4': [],
     'dnsv6': [],
     'wins': [],
     'mtu': '1492',
@@ -118,24 +119,15 @@ def get_config():
     if conf.exists(['local-ip']):
         pppoe['ppp_gw'] = conf.return_value(['local-ip'])
 
-    if conf.exists(['dns-servers']):
-        for server in ['server-1', 'server-2']:
-            if conf.return_value(['dns-servers', server]):
-                tmp = conf.return_value(['dns-servers', server])
-                pppoe['dns'].append(tmp)
-
-
-    if conf.exists(['dnsv6-servers']):
-        for server in ['server-1', 'server-2', 'server-3']:
-            if conf.return_value(['dnsv6-servers', server]):
-                tmp = conf.return_value(['dnsv6-servers', server])
-                pppoe['dnsv6'].append(tmp)
+    if conf.exists(['name-server']):
+        for name_server in conf.return_values(['name-server']):
+            if is_ipv4(name_server):
+                pppoe['dnsv4'].append(name_server)
+            else:
+                pppoe['dnsv6'].append(name_server)
 
-    if conf.exists(['wins-servers']):
-        for server in ['server-1', 'server-2']:
-            if conf.return_value(['wins-servers', server]):
-                tmp = conf.return_value(['wins-servers', server])
-                pppoe['wins'].append(tmp)
+    if conf.exists(['wins-server']):
+        pppoe['wins'] = conf.return_values(['wins-server'])
 
     if conf.exists(['client-ip-pool']):
         if conf.exists(['client-ip-pool', 'start']) and conf.exists(['client-ip-pool', 'stop']):
@@ -374,6 +366,15 @@ def verify(pppoe):
                 server = radius['server']
                 raise ConfigError(f'Missing RADIUS secret key for server "{{ server }}"')
 
+    if len(pppoe['wins']) > 2:
+        raise ConfigError('Not more then two IPv4 WINS name-servers can be configured')
+
+    if len(pppoe['dnsv4']) > 2:
+        raise ConfigError('Not more then two IPv4 DNS name-servers can be configured')
+
+    if len(pppoe['dnsv6']) > 3:
+        raise ConfigError('Not more then three IPv6 DNS name-servers can be configured')
+
     # local ippool and gateway settings config checks
     if pppoe['client_ip_subnets'] or pppoe['client_ip_pool']:
         if not pppoe['ppp_gw']:
diff --git a/src/migration-scripts/pppoe-server/2-to-3 b/src/migration-scripts/pppoe-server/2-to-3
new file mode 100755
index 000000000..c85ada904
--- /dev/null
+++ b/src/migration-scripts/pppoe-server/2-to-3
@@ -0,0 +1,76 @@
+#!/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/>.
+
+# - remove primary/secondary identifier from nameserver
+
+import os
+import sys
+
+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', 'pppoe-server']
+if not config.exists(base):
+    # Nothing to do
+    exit(0)
+else:
+
+    # Migrate IPv4 DNS servers
+    dns_base = base + ['dns-servers']
+    if config.exists(dns_base):
+        for server in ['server-1', 'server-2']:
+          if config.exists(dns_base + [server]):
+            dns = config.return_value(dns_base + [server])
+            config.set(base + ['name-server'], value=dns, replace=False)
+
+        config.delete(dns_base)
+
+    # Migrate IPv6 DNS servers
+    dns_base = base + ['dnsv6-servers']
+    if config.exists(dns_base):
+        for server in ['server-1', 'server-2', 'server-3']:
+          if config.exists(dns_base + [server]):
+            dns = config.return_value(dns_base + [server])
+            config.set(base + ['name-server'], value=dns, replace=False)
+
+        config.delete(dns_base)
+
+    # Migrate IPv4 WINS servers
+    wins_base = base + ['wins-servers']
+    if config.exists(wins_base):
+        for server in ['server-1', 'server-2']:
+          if config.exists(wins_base + [server]):
+            wins = config.return_value(wins_base + [server])
+            config.set(base + ['wins-server'], value=wins, replace=False)
+
+        config.delete(wins_base)
+
+    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)