From a16242976bfc3aa6303546ffa40fbfcb4ec96ad9 Mon Sep 17 00:00:00 2001
From: Fabian Franz <fabianfrz@users.noreply.github.com>
Date: Wed, 10 May 2017 11:23:46 +0200
Subject: [PATCH] Quagga: Add OSPFv3 Diagnostics (#151)

* add UI changes

* add template for routes

* add database

* diagnostics lsa
---
 .../OPNsense/Quagga/DiagnosticsController.php |   5 +
 .../app/models/OPNsense/Quagga/Menu/Menu.xml  |   5 +-
 .../OPNsense/Quagga/diagnosticsospfv3.volt    | 371 ++++++++++++++++++
 3 files changed, 379 insertions(+), 2 deletions(-)
 create mode 100644 net/quagga/src/opnsense/mvc/app/views/OPNsense/Quagga/diagnosticsospfv3.volt

diff --git a/net/quagga/src/opnsense/mvc/app/controllers/OPNsense/Quagga/DiagnosticsController.php b/net/quagga/src/opnsense/mvc/app/controllers/OPNsense/Quagga/DiagnosticsController.php
index f57e9cda8..2df01e100 100644
--- a/net/quagga/src/opnsense/mvc/app/controllers/OPNsense/Quagga/DiagnosticsController.php
+++ b/net/quagga/src/opnsense/mvc/app/controllers/OPNsense/Quagga/DiagnosticsController.php
@@ -37,6 +37,11 @@ class DiagnosticsController extends \OPNsense\Base\IndexController
         $this->view->title = gettext("Diagnostics: OSPF");
         $this->view->pick('OPNsense/Quagga/diagnosticsospf');
     }
