From 6b1340cfdfcee321b07a2915de848ebc32a6bfc4 Mon Sep 17 00:00:00 2001
From: Adam Warner <me@adamwarner.co.uk>
Date: Tue, 19 May 2020 07:54:05 +0100
Subject: [PATCH 1/3] Add staveSave property bool to DHCP tables to remember
 last used sort direction/column

Signed-off-by: Adam Warner <me@adamwarner.co.uk>
---
 scripts/pi-hole/js/settings.js | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/scripts/pi-hole/js/settings.js b/scripts/pi-hole/js/settings.js
index 132935e0..533f08d9 100644
--- a/scripts/pi-hole/js/settings.js
+++ b/scripts/pi-hole/js/settings.js
@@ -174,7 +174,8 @@ $(document).ready(function () {
       scrollCollapse: true,
       scrollY: "200px",
       scrollX: true,
-      order: [[2, "asc"]]
+      order: [[2, "asc"]],
+      stateSave: true
     });
   }
 
@@ -186,7 +187,8 @@ $(document).ready(function () {
       scrollCollapse: true,
       scrollY: "200px",
       scrollX: true,
-      order: [[2, "asc"]]
+      order: [[2, "asc"]],
+      stateSave: true
     });
   }
 

From eb05394b66af57684d16e4195dd274e4f19ebc38 Mon Sep 17 00:00:00 2001
From: Adam Warner <me@adamwarner.co.uk>
Date: Fri, 22 May 2020 13:27:52 +0100
Subject: [PATCH 2/3] Add saveState/loadState callbacks

Signed-off-by: Adam Warner <me@adamwarner.co.uk>
---
 scripts/pi-hole/js/settings.js | 44 ++++++++++++++++++++++++++++++++--
 1 file changed, 42 insertions(+), 2 deletions(-)

diff --git a/scripts/pi-hole/js/settings.js b/scripts/pi-hole/js/settings.js
index 533f08d9..2900672a 100644
--- a/scripts/pi-hole/js/settings.js
+++ b/scripts/pi-hole/js/settings.js
@@ -175,7 +175,27 @@ $(document).ready(function () {
       scrollY: "200px",
       scrollX: true,
       order: [[2, "asc"]],
-      stateSave: true
+      stateSave: true,
+      stateSaveCallback: function(settings, data) {
+        // Store current state in client's local storage area
+        localStorage.setItem("activeDhcpLeaseTable", JSON.stringify(data));
+      },
+      stateLoadCallback: function() {
+        // Receive previous state from client's local storage area
+        var data = localStorage.getItem("activeDhcpLeaseTable");
+        // Return if not available
+        if (data === null) {
+          return null;
+        }
+
+        data = JSON.parse(data);
+        // Always start on the first page to show most recent queries
+        data.start = 0;
+        // Always start with empty search field
+        data.search.search = "";
+        // Apply loaded state to table
+        return data;
+      }
     });
   }
 
@@ -188,7 +208,27 @@ $(document).ready(function () {
       scrollY: "200px",
       scrollX: true,
       order: [[2, "asc"]],
-      stateSave: true
+      stateSave: true,
+      stateSaveCallback: function(settings, data) {
+        // Store current state in client's local storage area
+        localStorage.setItem("staticDhcpLeaseTable", JSON.stringify(data));
+      },
+      stateLoadCallback: function() {
+        // Receive previous state from client's local storage area
+        var data = localStorage.getItem("staticDhcpLeaseTable");
+        // Return if not available
+        if (data === null) {
+          return null;
+        }
+
+        data = JSON.parse(data);
+        // Always start on the first page to show most recent queries
+        data.start = 0;
+        // Always start with empty search field
+        data.search.search = "";
+        // Apply loaded state to table
+        return data;
+      }
     });
   }
 

