mirror of
https://github.com/pi-hole/web.git
synced 2026-04-23 10:19:47 +01:00
535 lines
15 KiB
JavaScript
535 lines
15 KiB
JavaScript
/* Pi-hole: A black hole for Internet advertisements
|
|
* (c) 2017 Pi-hole, LLC (https://pi-hole.net)
|
|
* Network-wide ad blocking via your own hardware.
|
|
*
|
|
* This file is copyright under the latest version of the EUPL.
|
|
* Please see LICENSE file for your rights under this license. */
|
|
|
|
/* global utils:false */
|
|
|
|
var table;
|
|
var groups = [];
|
|
var token = $("#token").text();
|
|
|
|
function reloadClientSuggestions() {
|
|
$.post(
|
|
"scripts/pi-hole/php/groups.php",
|
|
{ action: "get_unconfigured_clients", token: token },
|
|
function (data) {
|
|
var sel = $("#select");
|
|
sel.empty();
|
|
|
|
// In order for the placeholder value to appear, we have to have a blank
|
|
// <option> as the first option in our <select> control. This is because
|
|
// the browser tries to select the first option by default. If our first
|
|
// option were non-empty, the browser would display this instead of the
|
|
// placeholder.
|
|
sel.append($("<option />"));
|
|
|
|
// Add data obtained from API
|
|
for (var key in data) {
|
|
if (!Object.prototype.hasOwnProperty.call(data, key)) {
|
|
continue;
|
|
}
|
|
|
|
var text = key;
|
|
var keyPlain = key;
|
|
if (key.startsWith("IP-")) {
|
|
// Mock MAC address for address-only devices
|
|
keyPlain = key.substring(3);
|
|
text = keyPlain;
|
|
}
|
|
|
|
// Append host name if available
|
|
if (data[key].length > 0) {
|
|
text += " (" + data[key] + ")";
|
|
}
|
|
|
|
sel.append($("<option />").val(keyPlain).text(text));
|
|
}
|
|
},
|
|
"json"
|
|
);
|
|
}
|
|
|
|
function getGroups() {
|
|
$.post(
|
|
"scripts/pi-hole/php/groups.php",
|
|
{ action: "get_groups", token: token },
|
|
function (data) {
|
|
groups = data.data;
|
|
initTable();
|
|
},
|
|
"json"
|
|
);
|
|
}
|
|
|
|
$(function () {
|
|
$("#btnAdd").on("click", addClient);
|
|
$("select").select2({
|
|
tags: true,
|
|
placeholder: "Select client...",
|
|
allowClear: true,
|
|
});
|
|
|
|
reloadClientSuggestions();
|
|
utils.setBsSelectDefaults();
|
|
getGroups();
|
|
|
|
$("#select").on("change", function () {
|
|
$("#ip-custom").val("");
|
|
$("#ip-custom").prop("disabled", $("#select option:selected").val() !== "custom");
|
|
});
|
|
});
|
|
|
|
function initTable() {
|
|
table = $("#clientsTable").DataTable({
|
|
ajax: {
|
|
url: "scripts/pi-hole/php/groups.php",
|
|
data: { action: "get_clients", token: token },
|
|
type: "POST",
|
|
},
|
|
order: [[0, "asc"]],
|
|
columns: [
|
|
{ data: "id", visible: false },
|
|
{ data: null, visible: true, orderable: false, width: "15px" },
|
|
{ data: "ip", type: "ip-address" },
|
|
{ data: "comment" },
|
|
{ data: "groups", searchable: false },
|
|
{ data: "name", width: "22px", orderable: false },
|
|
],
|
|
columnDefs: [
|
|
{
|
|
targets: 1,
|
|
className: "select-checkbox",
|
|
render: function () {
|
|
return "";
|
|
},
|
|
},
|
|
{
|
|
targets: "_all",
|
|
render: $.fn.dataTable.render.text(),
|
|
},
|
|
],
|
|
drawCallback: function () {
|
|
// Hide buttons if all clients were deleted
|
|
var hasRows = this.api().rows({ filter: "applied" }).data().length > 0;
|
|
$(".datatable-bt").css("visibility", hasRows ? "visible" : "hidden");
|
|
|
|
$('button[id^="deleteClient_"]').on("click", deleteClient);
|
|
// Remove visible dropdown to prevent orphaning
|
|
$("body > .bootstrap-select.dropdown").remove();
|
|
},
|
|
rowCallback: function (row, data) {
|
|
$(row).attr("data-id", data.id);
|
|
var tooltip =
|
|
"Added: " +
|
|
utils.datetime(data.date_added, false) +
|
|
"\nLast modified: " +
|
|
utils.datetime(data.date_modified, false) +
|
|
"\nDatabase ID: " +
|
|
data.id;
|
|
var ipName =
|
|
'<code id="ip_' +
|
|
data.id +
|
|
'" title="' +
|
|
tooltip +
|
|
'" class="breakall">' +
|
|
data.ip +
|
|
"</code>";
|
|
if (data.name !== null && data.name.length > 0)
|
|
ipName +=
|
|
'<br><code id="name_' +
|
|
data.id +
|
|
'" title="' +
|
|
tooltip +
|
|
'" class="breakall">' +
|
|
data.name +
|
|
"</code>";
|
|
$("td:eq(1)", row).html(ipName);
|
|
|
|
$("td:eq(2)", row).html('<input id="comment_' + data.id + '" class="form-control">');
|
|
var commentEl = $("#comment_" + data.id, row);
|
|
commentEl.val(utils.unescapeHtml(data.comment));
|
|
commentEl.on("change", editClient);
|
|
|
|
$("td:eq(3)", row).empty();
|
|
$("td:eq(3)", row).append(
|
|
'<select class="selectpicker" id="multiselect_' + data.id + '" multiple></select>'
|
|
);
|
|
var selectEl = $("#multiselect_" + data.id, row);
|
|
// Add all known groups
|
|
for (var i = 0; i < groups.length; i++) {
|
|
var dataSub = "";
|
|
if (!groups[i].enabled) {
|
|
dataSub = 'data-subtext="(disabled)"';
|
|
}
|
|
|
|
selectEl.append(
|
|
$("<option " + dataSub + "/>")
|
|
.val(groups[i].id)
|
|
.text(groups[i].name)
|
|
);
|
|
}
|
|
|
|
// Select assigned groups
|
|
selectEl.val(data.groups);
|
|
// Initialize bootstrap-select
|
|
selectEl
|
|
// fix dropdown if it would stick out right of the viewport
|
|
.on("show.bs.select", function () {
|
|
var winWidth = $(window).width();
|
|
var dropdownEl = $("body > .bootstrap-select.dropdown");
|
|
if (dropdownEl.length > 0) {
|
|
dropdownEl.removeClass("align-right");
|
|
var width = dropdownEl.width();
|
|
var left = dropdownEl.offset().left;
|
|
if (left + width > winWidth) {
|
|
dropdownEl.addClass("align-right");
|
|
}
|
|
}
|
|
})
|
|
.on("changed.bs.select", function () {
|
|
// enable Apply button
|
|
if ($(applyBtn).prop("disabled")) {
|
|
$(applyBtn)
|
|
.addClass("btn-success")
|
|
.prop("disabled", false)
|
|
.on("click", function () {
|
|
editClient.call(selectEl);
|
|
});
|
|
}
|
|
})
|
|
.on("hide.bs.select", function () {
|
|
// Restore values if drop-down menu is closed without clicking the Apply button
|
|
if (!$(applyBtn).prop("disabled")) {
|
|
$(this).val(data.groups).selectpicker("refresh");
|
|
$(applyBtn).removeClass("btn-success").prop("disabled", true).off("click");
|
|
}
|
|
})
|
|
.selectpicker()
|
|
.siblings(".dropdown-menu")
|
|
.find(".bs-actionsbox")
|
|
.prepend(
|
|
'<button type="button" id=btn_apply_' +
|
|
data.id +
|
|
' class="btn btn-block btn-sm" disabled>Apply</button>'
|
|
);
|
|
|
|
var applyBtn = "#btn_apply_" + data.id;
|
|
|
|
var button =
|
|
'<button type="button" class="btn btn-danger btn-xs" id="deleteClient_' +
|
|
data.id +
|
|
'" data-del-id="' +
|
|
data.id +
|
|
'">' +
|
|
'<span class="far fa-trash-alt"></span>' +
|
|
"</button>";
|
|
$("td:eq(4)", row).html(button);
|
|
},
|
|
select: {
|
|
style: "multi",
|
|
selector: "td:not(:last-child)",
|
|
info: false,
|
|
},
|
|
buttons: [
|
|
{
|
|
text: '<span class="far fa-square"></span>',
|
|
titleAttr: "Select All",
|
|
className: "btn-sm datatable-bt selectAll",
|
|
action: function () {
|
|
table.rows({ page: "current" }).select();
|
|
},
|
|
},
|
|
{
|
|
text: '<span class="far fa-plus-square"></span>',
|
|
titleAttr: "Select All",
|
|
className: "btn-sm datatable-bt selectMore",
|
|
action: function () {
|
|
table.rows({ page: "current" }).select();
|
|
},
|
|
},
|
|
{
|
|
extend: "selectNone",
|
|
text: '<span class="far fa-check-square"></span>',
|
|
titleAttr: "Deselect All",
|
|
className: "btn-sm datatable-bt removeAll",
|
|
},
|
|
{
|
|
text: '<span class="far fa-trash-alt"></span>',
|
|
titleAttr: "Delete Selected",
|
|
className: "btn-sm datatable-bt deleteSelected",
|
|
action: function () {
|
|
// For each ".selected" row ...
|
|
var ids = [];
|
|
$("tr.selected").each(function () {
|
|
// ... add the row identified by "data-id".
|
|
ids.push(parseInt($(this).attr("data-id"), 10));
|
|
});
|
|
// Delete all selected rows at once
|
|
delItems(ids);
|
|
},
|
|
},
|
|
],
|
|
dom:
|
|
"<'row'<'col-sm-6'l><'col-sm-6'f>>" +
|
|
"<'row'<'col-sm-3'B><'col-sm-9'p>>" +
|
|
"<'row'<'col-sm-12'<'table-responsive'tr>>>" +
|
|
"<'row'<'col-sm-3'B><'col-sm-9'p>>" +
|
|
"<'row'<'col-sm-12'i>>",
|
|
lengthMenu: [
|
|
[10, 25, 50, 100, -1],
|
|
[10, 25, 50, 100, "All"],
|
|
],
|
|
stateSave: true,
|
|
stateDuration: 0,
|
|
stateSaveCallback: function (settings, data) {
|
|
utils.stateSaveCallback("groups-clients-table", data);
|
|
},
|
|
stateLoadCallback: function () {
|
|
var data = utils.stateLoadCallback("groups-clients-table");
|
|
|
|
// Return if not available
|
|
if (data === null) {
|
|
return null;
|
|
}
|
|
|
|
// Reset visibility of ID column
|
|
data.columns[0].visible = false;
|
|
// Apply loaded state to table
|
|
return data;
|
|
},
|
|
});
|
|
|
|
// Disable autocorrect in the search box
|
|
var input = document.querySelector("input[type=search]");
|
|
if (input !== null) {
|
|
input.setAttribute("autocomplete", "off");
|
|
input.setAttribute("autocorrect", "off");
|
|
input.setAttribute("autocapitalize", "off");
|
|
input.setAttribute("spellcheck", false);
|
|
}
|
|
|
|
table.on("init select deselect", function () {
|
|
utils.changeBulkDeleteStates(table);
|
|
});
|
|
|
|
table.on("order.dt", function () {
|
|
var order = table.order();
|
|
if (order[0][0] !== 0 || order[0][1] !== "asc") {
|
|
$("#resetButton").removeClass("hidden");
|
|
} else {
|
|
$("#resetButton").addClass("hidden");
|
|
}
|
|
});
|
|
|
|
$("#resetButton").on("click", function () {
|
|
table.order([[0, "asc"]]).draw();
|
|
$("#resetButton").addClass("hidden");
|
|
});
|
|
}
|
|
|
|
// Remove 'bnt-group' class from container, to avoid grouping
|
|
$.fn.dataTable.Buttons.defaults.dom.container.className = "dt-buttons";
|
|
|
|
function deleteClient() {
|
|
// Passes the button data-del-id attribute as ID
|
|
var ids = [parseInt($(this).attr("data-del-id"), 10)];
|
|
delItems(ids);
|
|
}
|
|
|
|
function delItems(ids) {
|
|
// Check input validity
|
|
if (!Array.isArray(ids)) return;
|
|
|
|
var items = "";
|
|
var name = "";
|
|
|
|
for (var id of ids) {
|
|
// Exploit prevention: Return early for non-numeric IDs
|
|
if (typeof id !== "number") return;
|
|
|
|
// Retrieve details
|
|
name = utils.escapeHtml($("#name_" + id).text());
|
|
if (name.length > 0) {
|
|
name = " (<i>" + utils.escapeHtml($("#name_" + id).text()) + "</i>)";
|
|
}
|
|
|
|
// Add client
|
|
items += "<li>" + utils.escapeHtml($("#ip_" + id).text()) + name + "</li>";
|
|
}
|
|
|
|
utils.disableAll();
|
|
var idstring = ids.join(", ");
|
|
utils.showAlert("info", "", "Deleting client(s)...", "<ul>" + items + "</ul>");
|
|
|
|
$.ajax({
|
|
url: "scripts/pi-hole/php/groups.php",
|
|
method: "post",
|
|
dataType: "json",
|
|
data: { action: "delete_client", id: JSON.stringify(ids), token: token },
|
|
})
|
|
.done(function (response) {
|
|
utils.enableAll();
|
|
if (response.success) {
|
|
utils.showAlert(
|
|
"success",
|
|
"far fa-trash-alt",
|
|
"Successfully deleted client(s): ",
|
|
"<ul>" + items + "</ul>"
|
|
);
|
|
for (var id in ids) {
|
|
if (Object.hasOwnProperty.call(ids, id)) {
|
|
table.row(id).remove().draw(false).ajax.reload(null, false);
|
|
}
|
|
}
|
|
} else {
|
|
utils.showAlert(
|
|
"error",
|
|
"",
|
|
"Error while deleting client(s): " + idstring,
|
|
response.message
|
|
);
|
|
}
|
|
|
|
// Clear selection after deletion
|
|
table.rows().deselect();
|
|
utils.changeBulkDeleteStates(table);
|
|
})
|
|
.fail(function (jqXHR, exception) {
|
|
utils.enableAll();
|
|
utils.showAlert(
|
|
"error",
|
|
"",
|
|
"Error while deleting client(s): " + idstring,
|
|
jqXHR.responseText
|
|
);
|
|
console.log(exception); // eslint-disable-line no-console
|
|
});
|
|
}
|
|
|
|
function addClient() {
|
|
var ip = utils.escapeHtml($("#select").val().trim());
|
|
var comment = utils.escapeHtml($("#new_comment").val());
|
|
|
|
utils.disableAll();
|
|
utils.showAlert("info", "", "Adding client...", ip);
|
|
|
|
if (ip.length === 0) {
|
|
utils.enableAll();
|
|
utils.showAlert("warning", "", "Warning", "Please specify a client IP or MAC address");
|
|
return;
|
|
}
|
|
|
|
// Validate input, can be:
|
|
// - IPv4 address (with and without CIDR)
|
|
// - IPv6 address (with and without CIDR)
|
|
// - MAC address (in the form AA:BB:CC:DD:EE:FF)
|
|
// - host name (arbitrary form, we're only checking against some reserved characters)
|
|
if (utils.validateIPv4CIDR(ip) || utils.validateIPv6CIDR(ip) || utils.validateMAC(ip)) {
|
|
// Convert input to upper case (important for MAC addresses)
|
|
ip = ip.toUpperCase();
|
|
} else if (!utils.validateHostname(ip)) {
|
|
utils.enableAll();
|
|
utils.showAlert(
|
|
"warning",
|
|
"",
|
|
"Warning",
|
|
"Input is neither a valid IP or MAC address nor a valid host name!"
|
|
);
|
|
return;
|
|
}
|
|
|
|
$.ajax({
|
|
url: "scripts/pi-hole/php/groups.php",
|
|
method: "post",
|
|
dataType: "json",
|
|
data: { action: "add_client", ip: ip, comment: comment, token: token },
|
|
success: function (response) {
|
|
utils.enableAll();
|
|
if (response.success) {
|
|
utils.showAlert("success", "fas fa-plus", "Successfully added client", ip);
|
|
reloadClientSuggestions();
|
|
table.ajax.reload(null, false);
|
|
table.rows().deselect();
|
|
} else {
|
|
utils.showAlert("error", "", "Error while adding new client", response.message);
|
|
}
|
|
},
|
|
error: function (jqXHR, exception) {
|
|
utils.enableAll();
|
|
utils.showAlert("error", "", "Error while adding new client", jqXHR.responseText);
|
|
console.log(exception); // eslint-disable-line no-console
|
|
},
|
|
});
|
|
}
|
|
|
|
function editClient() {
|
|
var elem = $(this).attr("id");
|
|
var tr = $(this).closest("tr");
|
|
var id = tr.attr("data-id");
|
|
var groups = tr.find("#multiselect_" + id).val();
|
|
var ip = utils.escapeHtml(tr.find("#ip_" + id).text());
|
|
var name = utils.escapeHtml(tr.find("#name_" + id).text());
|
|
var comment = utils.escapeHtml(tr.find("#comment_" + id).val());
|
|
|
|
var done = "edited";
|
|
var notDone = "editing";
|
|
switch (elem) {
|
|
case "multiselect_" + id:
|
|
done = "edited groups of";
|
|
notDone = "editing groups of";
|
|
break;
|
|
case "comment_" + id:
|
|
done = "edited comment of";
|
|
notDone = "editing comment of";
|
|
break;
|
|
default:
|
|
alert("bad element or invalid data-id!");
|
|
return;
|
|
}
|
|
|
|
if (name.length > 0) {
|
|
ip += " (" + name + ")";
|
|
}
|
|
|
|
utils.disableAll();
|
|
utils.showAlert("info", "", "Editing client...", ip);
|
|
$.ajax({
|
|
url: "scripts/pi-hole/php/groups.php",
|
|
method: "post",
|
|
dataType: "json",
|
|
data: {
|
|
action: "edit_client",
|
|
id: id,
|
|
groups: groups,
|
|
token: token,
|
|
comment: comment,
|
|
},
|
|
success: function (response) {
|
|
utils.enableAll();
|
|
if (response.success) {
|
|
utils.showAlert("success", "fas fa-pencil-alt", "Successfully " + done + " client", ip);
|
|
table.ajax.reload(null, false);
|
|
} else {
|
|
utils.showAlert(
|
|
"error",
|
|
"Error while " + notDone + " client with ID " + id,
|
|
response.message
|
|
);
|
|
}
|
|
},
|
|
error: function (jqXHR, exception) {
|
|
utils.enableAll();
|
|
utils.showAlert(
|
|
"error",
|
|
"",
|
|
"Error while " + notDone + " client with ID " + id,
|
|
jqXHR.responseText
|
|
);
|
|
console.log(exception); // eslint-disable-line no-console
|
|
},
|
|
});
|
|
}
|