syslog: T1845: syslog host no longer accepts a port

  - renamed interface xml
  - renamed syslog.py to system-syslog.py
  - moved protocol out of the facility node (bug)
  - node port created
  - migration script included

3 files changed, 102 insertions, 33 deletions

diff --git a/interface-definitions/syslog.xml b/interface-definitions/system-syslog.xml
index d5ea4511e..504efd8fd 100644
--- a/interface-definitions/syslog.xml
+++ b/interface-definitions/system-syslog.xml
@@ -2,7 +2,7 @@
 <interfaceDefinition>
   <node name="system">
     <children>
-      <node name="syslog" owner="${vyos_conf_scripts_dir}/syslog.py">
+      <node name="syslog" owner="${vyos_conf_scripts_dir}/system-syslog.py">
         <properties>
           <help>System logging</help>
           <priority>400</priority>
@@ -191,6 +191,39 @@
               </valueHelp>
             </properties>
             <children>
+              <leafNode name="protocol">
+                <properties>
+                  <help>Syslog communication protocol</help>
+                  <valueHelp>
+                    <format>udp</format>
+                    <description>Send log messages to remote syslog server over udp</description>
+                  </valueHelp>
+                  <valueHelp>
+                    <format>tcp</format>
+                    <description>Send log messages to remote syslog server over tcp</description>
+                  </valueHelp>
+                  <completionHelp>
+                    <list>udp tcp</list>
+                  </completionHelp>
+                  <constraint>
+                    <regex>(udp|tcp)</regex>
+                  </constraint>
+                  <constraintErrorMessage>Invalid protocol name</constraintErrorMessage>
+                </properties>
+              </leafNode>
+              <leafNode name="port">
+                <properties>
+                  <help>Destination port</help>
+                  <valueHelp>
+                    <format>1-65535</format>
+                    <description>Protocol destination port</description>
+                  </valueHelp>
+                  <constraint>
+                    <validator name="numeric" argument="--range 1-65535"/>
+                  </constraint>
+                  <constraintErrorMessage>Invalid destination port</constraintErrorMessage>
+                </properties>
+              </leafNode>
               <tagNode name="facility">
                 <properties>
                   <help>Facility for logging</help>
@@ -295,26 +328,6 @@
                   </valueHelp>
                 </properties>
                 <children>
-                  <leafNode name="protocol">
-                    <properties>
-                      <help>syslog communication protocol</help>
-                      <valueHelp>
-                        <format>udp</format>
-                        <description>send log messages to remote syslog server over udp</description>
-                      </valueHelp>
-                      <valueHelp>
-                        <format>tcp</format>
-                        <description>send log messages to remote syslog server over tcp</description>
-                      </valueHelp>
-                      <completionHelp>
-                        <list>udp tcp</list>
-                      </completionHelp>
-                      <constraint>
-                        <regex>(udp|tcp)</regex>
-                      </constraint>
-                      <constraintErrorMessage>invalid protocol name</constraintErrorMessage>
-                    </properties>
-                  </leafNode>
                   <leafNode name="level">
                     <properties>
                       <help>Logging level</help>
