From 3c3e22bd980e531bac6ce350522c4d18b56ad4d3 Mon Sep 17 00:00:00 2001
From: DL6ER <dl6er@dl6er.de>
Date: Mon, 27 Jan 2020 10:48:09 +0000
Subject: [PATCH] Add support for client comment and timestamp fields.

Signed-off-by: DL6ER <dl6er@dl6er.de>
---
 groups-clients.php                   |  8 +++---
 scripts/pi-hole/js/groups-clients.js | 40 +++++++++++++++++++++++-----
 scripts/pi-hole/php/groups.php       | 33 ++++++++++++++++++++++-
 3 files changed, 70 insertions(+), 11 deletions(-)

diff --git a/groups-clients.php b/groups-clients.php
index 53aa7e3f..259ccd01 100644
--- a/groups-clients.php
+++ b/groups-clients.php
@@ -30,11 +30,12 @@
                         <label for="ex1">Known clients:</label>
                         <select id="select" class="form-control" placeholder="">
                             <option disabled selected>Loading...</option>
-                        </select>
+                        </select><br>
+                        <input id="ip-custom" type="text" class="form-control" disabled placeholder="Client IP address (IPv4 or IPv6, optional)">
                     </div>
                     <div class="col-md-6">
-                        <label for="ex2">Custom client:</label>
-                        <input id="ip-custom" type="text" class="form-control" disabled placeholder="Client IP address (IPv4 or IPv6, optional)">
+                        <label for="ex3">Comment:</label>
+                        <input id="new_comment" type="text" class="form-control" placeholder="Client description (optional)">
                     </div>
                 </div>
             </div>
@@ -59,6 +60,7 @@
                     <tr>
                         <th>ID</th>
                         <th>IP address</th>
+                        <th>Comment</th>
                         <th>Group assignment</th>
                         <th>Action</th>
                     </tr>
diff --git a/scripts/pi-hole/js/groups-clients.js b/scripts/pi-hole/js/groups-clients.js
index 71e0e585..f3440456 100644
--- a/scripts/pi-hole/js/groups-clients.js
+++ b/scripts/pi-hole/js/groups-clients.js
@@ -38,7 +38,7 @@ function reload_client_suggestions() {
       sel.append(
         $("<option />")
           .val("custom")
-          .text("Custom, specified on the right")
+          .text("Custom, specified below...")
       );
     },
     "json"
