654 lines
19 KiB
JavaScript
654 lines
19 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, getGroups:false, updateFtlInfo:false, apiFailure:false, processGroupResult:false, delGroupItems:false, i18n */
|
|
/* exported initTable */
|
|
|
|
"use strict";
|
|
|
|
let table;
|
|
let GETDict = {};
|
|
|
|
i18n.waitForTranslations(() => {
|
|
GETDict = utils.parseQueryString();
|
|
|
|
// Tabs: Domain/Regex handling
|
|
// sync description fields, reset inactive inputs on tab change
|
|
$('a[data-toggle="tab"]').on("shown.bs.tab", function () {
|
|
const tabHref = $(this).attr("href");
|
|
let val;
|
|
if (tabHref === "#tab_domain") {
|
|
val = $("#new_regex_comment").val();
|
|
$("#new_domain_comment").val(val);
|
|
$("#new_regex").val("");
|
|
} else if (tabHref === "#tab_regex") {
|
|
val = $("#new_domain_comment").val();
|
|
$("#new_regex_comment").val(val);
|
|
$("#new_domain").val("");
|
|
$("#wildcard_checkbox").prop("checked", false);
|
|
}
|
|
|
|
clearTimeout(suggestTimeout);
|
|
$("#suggest_domains").hide();
|
|
});
|
|
|
|
$("#add_deny, #add_allow").on("click", addDomain);
|
|
|
|
// Domain suggestion handling
|
|
let suggestTimeout;
|
|
$("#new_domain").on("input", e => {
|
|
hideSuggestDomains();
|
|
clearTimeout(suggestTimeout);
|
|
suggestTimeout = setTimeout(showSuggestDomains, 1000, e.target.value);
|
|
});
|
|
|
|
utils.setBsSelectDefaults();
|
|
getGroups();
|
|
});
|
|
|
|
// Show a list of suggested domains based on the user's input
|
|
function showSuggestDomains(value) {
|
|
const newDomainEl = $("#new_domain");
|
|
const suggestDomainEl = $("#suggest_domains");
|
|
|
|
function createButton(hostname) {
|
|
// Purposefully omit 'btn' class to save space on padding
|
|
return $('<button type="button" class="btn-link btn-block text-right">')
|
|
.append($("<em>").text(hostname))
|
|
.on("click", () => {
|
|
hideSuggestDomains();
|
|
newDomainEl.val(hostname);
|
|
});
|
|
}
|
|
|
|
try {
|
|
const parts = new URL(value).hostname.split(".");
|
|
const table = $("<table>");
|
|
|
|
for (let i = 0; i < parts.length - 1; ++i) {
|
|
const hostname = parts.slice(i).join(".");
|
|
|
|
table.append(
|
|
$("<tr>")
|
|
.append(
|
|
$('<td class="text-nowrap text-right">').text(
|
|
i === 0 ? i18n.t("groups.domains.did_you_mean") : i18n.t("shared.or")
|
|
)
|
|
)
|
|
.append($("<td>").append(createButton(hostname)))
|
|
);
|
|
}
|
|
|
|
suggestDomainEl.slideUp("fast", () => {
|
|
suggestDomainEl.html(table);
|
|
suggestDomainEl.slideDown("fast");
|
|
});
|
|
} catch (error) {
|
|
const { message } = error;
|
|
const isValidUrlError =
|
|
error instanceof TypeError &&
|
|
(message.includes("Invalid URL") || message.includes("is not a valid URL"));
|
|
|
|
if (!isValidUrlError) {
|
|
throw error;
|
|
}
|
|
}
|
|
}
|
|
|
|
function hideSuggestDomains() {
|
|
$("#suggest_domains").slideUp("fast");
|
|
}
|
|
|
|
// eslint-disable-next-line no-unused-vars
|
|
function initTable() {
|
|
table = $("#domainsTable").DataTable({
|
|
processing: true,
|
|
ajax: {
|
|
url: document.body.dataset.apiurl + "/domains",
|
|
dataSrc: "domains",
|
|
type: "GET",
|
|
},
|
|
order: [[0, "asc"]],
|
|
columns: [
|
|
{ data: "id", visible: false },
|
|
{ data: null, visible: true, orderable: false, width: "15px" },
|
|
{ data: "domain" },
|
|
{ data: null, searchable: false },
|
|
{ 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: 3,
|
|
render(data) {
|
|
return data.kind + "_" + data.type;
|
|
},
|
|
},
|
|
{
|
|
targets: "_all",
|
|
render: $.fn.dataTable.render.text(),
|
|
},
|
|
],
|
|
drawCallback() {
|
|
// Hide buttons if all domains were deleted
|
|
const hasRows = this.api().rows({ filter: "applied" }).data().length > 0;
|
|
$(".datatable-bt").css("visibility", hasRows ? "visible" : "hidden");
|
|
|
|
$('button[id^="deleteDomain_"]').on("click", deleteDomain);
|
|
// Remove visible dropdown to prevent orphaning
|
|
$("body > .bootstrap-select.dropdown").remove();
|
|
},
|
|
rowCallback(row, data) {
|
|
const dataId = utils.hexEncode(data.domain) + "_" + data.type + "_" + data.kind;
|
|
$(row).attr("data-id", dataId);
|
|
// Tooltip for domain
|
|
const tooltip = i18n.tf(
|
|
"groups.table_row_tooltip",
|
|
utils.datetime(data.date_added, false),
|
|
utils.datetime(data.date_modified, false),
|
|
data.id
|
|
);
|
|
$("td:eq(1)", row).html(
|
|
'<code id="domain_' +
|
|
dataId +
|
|
'" title="' +
|
|
tooltip +
|
|
'" class="breakall">' +
|
|
utils.escapeHtml(data.unicode) +
|
|
(data.domain !== data.unicode ? " (" + utils.escapeHtml(data.domain) + ")" : "") +
|
|
"</code>"
|
|
);
|
|
|
|
// Drop-down type selector
|
|
$("td:eq(2)", row).html(
|
|
'<select id="type_' +
|
|
dataId +
|
|
'" class="form-control">' +
|
|
'<option value="allow/exact"' +
|
|
(data.type === "allow" && data.kind === "exact" ? " selected" : "") +
|
|
`>${i18n.t("groups.domains.exact_allow")}</option>` +
|
|
'<option value="allow/regex"' +
|
|
(data.type === "allow" && data.kind === "regex" ? " selected" : "") +
|
|
`>${i18n.t("groups.domains.regex_allow")}</option>` +
|
|
'<option value="deny/exact"' +
|
|
(data.type === "deny" && data.kind === "exact" ? " selected " : "") +
|
|
`>${i18n.t("groups.domains.exact_deny")}</option>` +
|
|
'<option value="deny/regex"' +
|
|
(data.type === "deny" && data.kind === "regex" ? " selected" : "") +
|
|
`>${i18n.t("groups.domains.regex_deny")}</option>` +
|
|
"</select>" +
|
|
"<input type='hidden' id='old_type_" +
|
|
dataId +
|
|
"' value='" +
|
|
data.type +
|
|
"/" +
|
|
data.kind +
|
|
"'>"
|
|
);
|
|
const typeEl = $("#type_" + dataId, row);
|
|
typeEl.on("change", editDomain);
|
|
|
|
// Initialize bootstrap-toggle for status field (enabled/disabled)
|
|
$("td:eq(3)", 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", editDomain);
|
|
|
|
// Comment field
|
|
$("td:eq(4)", row).html('<input id="comment_' + dataId + '" class="form-control">');
|
|
const commentEl = $("#comment_" + dataId, row);
|
|
commentEl.val(data.comment);
|
|
commentEl.on("change", editDomain);
|
|
|
|
// Group assignment field (multi-select)
|
|
$("td:eq(5)", row).empty();
|
|
$("td:eq(5)", 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="(disabled)"';
|
|
|
|
selectEl.append(
|
|
$("<option " + dataSub + "/>")
|
|
.val(group.id)
|
|
.text(group.name)
|
|
);
|
|
}
|
|
|
|
// Select assigned groups
|
|
selectEl.val(data.groups);
|
|
// Initialize bootstrap-select
|
|
const applyBtn = "#btn_apply_" + dataId;
|
|
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 changes were made to the drop-down menu
|
|
// and have it call editDomain() on click
|
|
if ($(applyBtn).prop("disabled")) {
|
|
$(applyBtn)
|
|
.addClass("btn-success")
|
|
.prop("disabled", false)
|
|
.on("click", () => {
|
|
editDomain.call(selectEl);
|
|
});
|
|
}
|
|
})
|
|
.on("hide.bs.select", function () {
|
|
// Restore values if drop-down menu is closed without clicking the
|
|
// Apply button (e.g. by clicking outside) and re-disable 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 "domainid=" is used)
|
|
if ("domainid" in GETDict && data.id === Number.parseInt(GETDict.domainid, 10)) {
|
|
$(row).find("td").addClass("highlight");
|
|
}
|
|
|
|
// Add delete domain button
|
|
const button =
|
|
'<button type="button" class="btn btn-danger btn-xs" id="deleteDomain_' +
|
|
dataId +
|
|
'" data-id="' +
|
|
dataId +
|
|
'">' +
|
|
'<span class="far fa-trash-alt"></span>' +
|
|
"</button>";
|
|
$("td:eq(6)", row).html(button);
|
|
},
|
|
select: {
|
|
style: "multi",
|
|
selector: "td:first-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($(this).attr("data-id"));
|
|
});
|
|
// Delete all selected rows at once
|
|
deleteDomains(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(settings, data) {
|
|
utils.stateSaveCallback("groups-domains-table", data);
|
|
},
|
|
stateLoadCallback() {
|
|
const data = utils.stateLoadCallback("groups-domains-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 ("domainid" in GETDict) {
|
|
const pos = table
|
|
.column(0, { order: "current" })
|
|
.data()
|
|
.indexOf(Number.parseInt(GETDict.domainid, 10));
|
|
if (pos !== -1) {
|
|
const page = Math.floor(pos / table.page.info().length);
|
|
table.page(page).draw(false);
|
|
}
|
|
}
|
|
},
|
|
});
|
|
// 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);
|
|
}
|
|
|
|
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");
|
|
});
|
|
}
|
|
|
|
// Enable "filter by type" functionality, using checkboxes
|
|
$.fn.dataTable.ext.search.push((settings, searchData, index, rowData) => {
|
|
const types = $(".filter_types input:checkbox:checked")
|
|
.map(function () {
|
|
return this.value;
|
|
})
|
|
.get();
|
|
|
|
const typeStr = rowData.type + "/" + rowData.kind;
|
|
if (types.includes(typeStr)) {
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
});
|
|
$(".filter_types input:checkbox").on("change", () => {
|
|
table.draw();
|
|
});
|
|
|
|
// Remove 'bnt-group' class from container, to avoid grouping
|
|
$.fn.dataTable.Buttons.defaults.dom.container.className = "dt-buttons";
|
|
|
|
function deleteDomain() {
|
|
// Passes the button data-id attribute as ID
|
|
deleteDomains([$(this).attr("data-id")]);
|
|
}
|
|
|
|
function deleteDomains(encodedIds) {
|
|
const decodedIds = [];
|
|
for (const [i, encodedId] of encodedIds.entries()) {
|
|
// Decode domain, type, and kind and add to array
|
|
const parts = encodedId.split("_");
|
|
decodedIds[i] = {
|
|
item: parts[0],
|
|
type: parts[1],
|
|
kind: parts[2],
|
|
};
|
|
}
|
|
|
|
delGroupItems("domain", decodedIds, table);
|
|
}
|
|
|
|
function addDomain() {
|
|
const action = this.id;
|
|
const tabHref = $('a[data-toggle="tab"][aria-expanded="true"]').attr("href");
|
|
const wildcardEl = $("#wildcard_checkbox");
|
|
const wildcardChecked = wildcardEl.prop("checked");
|
|
|
|
// current tab's inputs
|
|
let kind;
|
|
let domainEl;
|
|
let commentEl;
|
|
let groupEl;
|
|
if (tabHref === "#tab_domain") {
|
|
kind = "exact";
|
|
domainEl = $("#new_domain");
|
|
commentEl = $("#new_domain_comment");
|
|
groupEl = $("#new_domain_group");
|
|
} else if (tabHref === "#tab_regex") {
|
|
kind = "regex";
|
|
domainEl = $("#new_regex");
|
|
commentEl = $("#new_regex_comment");
|
|
groupEl = $("#new_regex_group");
|
|
}
|
|
|
|
const comment = commentEl.val();
|
|
// Convert all group IDs to integers
|
|
const group = groupEl.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 domains = domainEl.val().split(/\s+/);
|
|
// Remove empty elements
|
|
domains = domains.filter(el => el !== "");
|
|
const domainStr = JSON.stringify(domains);
|
|
|
|
utils.disableAll();
|
|
utils.showAlert("info", "", i18n.t("groups.domains.adding_domain"), domainStr);
|
|
|
|
if (domains.length === 0) {
|
|
utils.enableAll();
|
|
utils.showAlert(
|
|
"warning",
|
|
"",
|
|
i18n.t("shared.warning"),
|
|
i18n.t("groups.domains.specify_domain")
|
|
);
|
|
return;
|
|
}
|
|
|
|
// Check if the wildcard checkbox was marked and transform the domains into regex
|
|
if (kind === "exact" && wildcardChecked) {
|
|
for (const [index, domain] of domains.entries()) {
|
|
// Strip leading "*." if specified by user in wildcard mode
|
|
if (domain.startsWith("*.")) domains[index] = domain.substr(2);
|
|
|
|
// Transform domain into a wildcard regex
|
|
domains[index] = "(\\.|^)" + domains[index].replaceAll(".", "\\.") + "$";
|
|
}
|
|
|
|
kind = "regex";
|
|
}
|
|
|
|
// determine list type
|
|
const type = action === "add_deny" ? "deny" : "allow";
|
|
|
|
$.ajax({
|
|
url: document.body.dataset.apiurl + "/domains/" + type + "/" + kind,
|
|
method: "post",
|
|
dataType: "json",
|
|
processData: false,
|
|
contentType: "application/json; charset=utf-8",
|
|
data: JSON.stringify({
|
|
domain: domains,
|
|
comment,
|
|
type,
|
|
kind,
|
|
groups: group,
|
|
}),
|
|
success(data) {
|
|
utils.enableAll();
|
|
utils.listsAlert("shared.domain", domains, data);
|
|
$("#new_domain").val("");
|
|
$("#new_domain_comment").val("");
|
|
$("#new_regex").val("");
|
|
$("#new_regex_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.t("groups.domains.error_adding_domain"), data.responseText);
|
|
console.log(exception); // eslint-disable-line no-console
|
|
},
|
|
});
|
|
}
|
|
|
|
function editDomain() {
|
|
const elem = $(this).attr("id");
|
|
const tr = $(this).closest("tr");
|
|
const domain = tr.attr("data-id");
|
|
const newTypestr = tr.find("#type_" + domain).val();
|
|
const oldTypeStr = tr.find("#old_type_" + domain).val();
|
|
const enabled = tr.find("#enabled_" + domain).is(":checked");
|
|
const comment = tr.find("#comment_" + domain).val();
|
|
// Convert list of string integers to list of integers using map
|
|
const groups = tr
|
|
.find("#multiselect_" + domain)
|
|
.val()
|
|
.map(Number);
|
|
|
|
const oldType = oldTypeStr.split("/")[0];
|
|
const oldKind = oldTypeStr.split("/")[1];
|
|
|
|
let done = "edited";
|
|
let notDone = "editing";
|
|
switch (elem) {
|
|
case "enabled_" + domain:
|
|
if (!enabled) {
|
|
done = "disabled";
|
|
notDone = "disabling";
|
|
} else {
|
|
done = "enabled";
|
|
notDone = "enabling";
|
|
}
|
|
|
|
break;
|
|
case "name_" + domain:
|
|
done = "edited name of";
|
|
notDone = "editing name of";
|
|
break;
|
|
case "comment_" + domain:
|
|
done = "edited comment of";
|
|
notDone = "editing comment of";
|
|
break;
|
|
case "type_" + domain:
|
|
done = "edited type of";
|
|
notDone = "editing type of";
|
|
break;
|
|
case "multiselect_" + domain:
|
|
done = "edited groups of";
|
|
notDone = "editing groups of";
|
|
break;
|
|
default:
|
|
alert("bad element (" + elem + ") or invalid data-id!");
|
|
return;
|
|
}
|
|
|
|
utils.disableAll();
|
|
const domainDecoded = utils.hexDecode(domain.split("_")[0]);
|
|
utils.showAlert("info", "", "Editing domain...", domainDecoded);
|
|
$.ajax({
|
|
url:
|
|
document.body.dataset.apiurl +
|
|
"/domains/" +
|
|
newTypestr +
|
|
"/" +
|
|
encodeURIComponent(domainDecoded),
|
|
method: "put",
|
|
dataType: "json",
|
|
processData: false,
|
|
contentType: "application/json; charset=utf-8",
|
|
data: JSON.stringify({
|
|
groups,
|
|
comment,
|
|
enabled,
|
|
type: oldType,
|
|
kind: oldKind,
|
|
}),
|
|
success(data) {
|
|
utils.enableAll();
|
|
// @TODO: need good translations for done and notDone - and data comes from backend
|
|
processGroupResult(data, "domain", done, notDone);
|
|
table.ajax.reload(null, false);
|
|
},
|
|
error(data, exception) {
|
|
apiFailure(data);
|
|
utils.enableAll();
|
|
utils.showAlert(
|
|
"error",
|
|
"",
|
|
i18n.tf("groups.domains.error_editing_domain", notDone, domainDecoded),
|
|
data.responseText
|
|
);
|
|
console.log(exception); // eslint-disable-line no-console
|
|
},
|
|
});
|
|
}
|