pppoe: T1318: move Jinja2 templates to data/templates folder

This makes the actual code which generates the configs much more human
readable.

1 files changed, 24 insertions, 153 deletions

diff --git a/src/conf_mode/interfaces-pppoe.py b/src/conf_mode/interfaces-pppoe.py
index 97b0ff0df..66f7ed5fd 100755
--- a/src/conf_mode/interfaces-pppoe.py
+++ b/src/conf_mode/interfaces-pppoe.py
@@ -18,152 +18,14 @@ import os
 
 from sys import exit
 from copy import deepcopy
-from jinja2 import Template
+from jinja2 import FileSystemLoader, Environment
+from netifaces import interfaces
 
 from vyos.config import Config
+from vyos.defaults import directories as vyos_data_dir
 from vyos.ifconfig import Interface
 from vyos.util import chown_file, chmod_x_file, subprocess_cmd
 from vyos import ConfigError
-from netifaces import interfaces
-
-# Please be careful if you edit the template.
-config_pppoe_tmpl = """### Autogenerated by interfaces-pppoe.py ###
-{% if description %}
-# {{ description }}
-{% endif %}
-
-# Require peer to provide the local IP address if it is not
-# specified explicitly in the config file.
-noipdefault
-
-# Don't show the password in logfiles:
-hide-password
-
-# Standard Link Control Protocol (LCP) parameters:
-lcp-echo-interval 20
-lcp-echo-failure 3
-
-# RFC 2516, paragraph 7 mandates that the following options MUST NOT be
-# requested and MUST be rejected if requested by the peer:
-# Address-and-Control-Field-Compression (ACFC)
-noaccomp
-
-# Asynchronous-Control-Character-Map (ACCM)
-default-asyncmap
-
-# Override any connect script that may have been set in /etc/ppp/options.
-connect /bin/true
-
-# Don't try to authenticate the remote node
-noauth
-
-# Don't try to proxy ARP for the remote endpoint. User can set proxy
-# arp entries up manually if they wish.  More importantly, having
-# the "proxyarp" parameter set disables the "defaultroute" option.
-noproxyarp
-
-# Unlimited connection attempts
-maxfail 0
-
-plugin rp-pppoe.so
-{{ source_interface }}
-persist
-ifname {{ intf }}
-ipparam {{ intf }}
-debug
-logfile {{ logfile }}
-{% if 'auto' in default_route -%}
-defaultroute
-{% elif 'force' in default_route -%}
-defaultroute
-replacedefaultroute
-{% endif %}
-mtu {{ mtu }}
-mru {{ mtu }}
-user "{{ auth_username }}"
-password "{{ auth_password }}"
-{% if name_server -%}
-usepeerdns
-{% endif %}
-{% if ipv6_enable -%}
-+ipv6
-ipv6cp-use-ipaddr
-{% endif %}
-{% if service_name -%}
-rp_pppoe_service "{{ service_name }}"
-{% endif %}
-{% if on_demand %}
-demand
-{% endif %}
-
-"""
-
-# Please be careful if you edit the template.
-# There must be no blank line at the top pf the script file
-config_pppoe_ipv6_up_tmpl = """#!/bin/sh
-
-# As PPPoE is an "on demand" interface we need to re-configure it when it
-# becomes up
-
-if [ "$6" != "{{ intf }}" ]; then
-    exit
-fi
-
-{% if ipv6_autoconf -%}
-# add some info to syslog
-DIALER_PID=$(cat /var/run/{{ intf }}.pid)
-logger -t pppd[$DIALER_PID] "executing $0"
-logger -t pppd[$DIALER_PID] "configuring interface {{ intf }} via $2"
-
-# Configure interface-specific Host/Router behaviour.
-# Note: It is recommended to have the same setting on all interfaces; mixed
-# router/host scenarios are rather uncommon. Possible values are:
-#
-# 0  Forwarding disabled
-# 1  Forwarding enabled
-#
-echo 1 > /proc/sys/net/ipv6/conf/{{ intf }}/forwarding
-
-# Accept Router Advertisements; autoconfigure using them.
-#
-# It also determines whether or not to transmit Router
-# Solicitations. If and only if the functional setting is to
-# accept Router Advertisements, Router Solicitations will be
-# transmitted. Possible values are:
-#
-# 0  Do not accept Router Advertisements.
-# 1  Accept Router Advertisements if forwarding is disabled.
-# 2  Overrule forwarding behaviour. Accept Router Advertisements
-#    even if forwarding is enabled.
-#
-echo 2 > /proc/sys/net/ipv6/conf/{{ intf }}/accept_ra
-
-# Autoconfigure addresses using Prefix Information in Router Advertisements.
-echo 1 > /proc/sys/net/ipv6/conf/{{ intf }}/autoconfigure
-{% endif %}
-"""
-
-config_pppoe_ip_up_tmpl = """#!/bin/sh
-
-# As PPPoE is an "on demand" interface we need to re-configure it when it
-# becomes up
-
-if [ "$6" != "{{ intf }}" ]; then
-    exit
-fi
-
-# add some info to syslog
-DIALER_PID=$(cat /var/run/{{ intf }}.pid)
-logger -t pppd[$DIALER_PID] "executing $0"
-
-echo "{{ description }}" > /sys/class/net/{{ intf }}/ifalias
-
-{% if vrf -%}
-logger -t pppd[$DIALER_PID] "configuring dialer interface $6 for VRF {{ vrf }}"
-ip link set dev {{ intf }} master {{ vrf }}
-{% endif %}
-
-"""
 
 default_config_data = {
     'access_concentrator': '',
@@ -296,12 +158,19 @@ def verify(pppoe):
     return None
 
 def generate(pppoe):
+    # Prepare Jinja2 template loader from files
+    tmpl_path = os.path.join(vyos_data_dir["data"], "templates", "pppoe")
+    fs_loader = FileSystemLoader(tmpl_path)
+    env = Environment(loader=fs_loader)
+
+    # set up configuration file path variables where our templates will be
+    # rendered into
     intf = pppoe['intf']
-    config_file_pppoe = f'/etc/ppp/peers/{intf}'
-    ip_up_script_file = f'/etc/ppp/ip-up.d/9990-vyos-vrf-{intf}'
-    ipv6_if_up_script_file = f'/etc/ppp/ipv6-up.d/9990-vyos-autoconf-{intf}'
+    config_pppoe = f'/etc/ppp/peers/{intf}'
+    script_pppoe_pre_up = f'/etc/ppp/ip-up.d/1000-vyos-pppoe-{intf}'
+    script_pppoe_ipv6_up = f'/etc/ppp/ipv6-up.d/1000-vyos-pppoe-autoconf-{intf}'
 
-    config_files = [config_file_pppoe, ip_up_script_file, ipv6_if_up_script_file]
+    config_files = [config_pppoe, script_pppoe_pre_up, script_pppoe_ipv6_up]
 
     # Ensure directories for config files exist - otherwise create them on demand
     for file in config_files:
@@ -321,24 +190,26 @@ def generate(pppoe):
 
     else:
         # Create PPP configuration files
-        tmpl = Template(config_pppoe_tmpl)
+        tmpl = env.get_template('peer.tmpl')
         config_text = tmpl.render(pppoe)
-        with open(config_file_pppoe, 'w') as f:
+        with open(config_pppoe, 'w') as f:
             f.write(config_text)
 
-        tmpl = Template(config_pppoe_ip_up_tmpl)
+        # Create script for ip-pre-up.d
+        tmpl = env.get_template('ip-pre-up.script.tmpl')
         config_text = tmpl.render(pppoe)
-        with open(ip_up_script_file, 'w') as f:
+        with open(script_pppoe_pre_up, 'w') as f:
             f.write(config_text)
 
-        tmpl = Template(config_pppoe_ipv6_up_tmpl)
+        # Create script for ipv6-up.d
+        tmpl = env.get_template('ipv6-up.script.tmpl')
         config_text = tmpl.render(pppoe)
-        with open(ipv6_if_up_script_file, 'w') as f:
+        with open(script_pppoe_ipv6_up, 'w') as f:
             f.write(config_text)
 
         # make generated script file executable
-        chmod_x_file(ip_up_script_file)
-        chmod_x_file(ipv6_if_up_script_file)
+        chmod_x_file(script_pppoe_pre_up)
+        chmod_x_file(script_pppoe_ipv6_up)
 
     return None