From 3957e9eef1382a852e5be2ba0202c57175279f23 Mon Sep 17 00:00:00 2001
From: Adam Warner <me@adamwarner.co.uk>
Date: Fri, 22 May 2020 13:48:31 +0100
Subject: [PATCH 3/3] Move some duplicated code to utils.js

Signed-off-by: Adam Warner <me@adamwarner.co.uk>
---
 groups-domains.php                   |  2 +-
 network.php                          |  1 +
 queries.php                          |  1 +
 scripts/pi-hole/js/groups-adlists.js | 16 ++--------
 scripts/pi-hole/js/groups-clients.js | 16 ++--------
 scripts/pi-hole/js/groups-domains.js | 16 ++--------
 scripts/pi-hole/js/groups.js         | 16 ++--------
 scripts/pi-hole/js/messages.js       | 17 ++--------
 scripts/pi-hole/js/network.js        | 20 ++----------
 scripts/pi-hole/js/queries.js        | 20 ++----------
 scripts/pi-hole/js/settings.js       | 46 ++++++----------------------
 scripts/pi-hole/js/utils.js          | 25 ++++++++++++++-
 settings.php                         |  1 +
 13 files changed, 54 insertions(+), 143 deletions(-)

diff --git a/groups-domains.php b/groups-domains.php
index a6c25074..374f1601 100644
--- a/groups-domains.php
+++ b/groups-domains.php
@@ -40,7 +40,7 @@
                         <li role="presentation">
                             <a href="#tab_regex" aria-controls="tab_regex" aria-expanded="false" role="tab" data-toggle="tab">RegEx filter</a>
                         </li>
-                    </ul>        
+                    </ul>
                     <div class="tab-content">
                         <!-- Domain tab -->
                         <div id="tab_domain" class="tab-pane active fade in">
diff --git a/network.php b/network.php
index 1fc64187..3aa7342d 100644
--- a/network.php
+++ b/network.php
@@ -77,5 +77,6 @@ $token = $_SESSION['token'];
     require "scripts/pi-hole/php/footer.php";
 ?>
 
+<script src="scripts/pi-hole/js/utils.js"></script>
 <script src="scripts/pi-hole/js/ip-address-sorting.js"></script>
 <script src="scripts/pi-hole/js/network.js"></script>
diff --git a/queries.php b/queries.php
index 3b18a4ea..1ede7b45 100644
--- a/queries.php
+++ b/queries.php
@@ -156,6 +156,7 @@ if(strlen($showing) > 0)
 </div>
 <!-- /.row -->
 
+<script src="scripts/pi-hole/js/utils.js"></script>
 <script src="scripts/pi-hole/js/queries.js"></script>
 
 <?php
