Port Pi-hole diagnosis system ("messages") to the new v6.0 API

Signed-off-by: DL6ER <dl6er@dl6er.de>

scripts/pi-hole/js/messages.js

@@ -19,141 +19,19 @@ function renderTimestamp(data, type) {
   return data;
 }
 
-function multiline(input) {
-  return input.split(",").join("\n");
-}
-
-function renderMessage(data, type, row) {
-  // Display and search content
-  switch (row.type) {
-    case "REGEX":
-      return (
-        'Encountered an error when processing <a href="groups-domains.php?domainid=' +
-        row.blob3 +
-        '">' +
-        row.blob1 +
-        " regex filter with ID " +
-        row.blob3 +
-        "</a>:<pre>" +
-        row.blob2 +
-        "</pre>Error message: <pre>" +
-        row.message +
-        "</pre>"
-      );
-
-    case "SUBNET":
-      return (
-        "Client <code>" +
-        row.message +
-        "</code> is managed by " +
-        row.blob1 +
-        " groups (database IDs [" +
-        row.blob3 +
-        "]):<pre>" +
-        multiline(row.blob2) +
-        "</pre>" +
-        "FTL chose the most recent entry <pre>" +
-        row.blob4 +
-        "</pre> to get the group configuration for this client."
-      );
-
-    case "HOSTNAME":
-      // eslint-disable-next-line unicorn/no-new-array
-      var hint = new Array(row.blob2 + row.message.length + 3).join(" ");
-      return (
-        "Hostname contains invalid character <code>" +
-        decodeURIComponent(escape(row.blob1))[row.blob2] +
-        "</code>:<pre>" +
-        hint +
-        "&darr;\n" +
-        row.message +
-        ": " +
-        decodeURIComponent(escape(row.blob1)) +
-        "\n" +
-        hint +
-        "&uarr;</pre>"
-      );
-
-    case "DNSMASQ_CONFIG":
-      return "FTL failed to start due to " + row.message;
-
-    case "RATE_LIMIT":
-      return (
-        "Client " +
-        row.message +
-        " has been rate-limited (current config allows up to " +
-        parseInt(row.blob1, 10) +
-        " queries in " +
-        parseInt(row.blob2, 10) +
-        " seconds)"
-      );
-
-    case "DNSMASQ_WARN":
-      return (
-        "Warning in <code>dnsmasq</code> core:<pre>" +
-        row.message +
-        '</pre> Check out <a href="https://docs.pi-hole.net/ftldns/dnsmasq_warn/" target="_blank">our documentation</a> for further information.'
-      );
-
-    case "LOAD":
-      return (
-        "Long-term load (15min avg) larger than number of processors: <strong>" +
-        parseFloat(row.blob1).toFixed(1) +
-        " &gt; " +
-        parseInt(row.blob2, 10) +
-        "</strong><br>This may slow down DNS resolution and can cause bottlenecks."
-      );
-
-    case "SHMEM":
-      return (
-        "RAM shortage (<code>" +
-        utils.escapeHtml(row.message) +
-        "</code>) ahead: <strong>" +
-        parseInt(row.blob1, 10) +
-        "% used</strong><pre>" +
-        utils.escapeHtml(row.blob2) +
-        "</pre>"
-      );
-
-    case "DISK":
-      return (
-        "Disk shortage (<code>" +
-        utils.escapeHtml(row.message) +
-        "</code>) ahead: <strong>" +
-        parseInt(row.blob1, 10) +
-        "% used</strong><pre>" +
-        utils.escapeHtml(row.blob2) +
-        "</pre>"
-      );
-
-    case "ADLIST":
-      return (
-        '<a href="groups-adlists.php?adlistid=' +
-        parseInt(row.blob1, 10) +
-        '">' +
-        "Adlist with ID " +
-        parseInt(row.blob1, 10) +
-        "</a> was inaccessible during last gravity run." +
-        "<pre>" +
-        utils.escapeHtml(row.message) +
-        "</pre>"
-      );
-
-    default:
-      return "Unknown message type<pre>" + JSON.stringify(row) + "</pre>";
-  }
+function htmlPass(data, type) {
+  return data;
 }
 
 $(function () {
-  return;
   var ignoreNonfatal = localStorage
     ? localStorage.getItem("hideNonfatalDnsmasqWarnings_chkbox") === "true"
     : false;
+  var url = "/api/info/messages" + (ignoreNonfatal ? "?filter_dnsmasq_warnings=true" : "");
   table = $("#messagesTable").DataTable({
     ajax: {
-      url: "api_db.php?messages" + (ignoreNonfatal ? "&ignore=DNSMASQ_WARN" : ""),
-      data: { token: token },
-      type: "POST",
+      url: url,
+      type: "GET",
       dataSrc: "messages",
     },
     order: [[0, "asc"]],
@@ -162,12 +40,7 @@ $(function () {
       { data: null, visible: true, width: "15px" },
       { data: "timestamp", width: "8%", render: renderTimestamp },
       { data: "type", width: "8%" },
-      { data: "message", orderable: false, render: renderMessage },
-      { data: "blob1", visible: false },
-      { data: "blob2", visible: false },
-      { data: "blob3", visible: false },
-      { data: "blob4", visible: false },
-      { data: "blob5", visible: false },
+      { data: "html", orderable: false, render: htmlPass },
       { data: null, width: "22px", orderable: false },
     ],
     columnDefs: [
@@ -275,13 +148,8 @@ $(function () {
         return null;
       }
 
-      // Reset visibility of ID and blob columns
-      var hiddenCols = [0, 5, 6, 7, 8, 9];
-      for (var key in hiddenCols) {
-        if (Object.prototype.hasOwnProperty.call(hiddenCols, key)) {
-          data.columns[hiddenCols[key]].visible = false;
-        }
-      }
+      // Reset visibility of ID column
+      data.columns[0].visible = false;
 
       // Apply loaded state to table
       return data;
@@ -325,42 +193,37 @@ $.fn.dataTable.Buttons.defaults.dom.container.className = "dt-buttons";
 function deleteMessage() {
   // Passes the button data-del-id attribute as ID
   var ids = [parseInt($(this).attr("data-del-id"), 10)];
-  delMsg(ids);
-}
 
-function delMsg(ids) {
   // Check input validity
   if (!Array.isArray(ids)) return;
 
   // Exploit prevention: Return early for non-numeric IDs
   for (var id in ids) {
     if (Object.hasOwnProperty.call(ids, id) && typeof ids[id] !== "number") return;
+    delMsg(ids);
   }
+}
+
+function delMsg(id) {
 
   utils.disableAll();
-  var idstring = ids.join(", ");
-  utils.showAlert("info", "", "Deleting message(s)...");
+  utils.showAlert("info", "", "Deleting message...");
 
   $.ajax({
-    url: "scripts/pi-hole/php/message.php",
-    method: "post",
-    dataType: "json",
-    data: { action: "delete_message", id: JSON.stringify(ids), token: token },
+    url: "/api/info/messages/" + id,
+    method: "DELETE"
   })
     .done(function (response) {
       utils.enableAll();
-      if (response.success) {
-        utils.showAlert("success", "far fa-trash-alt", "Successfully deleted message(s)", "");
-        for (var id in ids) {
-          if (Object.hasOwnProperty.call(ids, id)) {
-            table.row(id).remove().draw(false).ajax.reload(null, false);
-          }
-        }
+      console.log(response);
+      if (response === undefined) {
+        utils.showAlert("success", "far fa-trash-alt", "Successfully deleted message", "");
+        table.row(id).remove().draw(false).ajax.reload(null, false);
       } else {
         utils.showAlert(
           "error",
           "",
-          "Error while deleting message(s): " + idstring,
+          "Error while deleting message: " + id,
           response.message
         );
       }
@@ -377,7 +240,7 @@ function delMsg(ids) {
       utils.showAlert(
         "error",
         "",
-        "Error while deleting message(s): " + idstring,
+        "Error while deleting message: " + id,
         jqXHR.responseText
       );
       console.log(exception); // eslint-disable-line no-console