+    public function ospfv3Action()
+    {
+        $this->view->title = gettext("Diagnostics: OSPFv3");
+        $this->view->pick('OPNsense/Quagga/diagnosticsospfv3');
+    }
     public function generalAction()
     {
         $this->view->title = gettext("Diagnostics: General");
diff --git a/net/quagga/src/opnsense/mvc/app/models/OPNsense/Quagga/Menu/Menu.xml b/net/quagga/src/opnsense/mvc/app/models/OPNsense/Quagga/Menu/Menu.xml
index 554222fea..2dbceccd3 100644
--- a/net/quagga/src/opnsense/mvc/app/models/OPNsense/Quagga/Menu/Menu.xml
+++ b/net/quagga/src/opnsense/mvc/app/models/OPNsense/Quagga/Menu/Menu.xml
@@ -3,13 +3,14 @@
     <General VisibleName="General" cssClass="fa fa-map-signs fa-fw" url="/ui/quagga/general/index" order="1"/>
     <RIP VisibleName="RIP" cssClass="fa fa-expand fa-fw" url="/ui/quagga/rip/index" order="10" />
     <OSPF VisibleName="OSPF" cssClass="fa fa-map fa-fw" url="/ui/quagga/ospf/index" order="20" />
-    <OSPF6 VisibleName="OSPFv3" cssClass="fa fa-map fa-fw" url="/ui/quagga/ospf6/index" order="25" />
+    <OSPFv3 VisibleName="OSPFv3" cssClass="fa fa-map fa-fw" url="/ui/quagga/ospf6/index" order="25" />
     <!--<ISIS VisibleName="IS-IS" cssClass="fa fa-bolt fa-fw" url="/ui/quagga/isis/index" order="30" />-->
     <BGP VisibleName="BGPv4" cssClass="fa fa-globe fa-fw" url="/ui/quagga/bgp/index" order="40" />
     <Diagnostics VisibleName="Diagnostics" cssClass="fa fa-medkit fa-fw" order="50">
       <General VisibleName="General" url="/ui/quagga/diagnostics/general" order="1" />
-      <BGP VisibleName="BGPv4" url="/ui/quagga/diagnostics/bgp" order="40" />
       <OSPF VisibleName="OSPF" url="/ui/quagga/diagnostics/ospf" order="20" />
+      <OSPFv3 VisibleName="OSPFv3" url="/ui/quagga/diagnostics/ospfv3" order="25" />
+      <BGP VisibleName="BGPv4" url="/ui/quagga/diagnostics/bgp" order="40" />
     </Diagnostics>
   </Routing>
 </menu>
diff --git a/net/quagga/src/opnsense/mvc/app/views/OPNsense/Quagga/diagnosticsospfv3.volt b/net/quagga/src/opnsense/mvc/app/views/OPNsense/Quagga/diagnosticsospfv3.volt
new file mode 100644
index 000000000..b256f5e4b
--- /dev/null
+++ b/net/quagga/src/opnsense/mvc/app/views/OPNsense/Quagga/diagnosticsospfv3.volt
@@ -0,0 +1,371 @@
+{#
+
+OPNsense® is Copyright © 2014 – 2017 by Deciso B.V.
+Copyright (C) 2017 Fabian Franz
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+1.  Redistributions of source code must retain the above copyright notice,
+    this list of conditions and the following disclaimer.
+
+2.  Redistributions in binary form must reproduce the above copyright notice,
+    this list of conditions and the following disclaimer in the documentation
+    and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES,
+INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
+OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
+
+#}
+
+<script type="text/x-template" id="overviewtpl">
+<h2>{{ lang._('General') }}</h2>
+<table>
+  <tbody>
+    <tr>
+      <td>{{ lang._("Router ID") }}</td>
+      <td><%= ospfv3_overview['router_id'] %></td>
+    </tr>
+    <tr>
+      <td>{{ lang._("Routing Process") }}</td>
+      <td><%= ospfv3_overview['routing_process'] %></td>
+    </tr>
+    <tr>
+      <td>{{ lang._("Running Time") }}</td>
+      <td><%= ospfv3_overview['running_time'] %></td>
+    </tr>
+    <tr>
+      <td>{{ lang._("Initial SPF scheduling delay") }}</td>
+      <td><%= ospfv3_overview['intital_spf_scheduling_delay'] %></td>
+    </tr>
+    <tr>
+      <td>{{ lang._("Hold Time") }}</td>
+      <td>
+        {{ lang._("Minimum Hold Time") }} <%= ospfv3_overview['hold_time']['min'] %><br/>
+        {{ lang._("Maximum Hold Time:") }} <%= ospfv3_overview['hold_time']['max'] %>
+      </td>
+    </tr>
+    <tr>
+      <td>{{ lang._("SPF timer") }}</td>
+      <td><%= ospfv3_overview['spf_timer'] %></td>
+    </tr>
+    <tr>
+      <td>{{ lang._("Number Of Scoped AS") }}</td>
+      <td><%= ospfv3_overview['number_as_scoped'] %></td>
+    </tr>
+    <tr>
+      <td>{{ lang._("Number Of Areas") }}</td>
+      <td><%= ospfv3_overview['number_of_areas'] %></td>
+    </tr>
+  </tbody>
+</table>
+<h2>{{ lang._('Areas') }}</h2>
+<% if (ospfv3_overview['areas']) { %>
+  <% areas = ospfv3_overview['areas'] %>
+  <% _.each(_.keys(areas), function(areaname) { %>
+    <% area = areas[areaname] %>
+    <h3><%= areaname %></h3>
+    <table>
+      <tbody>
+        <tr>
+          <td>{{ lang._("Number Of LSAs") }}</td>
+          <td><%= area['number_lsas'] %></td>
+        </tr>
+        <tr>
+          <td>{{ lang._("Interfaces") }}</td>
+          <td><%= _.join(area['interfaces'], ", ") %></td>
+        </tr>
+      </tbody>
+    </table>
+  <% }) %>
+<% } %>
+</script>
+
+<script type="text/x-template" id="routestpl">
+  <table>
+    <thead>
+      <tr>
+        <th>{{ lang._('Flags 1') }}</th>
+        <th>{{ lang._('Flags 2') }}</th>
+        <th>{{ lang._('Network') }}</th>
+        <th>{{ lang._('Gateway') }}</th>
+        <th>{{ lang._('Interface') }}</th>
+        <th>{{ lang._('Time') }}</th>
+      </tr>
+    </thead>
+    <tbody>
+      <% _.each(ospfv3_route, function (route) { %>
+        <tr>
+          <td><%= route['f1'] %></td>
+          <td><%= route['f2'] %></td>
+          <td><%= route['network'] %></td>
+          <td><%= route['gateway'] %></td>
+          <td><%= route['interface'] %></td>
+          <td><%= route['time'] %></td>
+        </tr>
+      <% }) %>
+    </tbody>
+  </table>
+</script>
+
+<script type="text/x-template" id="databasetpl">
+  <% if(ospfv3_database['scoped_link_db']) { %>
+    <h2>{{ lang._('Scoped Link Database') }}</h2>
+    <% _.each(_.keys(ospfv3_database['scoped_link_db']), function(areaname) { %>
+      <% area = ospfv3_database['scoped_link_db'][areaname] %>
+      <h3><% areaname %></h3>
+      <table>
+        <thead>
+          <tr>
+            <th>{{ lang._('Type') }}</th>
+            <th>{{ lang._('LS ID') }}</th>
+            <th>{{ lang._('Advertising Router') }}</th>
+            <th>{{ lang._('Age') }}</th>
+            <th>{{ lang._('Sequence Number') }}</th>
+            <th>{{ lang._('Payload') }}</th>
+          </tr>
+        </thead>
+        <tbody>
+          <% _.each(area, function(entry) { %>
+            <tr>
+              <td><%= entry['Type'] %></td>
+              <td><%= entry['LSId'] %></td>
+              <td><%= entry['AdvRouter'] %></td>
+              <td><%= entry['Age'] %></td>
+              <td><%= entry['SeqNum'] %></td>
+              <td><%= entry['Payload'] %></td>
+            </tr>
+          <% }) %>
+        </tbody>
+      </table>
+    <% }) %>
+  <% } %>
+  <% if(ospfv3_database['if_scoped_link_state']) { %>
+    <h2>{{ lang._('Interface Scoped Link Database') }}</h2>
+    <% _.each(_.keys(ospfv3_database['if_scoped_link_state']), function(intfname) { %>
+      <% intf = ospfv3_database['if_scoped_link_state'][intfname] %>
+      <% _.each(_.keys(intf), function(areaname) { %>
+        <% area = intf[areaname] %>
+        <h3><%= intfname %> / <%= areaname %></h3>
+        <table>
+          <thead>
+            <tr>
+              <th>{{ lang._('Type') }}</th>
+              <th>{{ lang._('LS ID') }}</th>
+              <th>{{ lang._('Advertising Router') }}</th>
+              <th>{{ lang._('Age') }}</th>
+              <th>{{ lang._('Sequence Number') }}</th>
+              <th>{{ lang._('Payload') }}</th>
+            </tr>
+          </thead>
+          <tbody>
+            <% _.each(area, function(entry) { %>
+              <tr>
+                <td><%= entry['Type'] %></td>
+                <td><%= entry['LSId'] %></td>
+                <td><%= entry['AdvRouter'] %></td>
+                <td><%= entry['Age'] %></td>
+                <td><%= entry['SeqNum'] %></td>
+                <td><%= entry['Payload'] %></td>
+              </tr>
+            <% }) %>
+          </tbody>
+        </table>
+      <% }) %>
+    <% }) %>
+  <% } %>
+  <% if (ospfv3_database['as_scoped']) { %>
+    <h2>{{ lang._('AS Scpoed') }}</h2>
+    <table>
+      <thead>
+        <tr>
+          <th>{{ lang._('Type') }}</th>
+          <th>{{ lang._('LS ID') }}</th>
+          <th>{{ lang._('Advertising Router') }}</th>
+          <th>{{ lang._('Age') }}</th>
+          <th>{{ lang._('Sequence Number') }}</th>
+          <th>{{ lang._('Payload') }}</th>
+        </tr>
+      </thead>
+      <tbody>
+        <% _.each(ospfv3_database['as_scoped'], function(entry) { %>
+          <tr>
+            <td><%= entry['Type'] %></td>
+            <td><%= entry['LSId'] %></td>
+            <td><%= entry['AdvRouter'] %></td>
+            <td><%= entry['Age'] %></td>
+            <td><%= entry['SeqNum'] %></td>
+            <td><%= entry['Payload'] %></td>
+          </tr>
+        <% }) %>
+      </tbody>
+    </table>
+  <% } %>
+</script>
+
+<script type="text/x-template" id="interfacetpl">
+<% _.each(_.keys(ospfv3_interface), function(interfacename) { %>
+  <% int = ospfv3_interface[interfacename] %>
+  <h2><%= interfacename %></h2>
+  <table>
+    <tbody>
+      <% _.each(_.keys(int), function(propertyname) { %>
+        <% if (propertyname != 'pending_lsas' ) { %>
+          <tr>
+            <td><%= translate(propertyname) %></td>
+            <td>
+              <% if (int[propertyname] === false || int[propertyname] === true)  { %>
+                <%= checkmark(int[propertyname]) %>
+              <% } else if (propertyname == 'timers')  { %>
+                {{ lang._('Hello Timer:') }} <%= int[propertyname]['hello'] %><br />
+                {{ lang._('Dead Timer:') }} <%= int[propertyname]['dead'] %><br />
+                {{ lang._('Wait Timer:') }} <%= int[propertyname]['wait'] %><br />
+                {{ lang._('Retransmit Timer:') }} <%= int[propertyname]['retransmit'] %>
+              <% } else if (propertyname == 'IPv6' || propertyname == 'IPv4')  { %>
+                <%= _.join(int[propertyname],'<br />') %><br />
+              <% } else if (propertyname == 'area_cost')  { %>
+                <% _.each(int[propertyname], function (ac) { %>
+                  <%= ac['area'] %>: <%= ac['cost'] %><br />
+                <% }) %> 
+              <% } else { %>
+                <%= translate(int[propertyname]) %>
+              <% } %>
+            </td>
+          </tr>
+        <% } else { %>
+          <% _.each(_.keys(int[propertyname]), function(lsa) { %>
+          <% mylsa = int[propertyname][lsa] %>
+            <tr>
+              <td><%= lsa %> {{ lang._('Time') }}</td>
+              <td><%= mylsa['time'] %> </td>
+            </tr>
+            <tr>
+              <td><%= lsa %> {{ lang._('Count') }}</td>
+              <td><%= mylsa['Count'] %> </td>
+            </tr>
+            <tr>
+              <td><%= lsa %> {{ lang._('Flags') }}</td>
+              <td><%= mylsa['flags'] %> </td>
+            </tr>
+          <% }) %>
+        <% } %>
+      <% }); %>
+    </tbody>
+  </table>
+<% }) %>
+</script>
+<script type="text/javascript" src="/ui/js/quagga/lodash.js"></script>
+<script>
+
+function translate(data)
+{
+  tr = []
+  tr['count'] = '{{ lang._('Count') }}'
+  tr['router'] = '{{ lang._('Router') }}'
+  tr['network'] = '{{ lang._('Network') }}'
+  tr['summary'] = '{{ lang._('Summary') }}'
+  tr['ASBR summary'] = '{{ lang._('ASBR summary') }}'
+  tr['NSSA'] = '{{ lang._('NSSA') }}'
+  tr['directly attached'] = '{{ lang._('Directly Attached') }}'
+  tr['Full/DR'] = '{{ lang._('Full (Designated Router)') }}'
+  tr['enabled'] = '{{ lang._('Enabled') }}'
+  tr['cost'] = '{{ lang._('Cost') }}'
+  tr['priority'] = '{{ lang._('Priority') }}'
+  tr['router_id'] = '{{ lang._('Router ID') }}'
+  tr['network_type'] = '{{ lang._('Network Type') }}'
+  tr['area'] = '{{ lang._('Area') }}'
+  tr['transmit_delay'] = '{{ lang._('Transmit Delay') }}'
+  tr['state'] = '{{ lang._('State') }}'
+  tr['broadcast'] = '{{ lang._('Broadcast') }}'
+  tr['mtu_mismatch_detection'] = '{{ lang._('MTU Mismatch Detection') }}'
+  tr['address'] = '{{ lang._('Address') }}'
+  tr['designated_router'] = '{{ lang._('Designated Router') }}'
+  tr['designated_router_interface_address'] = '{{ lang._('Designated Router Interface Address') }}'
+  tr['backup_designated_router'] = '{{ lang._('Backup Designated Router') }}'
+  tr['multicast_group_memberships'] = '{{ lang._('Multicast Group Memberships') }}'
+  tr['intervals'] = '{{ lang._('Intervals') }}'
+  tr['hello_due_in'] = '{{ lang._('Hello Due In') }}'
+  tr['neighbor_count'] = '{{ lang._('Neighbor Count') }}'
+  tr['adjacent_neighbor_count'] = '{{ lang._('Adjacent Neighbor Count') }}'
+  tr['timers'] = '{{ lang._('Timers') }}'
+  tr['number_if_scoped_lsas'] = '{{ lang._('Number Of Interface Scoped LSAs') }}'
+  tr['pending_lsas'] = '{{ lang._('Pending LSAs') }}'
+  tr['area_cost'] = '{{ lang._('Area Cost') }}'
+  tr['instance_id'] = '{{ lang._('Instance ID') }}'
+  tr['interface_mtu'] = '{{ lang._('Interface MTU') }}'
+  tr['type'] = '{{ lang._('Type') }}'
+  tr['id'] = '{{ lang._('ID') }}'
+  tr['up'] = '{{ lang._('Up') }}'
+  tr['DR'] = '{{ lang._('Designated Router') }}'
+  tr['BDR'] = '{{ lang._('Backup Designated Router') }}'
+  tr['BROADCAST'] = '{{ lang._('Broadcast') }}'
+  tr['UNKNOWN'] = '{{ lang._('Unknown') }}'
+  tr['POINTOPOINT'] = '{{ lang._('Point to Point') }}'
+  tr['LOOPBACK'] = '{{ lang._('Loopback') }}'
+  return _.has(tr,data) ? tr[data] : data
+}
+
+function checkmark(bin)
+{
+  return "<i class=\"fa " + (bin ? "fa-check-square" : "fa-square") + " text-muted\"></i>";
+}
+
+$(document).ready(function() {
+  ajaxCall(url="/api/quagga/service/status", sendData={}, callback=function(data,status) {
+      updateServiceStatusUI(data['status'])
+  });
+
+  ajaxCall(url="/api/quagga/diagnostics/ospfv3overview", sendData={}, callback=function(data,status) {
+    content = _.template($('#overviewtpl').html())(data['response'])
+    $('#overview').html(content)
+  });
+  ajaxCall(url="/api/quagga/diagnostics/ospfv3database", sendData={}, callback=function(data,status) {
+    content = _.template($('#databasetpl').html())(data['response'])
+    $('#database').html(content)
+  });
+  ajaxCall(url="/api/quagga/diagnostics/ospfv3route", sendData={}, callback=function(data,status) {
+    content = _.template($('#routestpl').html())(data['response'])
+    $('#routing').html(content)
+  });
+  /*ajaxCall(url="/api/quagga/diagnostics/ospfv3neighbor", sendData={}, callback=function(data,status) {
+    content = _.template($('#neighbortpl').html())(data['response'])
+    $('#neighbor').html(content)
+  });*/
+  ajaxCall(url="/api/quagga/diagnostics/ospfv3interface", sendData={}, callback=function(data,status) {
+    content = _.template($('#interfacetpl').html())(data['response'])
+    $('#interface').html(content)
+  });
+
+
+});
+</script>
+
+<!-- Navigation bar -->
+<ul class="nav nav-tabs" data-tabs="tabs" id="maintabs">
+    <li class="active"><a data-toggle="tab" href="#overview">{{ lang._('Overview') }}</a></li>
+    <li><a data-toggle="tab" href="#routing">{{ lang._('Routing Table') }}</a></li>
+    <li><a data-toggle="tab" href="#database">{{ lang._('Database') }}</a></li>
+    <!--<li><a data-toggle="tab" href="#neighbor">{{ lang._('Neighbor') }}</a></li>-->
+    <li><a data-toggle="tab" href="#interface">{{ lang._('Interface') }}</a></li>
+</ul>
+<div class="tab-content content-box tab-content">
+    <div id="overview" class="tab-pane fade in active">
+    </div>
+    <div id="routing" class="tab-pane fade in">
+    </div>
+    <div id="database" class="tab-pane fade in">
+    </div>
+    <div id="neighbor" class="tab-pane fade in">
+    </div>
+    <div id="interface" class="tab-pane fade in">
+    </div>
+</div>