@@ -80,6 +80,7 @@ function initTable() {
     columns: [
       { data: "id", visible: false },
       { data: "ip" },
+      { data: "comment" },
       { data: "groups", searchable: false },
       { data: "name", width: "80px", orderable: false }
     ],
@@ -87,7 +88,13 @@ function initTable() {
       $(".deleteClient").on("click", deleteClient);
     },
     rowCallback: function(row, data) {
-      var tooltip = "Database ID: " + data.id;
+      var tooltip =
+        "Added: " +
+        utils.datetime(data.date_added) +
+        "\nLast modified: " +
+        utils.datetime(data.date_modified) +
+        "\nDatabase ID: " +
+        data.id;
       var ip_name =
         '<code id="ip" title="' +
         tooltip +
@@ -100,8 +107,16 @@ function initTable() {
         ip_name += '<br><code id="name" title="' + tooltip + '">' + data.name + "</code>";
       $("td:eq(0)", row).html(ip_name);
 
-      $("td:eq(1)", row).empty();
-      $("td:eq(1)", row).append('<select id="multiselect" multiple="multiple"></select>');
+      $("td:eq(1)", row).html(
+        '<input id="comment" class="form-control"><input id="id" type="hidden" value="' +
+          data.id +
+          '">'
+      );
+      $("#comment", row).val(data.comment);
+      $("#comment", row).on("change", editClient);
+
+      $("td:eq(2)", row).empty();
+      $("td:eq(2)", row).append('<select id="multiselect" multiple="multiple"></select>');
       var sel = $("#multiselect", row);
       // Add all known groups
       for (var i = 0; i < groups.length; i++) {
@@ -129,7 +144,7 @@ function initTable() {
         '">' +
         '<span class="glyphicon glyphicon-trash"></span>' +
         "</button>";
-      $("td:eq(2)", row).html(button);
+      $("td:eq(3)", row).html(button);
     },
     dom:
       "<'row'<'col-sm-4'l><'col-sm-8'f>>" +
@@ -180,6 +195,7 @@ function initTable() {
 
 function addClient() {
   var ip = $("#select").val();
+  var comment = $("#new_comment").val();
   if (ip === "custom") {
     ip = $("#ip-custom").val();
   }
@@ -197,7 +213,7 @@ function addClient() {
     url: "scripts/pi-hole/php/groups.php",
     method: "post",
     dataType: "json",
-    data: { action: "add_client", ip: ip, token: token },
+    data: { action: "add_client", ip: ip, comment: comment, token: token },
     success: function(response) {
       utils.enableAll();
       if (response.success) {
@@ -223,12 +239,16 @@ function editClient() {
   var groups = tr.find("#multiselect").val();
   var ip = tr.find("#ip").text();
   var name = tr.find("#name").text();
+  var comment = tr.find("#comment").val();
 
   var done = "edited";
   var not_done = "editing";
   if (elem === "multiselect") {
     done = "edited groups of";
     not_done = "editing groups of";
+  } else if (elem === "comment") {
+    done = "edited comment of";
+    not_done = "editing comment of";
   }
 
   var ip_name = ip;
@@ -242,7 +262,13 @@ function editClient() {
     url: "scripts/pi-hole/php/groups.php",
     method: "post",
     dataType: "json",
-    data: { action: "edit_client", id: id, groups: groups, token: token },
+    data: {
+      action: "edit_client",
+      id: id,
+      groups: groups,
+      token: token,
+      comment: comment
+    },
     success: function(response) {
       utils.enableAll();
       if (response.success) {
diff --git a/scripts/pi-hole/php/groups.php b/scripts/pi-hole/php/groups.php
index aa6e3f83..ab24ae3d 100644
--- a/scripts/pi-hole/php/groups.php
+++ b/scripts/pi-hole/php/groups.php
@@ -232,7 +232,7 @@ if ($_POST['action'] == 'get_groups') {
 } elseif ($_POST['action'] == 'add_client') {
     // Add new client
     try {
-        $stmt = $db->prepare('INSERT INTO client (ip) VALUES (:ip)');
+        $stmt = $db->prepare('INSERT INTO client (ip,comment) VALUES (:ip,:comment)');
         if (!$stmt) {
             throw new Exception('While preparing statement: ' . $db->lastErrorMsg());
         }
@@ -241,6 +241,15 @@ if ($_POST['action'] == 'get_groups') {
             throw new Exception('While binding ip: ' . $db->lastErrorMsg());
         }
 
+        $comment = $_POST['comment'];
+        if (strlen($comment) == 0) {
+                // Store NULL in database for empty comments
+                $comment = null;
+        }
+        if (!$stmt->bindValue(':comment', $comment, SQLITE3_TEXT)) {
+            throw new Exception('While binding comment: ' . $db->lastErrorMsg());
+        }
+
         if (!$stmt->execute()) {
             throw new Exception('While executing: ' . $db->lastErrorMsg());
         }
@@ -253,6 +262,28 @@ if ($_POST['action'] == 'get_groups') {
 } elseif ($_POST['action'] == 'edit_client') {
     // Edit client identified by ID
     try {
+        $stmt = $db->prepare('UPDATE client SET comment=:comment WHERE id = :id');
+        if (!$stmt) {
+            throw new Exception('While preparing statement: ' . $db->lastErrorMsg());
+        }
+
+        $comment = $_POST['comment'];
+        if (strlen($comment) == 0) {
+                // Store NULL in database for empty comments
+                $comment = null;
+        }
+        if (!$stmt->bindValue(':comment', $comment, SQLITE3_TEXT)) {
+            throw new Exception('While binding comment: ' . $db->lastErrorMsg());
+        }
+
+        if (!$stmt->bindValue(':id', intval($_POST['id']), SQLITE3_INTEGER)) {
+            throw new Exception('While binding id: ' . $db->lastErrorMsg());
+        }
+
+        if (!$stmt->execute()) {
+            throw new Exception('While executing: ' . $db->lastErrorMsg());
+        }
+
         $stmt = $db->prepare('DELETE FROM client_by_group WHERE client_id = :id');
         if (!$stmt) {
             throw new Exception('While preparing DELETE statement: ' . $db->lastErrorMsg());