640 lines
20 KiB
JavaScript
640 lines
20 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, groups:false, apiFailure:false, updateFtlInfo:false, getGroups:false, processGroupResult:false, delGroupItems:false, i18n */
|
|
/* exported initTable */
|
|
|
|
"use strict";
|
|
|
|
let table;
|
|
let GETDict = {};
|
|
|
|
i18n.waitForTranslations(() => {
|
|
GETDict = utils.parseQueryString();
|
|
|
|
$("#btnAddAllow").on("click", { type: "allow" }, addList);
|
|
$("#btnAddBlock").on("click", { type: "block" }, addList);
|
|
|
|
utils.setBsSelectDefaults();
|
|
getGroups();
|
|
});
|
|
|
|
function format(data) {
|
|
// Generate human-friendly status string
|
|
const statusText = setStatusText(data, true);
|
|
let numbers = true;
|
|
if (data.status === 0 || data.status === 4) {
|
|
numbers = false;
|
|
}
|
|
|
|
// Compile extra info for displaying
|
|
const dateAddedISO = utils.datetime(data.date_added, false);
|
|
const dateModifiedISO = utils.datetime(data.date_modified, false);
|
|
const dateUpdated =
|
|
data.date_updated > 0
|
|
? utils.datetimeRelative(data.date_updated) +
|
|
" (" +
|
|
utils.datetime(data.date_updated, false) +
|
|
")"
|
|
: "N/A";
|
|
const numberOfEntries =
|
|
(data.number !== null && numbers === true
|
|
? Number.parseInt(data.number, 10).toLocaleString()
|
|
: "N/A") +
|
|
(data.abp_entries !== null && Number.parseInt(data.abp_entries, 10) > 0 && numbers === true
|
|
? ` ${i18n.tf("groups.lists.num_in_abp_style", Number.parseInt(data.abp_entries, 10).toLocaleString())}`
|
|
: "");
|
|
const nonDomains =
|
|
data.invalid_domains !== null && numbers === true
|
|
? Number.parseInt(data.invalid_domains, 10).toLocaleString()
|
|
: "N/A";
|
|
|
|
return `<table>
|
|
<tr class="dataTables-child">
|
|
<td>${i18n.t("shared.type")}: </td><td>${setTypeIcon(data.type)}${i18n.t(`shared.${data.type}list`)}</td>
|
|
</tr>
|
|
<tr class="dataTables-child">
|
|
<td>${i18n.t("groups.lists.health_status")}: </td><td>${statusText}</td>
|
|
</tr>
|
|
<tr class="dataTables-child">
|
|
<td>${i18n.t("groups.lists.added_to_pihole")}: </td>
|
|
<td>${utils.datetimeRelative(data.date_added)} (${dateAddedISO})</td>
|
|
</tr>
|
|
<tr class="dataTables-child">
|
|
<td>${i18n.t("groups.lists.last_modified")}: </td>
|
|
<td>${utils.datetimeRelative(data.date_modified)} (${dateModifiedISO})</td>
|
|
</tr>
|
|
<tr class="dataTables-child">
|
|
<td>${i18n.t("groups.lists.last_updated")}: </td><td>${dateUpdated}</td>
|
|
</tr>
|
|
<tr class="dataTables-child">
|
|
<td>${i18n.t("groups.lists.num_entries")}: </td><td>${numberOfEntries}</td>
|
|
</tr>
|
|
<tr class="dataTables-child">
|
|
<td>${i18n.t("groups.lists.num_non_domains")}: </td><td>${nonDomains}</td>
|
|
</tr>
|
|
<tr class="dataTables-child">
|
|
<td>${i18n.t("groups.lists.database_id")}:</td><td>${data.id}</td>
|
|
</tr>
|
|
</table>`;
|
|
}
|
|
|
|
// Define the status icon element
|
|
function setStatusIcon(data) {
|
|
const statusCode = Number.parseInt(data.status, 10);
|
|
const statusTitle = setStatusText(data) + "\n" + i18n.t("groups.lists.click_for_details");
|
|
let statusIcon;
|
|
|
|
switch (statusCode) {
|
|
case 1:
|
|
statusIcon = "fa-check-circle";
|
|
break;
|
|
case 2:
|
|
statusIcon = "fa-history";
|
|
break;
|
|
case 3:
|
|
statusIcon = "fa-exclamation-circle";
|
|
break;
|
|
case 4:
|
|
statusIcon = "fa-times-circle";
|
|
break;
|
|
default:
|
|
statusIcon = "fa-question-circle";
|
|
break;
|
|
}
|
|
|
|
return "<i class='fa fa-fw " + statusIcon + "' title='" + statusTitle + "'></i>";
|
|
}
|
|
|
|
// Define human-friendly status string
|
|
function setStatusText(data, showdetails = false) {
|
|
let statusText = i18n.t("groups.lists.unknown");
|
|
let statusDetails = "";
|
|
if (data.status !== null) {
|
|
switch (Number.parseInt(data.status, 10)) {
|
|
case 0:
|
|
statusText =
|
|
data.enabled === 0
|
|
? i18n.t("groups.lists.disabled_not_checked")
|
|
: i18n.t("groups.lists.not_downloaded");
|
|
break;
|
|
case 1:
|
|
statusText = i18n.t("groups.lists.download_successful");
|
|
statusDetails =
|
|
' (<span class="list-status-1">' + i18n.t("groups.lists.status_ok") + "</span>)";
|
|
break;
|
|
case 2:
|
|
statusText = i18n.t("groups.lists.unchanged_used_local");
|
|
statusDetails =
|
|
' (<span class="list-status-2">' + i18n.t("groups.lists.status_ok") + "</span>)";
|
|
break;
|
|
case 3:
|
|
statusText = i18n.t("groups.lists.unavailable_used_local");
|
|
statusDetails =
|
|
' (<span class="list-status-3">' + i18n.t("groups.lists.status_check_list") + "</span>)";
|
|
break;
|
|
case 4:
|
|
statusText = i18n.t("groups.lists.unavailable_no_local");
|
|
statusDetails =
|
|
' (<span class="list-status-4">' +
|
|
i18n.t("groups.lists.status_replace_list") +
|
|
"</span>)";
|
|
break;
|
|
|
|
default:
|
|
statusText = i18n.t("groups.lists.unknown");
|
|
statusDetails =
|
|
' (<span class="list-status-0">' + Number.parseInt(data.status, 10) + "</span>)";
|
|
break;
|
|
}
|
|
}
|
|
|
|
return statusText + (showdetails === true ? statusDetails : "");
|
|
}
|
|
|
|
// Define the type icon element
|
|
function setTypeIcon(type) {
|
|
//Add red ban icon if data["type"] is "block"
|
|
//Add green check icon if data["type"] is "allow"
|
|
let iconClass = "fa-question text-orange";
|
|
let title = i18n.t("groups.lists.unknown_type");
|
|
if (type === "block") {
|
|
iconClass = "fa-ban text-red";
|
|
title = i18n.t("groups.lists.blocklist");
|
|
} else if (type === "allow") {
|
|
iconClass = "fa-check text-green";
|
|
title = i18n.t("groups.lists.allowlist");
|
|
}
|
|
|
|
return `<i class='fa fa-fw ${iconClass}' title='${title}\n${i18n.t("groups.lists.click_for_details")}'></i> `;
|
|
}
|
|
|
|
// eslint-disable-next-line no-unused-vars
|
|
function initTable() {
|
|
table = $("#listsTable").DataTable({
|
|
processing: true,
|
|
ajax: {
|
|
url: document.body.dataset.apiurl + "/lists",
|
|
dataSrc: "lists",
|
|
type: "GET",
|
|
},
|
|
order: [[0, "asc"]],
|
|
columns: [
|
|
{ data: "id", visible: false },
|
|
{ data: null, visible: true, orderable: false, width: "15px" },
|
|
{ data: "status", searchable: false, class: "details-control" },
|
|
{ data: "type", searchable: false, class: "details-control" },
|
|
{ data: "address" },
|
|
{ data: "enabled", searchable: false },
|
|
{ data: "comment" },
|
|
{ data: "groups", searchable: false },
|
|
{ data: null, width: "22px", orderable: false },
|
|
],
|
|
columnDefs: [
|
|
{
|
|
targets: 1,
|
|
className: "select-checkbox",
|
|
render() {
|
|
return "";
|
|
},
|
|
},
|
|
{
|
|
targets: "_all",
|
|
render: $.fn.dataTable.render.text(),
|
|
},
|
|
],
|
|
drawCallback() {
|
|
// Hide buttons if all lists were deleted
|
|
const hasRows = this.api().rows({ filter: "applied" }).data().length > 0;
|
|
$(".datatable-bt").css("visibility", hasRows ? "visible" : "hidden");
|
|
|
|
$('button[id^="deleteList_"]').on("click", deleteList);
|
|
// Remove visible dropdown to prevent orphaning
|
|
$("body > .bootstrap-select.dropdown").remove();
|
|
},
|
|
rowCallback(row, data) {
|
|
const dataId = utils.hexEncode(data.address + "_" + data.type);
|
|
$(row).attr("data-id", dataId);
|
|
$(row).attr("data-address", utils.hexEncode(data.address));
|
|
$(row).attr("data-type", data.type);
|
|
|
|
let statusCode = 0;
|
|
// If there is no status or the list is disabled, we keep
|
|
// status 0 (== unknown)
|
|
if (data.status !== null && data.enabled) {
|
|
statusCode = Number.parseInt(data.status, 10);
|
|
}
|
|
|
|
$("td:eq(1)", row).addClass("list-status-" + statusCode);
|
|
$("td:eq(1)", row).html(setStatusIcon(data));
|
|
|
|
$("td:eq(2)", row).addClass("list-type-" + statusCode);
|
|
$("td:eq(2)", row).html(setTypeIcon(data.type));
|
|
|
|
if (data.address.startsWith("file://")) {
|
|
// Local files cannot be downloaded from a distant client so don't show
|
|
// a link to such a list here
|
|
$("td:eq(3)", row).html(
|
|
'<code id="address_' +
|
|
dataId +
|
|
'" class="breakall">' +
|
|
utils.escapeHtml(data.address) +
|
|
"</code>"
|
|
);
|
|
} else {
|
|
$("td:eq(3)", row).html(
|
|
'<a id="address_' +
|
|
dataId +
|
|
'" class="breakall" href="' +
|
|
encodeURI(data.address) +
|
|
"?lang=" +
|
|
i18n.lang +
|
|
'" target="_blank" rel="noopener noreferrer">' +
|
|
utils.escapeHtml(data.address) +
|
|
"</a>"
|
|
);
|
|
}
|
|
|
|
$("td:eq(4)", row).html(
|
|
'<input type="checkbox" id="enabled_' +
|
|
dataId +
|
|
'"' +
|
|
(data.enabled ? " checked" : "") +
|
|
">"
|
|
);
|
|
const statusEl = $("#enabled_" + dataId, row);
|
|
statusEl.bootstrapToggle({
|
|
on: i18n.t("shared.enabled"),
|
|
off: i18n.t("shared.disabled"),
|
|
size: "small",
|
|
onstyle: "success",
|
|
width: "80px",
|
|
});
|
|
statusEl.on("change", editList);
|
|
|
|
$("td:eq(5)", row).html('<input id="comment_' + dataId + '" class="form-control">');
|
|
const commentEl = $("#comment_" + dataId, row);
|
|
commentEl.val(data.comment);
|
|
commentEl.on("change", editList);
|
|
|
|
$("td:eq(6)", row).empty();
|
|
$("td:eq(6)", row).append(
|
|
'<select class="selectpicker" id="multiselect_' + dataId + '" multiple></select>'
|
|
);
|
|
const selectEl = $("#multiselect_" + dataId, row);
|
|
// Add all known groups
|
|
for (const group of groups) {
|
|
const dataSub = group.enabled
|
|
? ""
|
|
: `data-subtext="(${i18n.t("shared.disabled").toLowerCase()})"`;
|
|
|
|
selectEl.append(
|
|
$("<option " + dataSub + "/>")
|
|
.val(group.id)
|
|
.text(group.name)
|
|
);
|
|
}
|
|
|
|
const applyBtn = "#btn_apply_" + dataId;
|
|
|
|
// 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", () => {
|
|
const winWidth = $(globalThis).width();
|
|
const dropdownEl = $("body > .bootstrap-select.dropdown");
|
|
if (dropdownEl.length > 0) {
|
|
dropdownEl.removeClass("align-right");
|
|
const width = dropdownEl.width();
|
|
const left = dropdownEl.offset().left;
|
|
if (left + width > winWidth) {
|
|
dropdownEl.addClass("align-right");
|
|
}
|
|
}
|
|
})
|
|
.on("changed.bs.select", () => {
|
|
// enable Apply button
|
|
if ($(applyBtn).prop("disabled")) {
|
|
$(applyBtn)
|
|
.addClass("btn-success")
|
|
.prop("disabled", false)
|
|
.on("click", () => {
|
|
editList.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_' +
|
|
dataId +
|
|
` class="btn btn-block btn-sm" disabled>${i18n.t("shared.apply")}</button>`
|
|
);
|
|
|
|
// Highlight row (if url parameter "listid=" is used)
|
|
if ("listid" in GETDict && data.id === Number.parseInt(GETDict.listid, 10)) {
|
|
$(row).find("td").addClass("highlight");
|
|
}
|
|
|
|
const button =
|
|
'<button type="button" class="btn btn-danger btn-xs" id="deleteList_' +
|
|
dataId +
|
|
'" data-id="' +
|
|
dataId +
|
|
'">' +
|
|
'<span class="far fa-trash-alt"></span>' +
|
|
"</button>";
|
|
$("td:eq(7)", row).html(button);
|
|
},
|
|
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, i18n.t("shared.all")],
|
|
],
|
|
select: {
|
|
style: "multi",
|
|
selector: "td:not(:last-child)",
|
|
info: false,
|
|
},
|
|
buttons: [
|
|
{
|
|
text: '<span class="far fa-square"></span>',
|
|
titleAttr: i18n.t("shared.select_all"),
|
|
className: "btn-sm datatable-bt selectAll",
|
|
action() {
|
|
table.rows({ page: "current" }).select();
|
|
},
|
|
},
|
|
{
|
|
text: '<span class="far fa-plus-square"></span>',
|
|
titleAttr: i18n.t("shared.select_all"),
|
|
className: "btn-sm datatable-bt selectMore",
|
|
action() {
|
|
table.rows({ page: "current" }).select();
|
|
},
|
|
},
|
|
{
|
|
extend: "selectNone",
|
|
text: '<span class="far fa-check-square"></span>',
|
|
titleAttr: i18n.t("shared.deselect_all"),
|
|
className: "btn-sm datatable-bt removeAll",
|
|
},
|
|
{
|
|
text: '<span class="far fa-trash-alt"></span>',
|
|
titleAttr: i18n.t("shared.delete_selected"),
|
|
className: "btn-sm datatable-bt deleteSelected",
|
|
action() {
|
|
// For each ".selected" row ...
|
|
const ids = [];
|
|
$("tr.selected").each(function () {
|
|
// ... add the row identified by "data-id".
|
|
ids.push({ item: $(this).attr("data-address"), type: $(this).attr("data-type") });
|
|
});
|
|
// Delete all selected rows at once
|
|
delGroupItems("list", ids, table, "multiple ");
|
|
},
|
|
},
|
|
],
|
|
stateSave: true,
|
|
stateDuration: 0,
|
|
stateSaveCallback(settings, data) {
|
|
utils.stateSaveCallback("groups-lists-table", data);
|
|
},
|
|
stateLoadCallback() {
|
|
const data = utils.stateLoadCallback("groups-lists-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;
|
|
},
|
|
initComplete() {
|
|
if ("listid" in GETDict) {
|
|
const pos = table
|
|
.column(0, { order: "current" })
|
|
.data()
|
|
.indexOf(Number.parseInt(GETDict.listid, 10));
|
|
if (pos !== -1) {
|
|
const page = Math.floor(pos / table.page.info().length);
|
|
table.page(page).draw(false);
|
|
}
|
|
}
|
|
},
|
|
});
|
|
|
|
table.on("init select deselect", () => {
|
|
utils.changeBulkDeleteStates(table);
|
|
});
|
|
|
|
table.on("order.dt", () => {
|
|
const order = table.order();
|
|
if (order[0][0] !== 0 || order[0][1] !== "asc") {
|
|
$("#resetButton").removeClass("hidden");
|
|
} else {
|
|
$("#resetButton").addClass("hidden");
|
|
}
|
|
});
|
|
|
|
$("#resetButton").on("click", () => {
|
|
table.order([[0, "asc"]]).draw();
|
|
$("#resetButton").addClass("hidden");
|
|
});
|
|
|
|
// Add event listener for opening and closing details
|
|
$("#listsTable tbody").on("click", "td.details-control", function () {
|
|
const tr = $(this).closest("tr");
|
|
const row = table.row(tr);
|
|
|
|
if (row.child.isShown()) {
|
|
// This row is already open - close it
|
|
row.child.hide();
|
|
tr.removeClass("shown");
|
|
} else {
|
|
// Open this row
|
|
row.child(format(row.data())).show();
|
|
tr.addClass("shown");
|
|
}
|
|
});
|
|
|
|
// Disable autocorrect in the search box
|
|
const 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);
|
|
}
|
|
}
|
|
|
|
// Remove 'bnt-group' class from container, to avoid grouping
|
|
$.fn.dataTable.Buttons.defaults.dom.container.className = "dt-buttons";
|
|
|
|
function deleteList() {
|
|
const tr = $(this).closest("tr");
|
|
const listType = tr.attr("data-type");
|
|
const ids = [{ item: tr.attr("data-address"), type: listType }];
|
|
delGroupItems("list", ids, table, listType);
|
|
}
|
|
|
|
function addList(event) {
|
|
const type = event.data.type;
|
|
const comment = $("#new_comment").val();
|
|
// Convert all group IDs to integers
|
|
const group = $("#new_group").val().map(Number);
|
|
|
|
// Check if the user wants to add multiple domains (space or newline separated)
|
|
// If so, split the input and store it in an array
|
|
let addresses = $("#new_address")
|
|
.val()
|
|
.split(/[\s,]+/);
|
|
// Remove empty elements
|
|
addresses = addresses.filter(el => el !== "");
|
|
const addressestr = JSON.stringify(addresses);
|
|
|
|
utils.disableAll();
|
|
const typelist = i18n.t(`shared.${type}list${addresses.length > 1 ? "s" : ""}`);
|
|
utils.showAlert("info", "", i18n.tf("groups.lists.adding_subscribed", typelist), addressestr);
|
|
|
|
if (addresses.length === 0) {
|
|
// enable the ui elements again
|
|
utils.enableAll();
|
|
utils.showAlert(
|
|
"warning",
|
|
"",
|
|
i18n.t("shared.warning"),
|
|
i18n.tf("groups.lists.specify_address", typelist)
|
|
);
|
|
return;
|
|
}
|
|
|
|
$.ajax({
|
|
url: document.body.dataset.apiurl + "/lists",
|
|
method: "post",
|
|
dataType: "json",
|
|
processData: false,
|
|
contentType: "application/json; charset=utf-8",
|
|
data: JSON.stringify({ address: addresses, comment, type, groups: group }),
|
|
success(data) {
|
|
utils.enableAll();
|
|
utils.listsAlert(`shared.${type}list`, addresses, data);
|
|
$("#new_address").val("");
|
|
$("#new_comment").val("");
|
|
table.ajax.reload(null, false);
|
|
table.rows().deselect();
|
|
|
|
// Update number of groups in the sidebar
|
|
updateFtlInfo();
|
|
},
|
|
error(data, exception) {
|
|
apiFailure(data);
|
|
utils.enableAll();
|
|
utils.showAlert(
|
|
"error",
|
|
"",
|
|
i18n.tf("groups.lists.error_adding_list", typelist),
|
|
data.responseText
|
|
);
|
|
console.log(exception); // eslint-disable-line no-console
|
|
},
|
|
});
|
|
}
|
|
|
|
function editList() {
|
|
const elem = $(this).attr("id");
|
|
const tr = $(this).closest("tr");
|
|
const type = tr.attr("data-type");
|
|
const dataId = tr.attr("data-id");
|
|
const address = utils.hexDecode(tr.attr("data-address"));
|
|
const enabled = tr.find("#enabled_" + dataId).is(":checked");
|
|
const comment = tr.find("#comment_" + dataId).val();
|
|
// Convert list of string integers to list of integers using map(Number)
|
|
const groups = tr
|
|
.find("#multiselect_" + dataId)
|
|
.val()
|
|
.map(Number);
|
|
|
|
let done = "edited";
|
|
let notDone = "editing";
|
|
switch (elem) {
|
|
case "enabled_" + dataId:
|
|
if (!enabled) {
|
|
done = "disabled";
|
|
notDone = "disabling";
|
|
} else {
|
|
done = "enabled";
|
|
notDone = "enabling";
|
|
}
|
|
|
|
break;
|
|
case "comment_" + dataId:
|
|
done = "edited comment of";
|
|
notDone = "editing comment of";
|
|
break;
|
|
case "multiselect_" + dataId:
|
|
done = "edited groups of";
|
|
notDone = "editing groups of";
|
|
break;
|
|
default:
|
|
alert("bad element (" + elem + ") or invalid data-id!");
|
|
return;
|
|
}
|
|
|
|
utils.disableAll();
|
|
utils.showAlert("info", "", i18n.t("groups.lists.editing_address"), address);
|
|
$.ajax({
|
|
url: document.body.dataset.apiurl + "/lists/" + encodeURIComponent(address) + "?type=" + type,
|
|
method: "put",
|
|
dataType: "json",
|
|
processData: false,
|
|
contentType: "application/json; charset=utf-8",
|
|
data: JSON.stringify({
|
|
groups,
|
|
comment,
|
|
enabled,
|
|
type,
|
|
}),
|
|
success(data) {
|
|
utils.enableAll();
|
|
// @TODO: need good translations for done and notDone - and data comes from backend
|
|
processGroupResult(data, type + "list", done, notDone);
|
|
table.ajax.reload(null, false);
|
|
},
|
|
error(data, exception) {
|
|
apiFailure(data);
|
|
utils.enableAll();
|
|
const typelist = i18n.t(`shared.${type}list`);
|
|
utils.showAlert(
|
|
"error",
|
|
"",
|
|
i18n.tf("groups.lists.error_editing_address", notDone, typelist, address),
|
|
data.responseText
|
|
);
|
|
console.log(exception); // eslint-disable-line no-console
|
|
},
|
|
});
|
|
}
|