diff --git a/scripts/pi-hole/js/groups-adlists.js b/scripts/pi-hole/js/groups-adlists.js
index fe9f3e85..36b6794b 100644
--- a/scripts/pi-hole/js/groups-adlists.js
+++ b/scripts/pi-hole/js/groups-adlists.js
@@ -172,22 +172,10 @@ function initTable() {
     ],
     stateSave: true,
     stateSaveCallback: function (settings, data) {
-      // Store current state in client's local storage area
-      localStorage.setItem("groups-adlists-table", JSON.stringify(data));
+      utils.stateSaveCallback("groups-adlists-table", data);
     },
     stateLoadCallback: function () {
-      // Receive previous state from client's local storage area
-      var data = localStorage.getItem("groups-adlists-table");
-      // Return if not available
-      if (data === null) {
-        return null;
-      }
-
-      data = JSON.parse(data);
-      // Always start on the first page to show most recent queries
-      data.start = 0;
-      // Always start with empty search field
-      data.search.search = "";
+      var data = utils.stateLoadCallback("groups-adlists-table");
       // Reset visibility of ID column
       data.columns[0].visible = false;
       // Apply loaded state to table
diff --git a/scripts/pi-hole/js/groups-clients.js b/scripts/pi-hole/js/groups-clients.js
index 6d7ab3cd..064891d7 100644
--- a/scripts/pi-hole/js/groups-clients.js
+++ b/scripts/pi-hole/js/groups-clients.js
@@ -206,22 +206,10 @@ function initTable() {
     ],
     stateSave: true,
     stateSaveCallback: function (settings, data) {
-      // Store current state in client's local storage area
-      localStorage.setItem("groups-clients-table", JSON.stringify(data));
+      utils.stateSaveCallback("groups-clients-table", data);
     },
     stateLoadCallback: function () {
-      // Receive previous state from client's local storage area
-      var data = localStorage.getItem("groups-clients-table");
-      // Return if not available
-      if (data === null) {
-        return null;
-      }
-
-      data = JSON.parse(data);
-      // Always start on the first page to show most recent queries
-      data.start = 0;
-      // Always start with empty search field
-      data.search.search = "";
+      var data = utils.stateLoadCallback("groups-clients-table");
       // Reset visibility of ID column
       data.columns[0].visible = false;
       // Apply loaded state to table
diff --git a/scripts/pi-hole/js/groups-domains.js b/scripts/pi-hole/js/groups-domains.js
index 56648de7..2f28f20e 100644
--- a/scripts/pi-hole/js/groups-domains.js
+++ b/scripts/pi-hole/js/groups-domains.js
@@ -247,22 +247,10 @@ function initTable() {
     ],
     stateSave: true,
     stateSaveCallback: function (settings, data) {
-      // Store current state in client's local storage area
-      localStorage.setItem("groups-domains-table", JSON.stringify(data));
+      utils.stateSaveCallback("groups-domains-table", data);
     },
     stateLoadCallback: function () {
-      // Receive previous state from client's local storage area
-      var data = localStorage.getItem("groups-domains-table");
-      // Return if not available
-      if (data === null) {
-        return null;
-      }
-
-      data = JSON.parse(data);
-      // Always start on the first page to show most recent queries
-      data.start = 0;
-      // Always start with empty search field
-      data.search.search = "";
+      var data = utils.stateLoadCallback("groups-domains-table");
       // Reset visibility of ID column
       data.columns[0].visible = false;
       // Show group assignment column only on full page
diff --git a/scripts/pi-hole/js/groups.js b/scripts/pi-hole/js/groups.js
index e8e182ed..c7303ddf 100644
--- a/scripts/pi-hole/js/groups.js
+++ b/scripts/pi-hole/js/groups.js
@@ -87,22 +87,10 @@ $(document).ready(function () {
     ],
     stateSave: true,
     stateSaveCallback: function (settings, data) {
-      // Store current state in client's local storage area
-      localStorage.setItem("groups-table", JSON.stringify(data));
+      utils.stateSaveCallback("groups-table", data);
     },
     stateLoadCallback: function () {
-      // Receive previous state from client's local storage area
-      var data = localStorage.getItem("groups-table");
-      // Return if not available
-      if (data === null) {
-        return null;
-      }
-
-      data = JSON.parse(data);
-      // Always start on the first page to show most recent queries
-      data.start = 0;
-      // Always start with empty search field
-      data.search.search = "";
+      var data = utils.stateLoadCallback("groups-table");
       // Reset visibility of ID column
       data.columns[0].visible = false;
       // Apply loaded state to table
diff --git a/scripts/pi-hole/js/messages.js b/scripts/pi-hole/js/messages.js
index 1651eac4..e1bc20b3 100644
--- a/scripts/pi-hole/js/messages.js
+++ b/scripts/pi-hole/js/messages.js
@@ -95,23 +95,10 @@ $(document).ready(function () {
     },
     stateSave: true,
     stateSaveCallback: function (settings, data) {
-      // Store current state in client's local storage area
-      localStorage.setItem("messages-table", JSON.stringify(data));
+      utils.stateSaveCallback("messages-table", data);
     },
     stateLoadCallback: function () {
-      // Receive previous state from client's local storage area
-      var data = localStorage.getItem("messages-table");
-      // Return if not available
-      if (data === null) {
-        return null;
-      }
-
-      // Parse loaded data
-      data = JSON.parse(data);
-      // Always start on the first page to show most recent queries
-      data.start = 0;
-      // Always start with empty search field
-      data.search.search = "";
+      var data = utils.stateLoadCallback("messages-table");
       // Reset visibility of ID and blob columns
       var hiddenCols = [0, 4, 5, 6, 7, 8];
       for (var key in hiddenCols) {
diff --git a/scripts/pi-hole/js/network.js b/scripts/pi-hole/js/network.js
index 51a0282a..b85def90 100644
--- a/scripts/pi-hole/js/network.js
+++ b/scripts/pi-hole/js/network.js
@@ -5,7 +5,7 @@
  *  This file is copyright under the latest version of the EUPL.
  *  Please see LICENSE file for your rights under this license.  */
 
-/* global moment:false */
+/* global moment:false, utils:false */
 
 var tableApi;
 
@@ -186,24 +186,10 @@ $(document).ready(function () {
     ],
     stateSave: true,
     stateSaveCallback: function (settings, data) {
-      // Store current state in client's local storage area
-      localStorage.setItem("network_table", JSON.stringify(data));
+      utils.stateSaveCallback("network_table", data);
     },
     stateLoadCallback: function () {
-      // Receive previous state from client's local storage area
-      var data = localStorage.getItem("network_table");
-      // Return if not available
-      if (data === null) {
-        return null;
-      }
-
-      data = JSON.parse(data);
-      // Always start on the first page
-      data.start = 0;
-      // Always start with empty search field
-      data.search.search = "";
-      // Apply loaded state to table
-      return data;
+      return utils.stateLoadCallback("network_table");
     },
     columnDefs: [
       {
diff --git a/scripts/pi-hole/js/queries.js b/scripts/pi-hole/js/queries.js
index b4551f22..dde2ac8a 100644
--- a/scripts/pi-hole/js/queries.js
+++ b/scripts/pi-hole/js/queries.js
@@ -5,7 +5,7 @@
  *  This file is copyright under the latest version of the EUPL.
  *  Please see LICENSE file for your rights under this license.  */
 
-/* global moment:false */
+/* global moment:false, utils:false */
 
 var tableApi;
 
@@ -399,24 +399,10 @@ $(document).ready(function () {
     ],
     stateSave: true,
     stateSaveCallback: function (settings, data) {
-      // Store current state in client's local storage area
-      localStorage.setItem("query_log_table", JSON.stringify(data));
+      utils.stateSaveCallback("query_log_table", data);
     },
     stateLoadCallback: function () {
-      // Receive previous state from client's local storage area
-      var data = localStorage.getItem("query_log_table");
-      // Return if not available
-      if (data === null) {
-        return null;
-      }
-
-      data = JSON.parse(data);
-      // Always start on the first page to show most recent queries
-      data.start = 0;
-      // Always start with empty search field
-      data.search.search = "";
-      // Apply loaded state to table
-      return data;
+      return utils.stateLoadCallback("query_log_table");
     },
     columnDefs: [
       {
diff --git a/scripts/pi-hole/js/settings.js b/scripts/pi-hole/js/settings.js
index 2900672a..d6c7c0bc 100644
--- a/scripts/pi-hole/js/settings.js
+++ b/scripts/pi-hole/js/settings.js
@@ -5,6 +5,8 @@
  *  This file is copyright under the latest version of the EUPL.
  *  Please see LICENSE file for your rights under this license. */
 
+/* global utils:false */
+
 $(function () {
   $("[data-static]").on("click", function () {
     var row = $(this).closest("tr");
@@ -176,25 +178,11 @@ $(document).ready(function () {
       scrollX: true,
       order: [[2, "asc"]],
       stateSave: true,
-      stateSaveCallback: function(settings, data) {
-        // Store current state in client's local storage area
-        localStorage.setItem("activeDhcpLeaseTable", JSON.stringify(data));
+      stateSaveCallback: function (settings, data) {
+        utils.stateSaveCallback("activeDhcpLeaseTable", data);
       },
-      stateLoadCallback: function() {
-        // Receive previous state from client's local storage area
-        var data = localStorage.getItem("activeDhcpLeaseTable");
-        // Return if not available
-        if (data === null) {
-          return null;
-        }
-
-        data = JSON.parse(data);
-        // Always start on the first page to show most recent queries
-        data.start = 0;
-        // Always start with empty search field
-        data.search.search = "";
-        // Apply loaded state to table
-        return data;
+      stateLoadCallback: function () {
+        return utils.stateLoadCallback("activeDhcpLeaseTable");
       }
     });
   }
@@ -209,25 +197,11 @@ $(document).ready(function () {
       scrollX: true,
       order: [[2, "asc"]],
       stateSave: true,
-      stateSaveCallback: function(settings, data) {
-        // Store current state in client's local storage area
-        localStorage.setItem("staticDhcpLeaseTable", JSON.stringify(data));
+      stateSaveCallback: function (settings, data) {
+        utils.stateSaveCallback("staticDhcpLeaseTable", data);
       },
-      stateLoadCallback: function() {
-        // Receive previous state from client's local storage area
-        var data = localStorage.getItem("staticDhcpLeaseTable");
-        // Return if not available
-        if (data === null) {
-          return null;
-        }
-
-        data = JSON.parse(data);
-        // Always start on the first page to show most recent queries
-        data.start = 0;
-        // Always start with empty search field
-        data.search.search = "";
-        // Apply loaded state to table
-        return data;
+      stateLoadCallback: function () {
+        return utils.stateLoadCallback("staticDhcpLeaseTable");
       }
     });
   }
diff --git a/scripts/pi-hole/js/utils.js b/scripts/pi-hole/js/utils.js
index 63aff681..5d09cee5 100644
--- a/scripts/pi-hole/js/utils.js
+++ b/scripts/pi-hole/js/utils.js
@@ -149,6 +149,27 @@ function setBsSelectDefaults() {
   };
 }
 
+function stateSaveCallback(itemName, data) {
+  localStorage.setItem(itemName, JSON.stringify(data));
+}
+
+function stateLoadCallback(itemName) {
+  // Receive previous state from client's local storage area
+  var data = localStorage.getItem(itemName);
+  // Return if not available
+  if (data === null) {
+    return null;
+  }
+
+  data = JSON.parse(data);
+  // Always start on the first page to show most recent queries
+  data.start = 0;
+  // Always start with empty search field
+  data.search.search = "";
+  // Apply loaded state to table
+  return data;
+}
+
 window.utils = (function () {
   return {
     showAlert: showAlert,
@@ -157,6 +178,8 @@ window.utils = (function () {
     enableAll: enableAll,
     validateIPv4CIDR: validateIPv4CIDR,
     validateIPv6CIDR: validateIPv6CIDR,
-    setBsSelectDefaults: setBsSelectDefaults
+    setBsSelectDefaults: setBsSelectDefaults,
+    stateSaveCallback: stateSaveCallback,
+    stateLoadCallback: stateLoadCallback
   };
 })();
diff --git a/settings.php b/settings.php
index 47d418b0..1c237ff4 100644
--- a/settings.php
+++ b/settings.php
@@ -1256,6 +1256,7 @@ if (isset($_GET['tab']) && in_array($_GET['tab'], array("sysadmin", "adlists", "
 </div>
 
 <script src="scripts/vendor/jquery.confirm.min.js"></script>
+<script src="scripts/pi-hole/js/utils.js"></script>
 <script src="scripts/pi-hole/js/settings.js"></script>
 
 <?php