diff --git a/src/conf_mode/syslog.py b/src/conf_mode/system-syslog.py
index c4f3d2c9c..f238acc15 100755
--- a/src/conf_mode/syslog.py
+++ b/src/conf_mode/system-syslog.py
@@ -53,9 +53,9 @@ $outchannel {{file}},{{files[file]['log-file']}},{{files[file]['max-size']}},{{f
 ## remote logging
 {% for host in hosts %}
 {% if hosts[host]['proto'] == 'tcp' %}
-{{hosts[host]['selectors']}} @@{{host}}
+{{hosts[host]['selectors']}} @@{{host}}:{{hosts[host]['port']}}
 {% else %}
-{{hosts[host]['selectors']}} @{{host}}
+{{hosts[host]['selectors']}} @{{host}}:{{hosts[host]['port']}}
 {% endif %}
 {% endfor %}
 {% endif %}
@@ -177,19 +177,22 @@ def get_config():
 
     # set system syslog host
     if c.exists('host'):
-        proto = 'udp'
-        rhosts = c.list_nodes('host')
+        rhosts = c.list_nodes(['host'])
         for rhost in rhosts:
-            for fac in c.list_nodes('host ' + rhost + ' facility'):
-                if c.exists('host ' + rhost + ' facility ' + fac + ' protocol'):
-                    proto = c.return_value(
-                        'host ' + rhost + ' facility ' + fac + ' protocol')
-
+            if c.exists('host ' + rhost + ' port'):
+                port = c.return_value(['host', rhost, 'port'])
+            else:
+                port = '514'
+            if c.exists('host ' + rhost + ' protocol'):
+                proto = c.return_value(['host', rhost, 'protocol'])            
+            else:
+                proto = 'udp'
             config_data['hosts'].update(
                 {
                     rhost: {
                         'selectors': generate_selectors(c, 'host ' + rhost + ' facility'),
-                        'proto': proto
+                        'proto': proto,
+                        'port' : port
                     }
                 }
             )
@@ -289,7 +292,6 @@ def verify(c):
                 for s in c[conf][item]['selectors'].split(";"):
                     f = re.sub("\..*$", "", s)
                     if f not in fac:
-                        print (c[conf])
                         raise ConfigError(
                             'Invalid facility ' + s + ' set in ' + conf + ' ' + item)
                     l = re.sub("^.+\.", "", s)
@@ -297,7 +299,6 @@ def verify(c):
                         raise ConfigError(
                             'Invalid logging level ' + s + ' set in ' + conf + ' ' + item)
 
-
 def apply(c):
     if not c and os.path.exists('/var/run/rsyslogd.pid'):
         os.system("sudo systemctl stop syslog.socket")
diff --git a/src/migration-scripts/system/11-to-12 b/src/migration-scripts/system/11-to-12
new file mode 100755
index 000000000..beba194fc
--- /dev/null
+++ b/src/migration-scripts/system/11-to-12
@@ -0,0 +1,55 @@
+#!/usr/bin/env python3
+
+# converts 'set system syslog host <address>:<port>'
+# to 'set system syslog host <address> port <port>'
+
+import sys
+import re
+
+from vyos.configtree import ConfigTree
+
+if (len(sys.argv) < 1):
+  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)
+cbase = ['system', 'syslog', 'host']
+
+if not config.exists(cbase):
+    sys.exit(0)
+else:
+    config.set(cbase)
+    config.set_tag(cbase)
+    for host in config.list_nodes(cbase):
+        h = None
+        pt = None
+        if re.search('^[a-zA-Z\-0-9\.]+', host):
+            h = re.search('^[a-zA-Z\-0-9\.]+', host).group(0)
+        if re.search(':[0-9]+$', host):
+            pt = re.sub(':', '', re.search(':[0-9]+$', host).group(0))
+
+        config.set(cbase + [h])
+        for fac in config.list_nodes(cbase + [host, 'facility']): 
+            config.set(cbase + [h, 'facility', fac])
+            config.set_tag(cbase + [h, 'facility'])
+            lvl = config.return_value(cbase + [host, 'facility', fac, 'level'])
+            prot = config.return_value(cbase + [host, 'facility', fac, 'protocol'])
+            config.set(cbase + [h, 'facility', fac, 'level'], value=lvl)
+            # port can be be in each tag node and different, 
+            # that's something we can't fix here
+            if prot:
+                config.set(cbase + [h, 'protocol'], value=prot)
+        config.set(cbase + [h, 'port'], value=pt)
+        config.delete(cbase + [host])
+
+    try:
+        open(file_name,'w').write(config.to_string())
+    except OSError as e:
+        print("Failed to save the modified config: {}".format(e))
+        sys.exit(1)
+