pi-hole/web
1
0
Fork 0
mirror of https://github.com/pi-hole/web.git synced 2024-12-06 19:36:21 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #986 from pi-hole/new/whitelist-regex-support

Browse Source 
Add whitelist regex support
This commit is contained in:
DL6ER
2019-09-01 14:23:50 +02:00
committed by GitHub
parent fafbc4cc68 d97c85f724
commit bc4f508970
11 changed files with 569 additions and 232 deletions
Download Patch File Download Diff File Expand all files Collapse all files
list.php
+3 -11
View File
@@ -35,13 +35,9 @@ function getFullName() {
<div class="form-group input-group">
<input id="domain" type="text" class="form-control" placeholder="Add a domain (example.com or sub.example.com)">
<span class="input-group-btn">
<?php if($list === "black") { ?>
<button id="btnAdd" class="btn btn-default" type="button">Add (exact)</button>
<button id="btnAddWildcard" class="btn btn-default" type="button">Add (wildcard)</button>
<button id="btnAddRegex" class="btn btn-default" type="button">Add (regex)</button>
<?php }else{ ?>
<button id="btnAdd" class="btn btn-default" type="button">Add</button>
<?php } ?>
<button id="btnRefresh" class="btn btn-default" type="button"><i class="fa fa-sync"></i></button>
</span>
</div>
@@ -53,7 +49,7 @@ function getFullName() {
</div>
<div id="alSuccess" class="alert alert-success alert-dismissible fade in" role="alert" hidden="true">
<button type="button" class="close" data-hide="alert" aria-label="Close"><span aria-hidden="true">&times;</span></button>
Success! The list will refresh.
<span id="success-message"></span>
</div>
<div id="alFailure" class="alert alert-danger alert-dismissible fade in" role="alert" hidden="true">
<button type="button" class="close" data-hide="alert" aria-label="Close"><span aria-hidden="true">&times;</span></button>
@@ -66,14 +62,10 @@ function getFullName() {
<!-- Domain List -->
<?php if($list === "black") { ?>
<h3>Exact blocking</h3>
<?php } ?>
<h3 id="h3-exact" hidden="true">Exact blocking</h3>
<ul class="list-group" id="list"></ul>
<?php if($list === "black") { ?>
<h3><a href="https://docs.pi-hole.net/ftldns/regex/overview/" target="_blank" title="Click for Pi-hole Regex documentation">Regex</a> &amp; Wildcard blocking</h3>
<h3 id="h3-regex" hidden="true"><a href="https://docs.pi-hole.net/ftldns/regex/overview/" target="_blank" title="Click for Pi-hole Regex documentation">Regex</a> &amp; Wildcard blocking</h3>
<ul class="list-group" id="list-regex"></ul>
<?php } ?>
<script src="scripts/pi-hole/js/list.js"></script>
scripts/pi-hole/js/auditlog.js
+3 -1
View File
@@ -78,7 +78,7 @@ function add(domain,list) {
$.ajax({
url: "scripts/pi-hole/php/add.php",
method: "post",
data: {"domain":domain, "list":list, "token":token, "auditlog":1}
data: {"domain":domain, "list":list, "token":token}
});
}
@@ -91,6 +91,7 @@ $(document).ready(function() {
var url = ($(this).parents("tr"))[0].innerText.split(" ")[0];
if($(this).context.innerText === " Blacklist")
{
add(url,"audit");
add(url,"black");
$("#gravityBtn").prop("disabled", false);
}
@@ -104,6 +105,7 @@ $(document).ready(function() {
var url = ($(this).parents("tr"))[0].innerText.split(" ")[0].split(" ")[0];
if($(this).context.innerText === " Whitelist")
{
add(url,"audit");
add(url,"white");
$("#gravityBtn").prop("disabled", false);
}
scripts/pi-hole/js/list.js
+87 -74
View File
@@ -43,18 +43,11 @@ function addListEntry(entry, index, list, button, type)
}
function refresh(fade) {
var listw;
var list = $("#list");
if(listType === "black")
{
listw = $("#list-regex");
}
var listw = $("#list-regex");
if(fade) {
list.fadeOut(100);
if(listw)
{
listw.fadeOut(100);
}
listw.fadeOut(100);
}
$.ajax({
url: "scripts/pi-hole/php/get.php",
@@ -62,49 +55,51 @@ function refresh(fade) {
data: {"list":listType},
success: function(response) {
list.html("");
if(listw)
{
listw.html("");
}
listw.html("");
if((listType === "black" &&
response.blacklist.length === 0 &&
response.regex.length === 0) ||
response.regex_blacklist.length === 0) ||
(listType === "white" &&
response.whitelist.length === 0))
response.whitelist.length === 0 &&
response.regex_whitelist.length === 0))
{
$("h3").hide();
list.html("<div class=\"alert alert-info\" role=\"alert\">Your " + fullName + " is empty!</div>");
}
else
{
$("h3").show();
if(listType === "white")
{
data = response.whitelist.sort();
data2 = []; // No regex data, use empty array
data2 = response.regex_whitelist.sort();
}
else if(listType === "black")
{
data = response.blacklist.sort();
data2 = response.regex.sort();
data2 = response.regex_blacklist.sort();
}
if(data.length > 0)
{
$("#h3-exact").fadeIn(100);
}
if(data2.length > 0)
{
$("#h3-regex").fadeIn(100);
}
data.forEach(function (entry, index)
{
addListEntry(entry, index, list, "#list", "exact");
});
// Add regex domains if present in returned list data
data2.forEach(function (entry, index)
{
addListEntry(entry, index, listw, "#list-regex", "regex");
addListEntry(entry, index, listw, "#list-regex", listType+"_regex");
});
}
list.fadeIn(100);
if(listw)
{
listw.fadeIn(100);
}
listw.fadeIn(100);
},
error: function(jqXHR, exception) {
$("#alFailure").show();
@@ -115,23 +110,55 @@ function refresh(fade) {
window.onload = refresh(false);
function sub(index, entry, arg) {
var domain = $("#list #"+index);
var list = "#list";
var heading = "#h3-exact";
var locallistType = listType;
if(arg === "regex")
if(arg === "black_regex" || arg === "white_regex")
{
locallistType = "regex";
domain = $("#list-regex #"+index);
list = "#list-regex";
heading = "#h3-regex";
locallistType = arg;
}
var alInfo = $("#alInfo");
var alSuccess = $("#alSuccess");
var alFailure = $("#alFailure");
var alWarning = $("#alWarning");
var err = $("#err");
var warn = $("#warn");
var msg = $("#success-message");
var domain = $(list+" #"+index);
domain.hide("highlight");
$.ajax({
url: "scripts/pi-hole/php/sub.php",
method: "post",
data: {"domain":entry, "list":locallistType, "token":token},
success: function(response) {
if(response.length !== 0){
return;
if (response.indexOf("Success") === -1) {
alFailure.show();
err.html(response);
alFailure.delay(8000).fadeOut(2000, function() {
alFailure.hide();
});
alInfo.delay(8000).fadeOut(2000, function() {
alInfo.hide();
});
} else {
alSuccess.show();
msg.html(response);
alSuccess.delay(1000).fadeOut(2000, function() {
alSuccess.hide();
});
alInfo.delay(1000).fadeOut(2000, function() {
alInfo.hide();
});
domain.remove();
if($(list+" li").length < 1)
{
$(heading).fadeOut(100);
}
}
domain.remove();
},
error: function(jqXHR, exception) {
alert("Failed to remove the domain!");
@@ -140,18 +167,11 @@ function sub(index, entry, arg) {
});
}
function add(arg) {
var locallistType = listType;
function add(type) {
var domain = $("#domain");
var wild = false;
if(domain.val().length === 0){
return;
}
if(arg === "wild" || arg === "regex")
{
locallistType = arg;
wild = true;
}
var alInfo = $("#alInfo");
var alSuccess = $("#alSuccess");
@@ -159,6 +179,7 @@ function add(arg) {
var alWarning = $("#alWarning");
var err = $("#err");
var warn = $("#warn");
var msg = $("#success-message");
alInfo.show();
alSuccess.hide();
alFailure.hide();
@@ -166,37 +187,29 @@ function add(arg) {
$.ajax({
url: "scripts/pi-hole/php/add.php",
method: "post",
data: {"domain":domain.val().trim(), "list":locallistType, "token":token},
data: {"domain":domain.val().trim(), "list":type, "token":token},
success: function(response) {
if (response.indexOf(" already exists in ") !== -1) {
alWarning.show();
warn.html(response);
alWarning.delay(8000).fadeOut(2000, function() {
alWarning.hide();
});
alInfo.delay(8000).fadeOut(2000, function() {
alInfo.hide();
});
} else if (response.indexOf("DONE") === -1) {
alFailure.show();
err.html(response);
alFailure.delay(8000).fadeOut(2000, function() {
alFailure.hide();
});
alInfo.delay(8000).fadeOut(2000, function() {
alInfo.hide();
});
} else {
alSuccess.show();
alSuccess.delay(1000).fadeOut(2000, function() {
alSuccess.hide();
});
alInfo.delay(1000).fadeOut(2000, function() {
alInfo.hide();
});
domain.val("");
refresh(true);
}
if (response.indexOf("Success") === -1) {
alFailure.show();
err.html(response);
alFailure.delay(8000).fadeOut(2000, function() {
alFailure.hide();
});
alInfo.delay(8000).fadeOut(2000, function() {
alInfo.hide();
});
} else {
alSuccess.show();
msg.html(response);
alSuccess.delay(1000).fadeOut(2000, function() {
alSuccess.hide();
});
alInfo.delay(1000).fadeOut(2000, function() {
alInfo.hide();
});
domain.val("");
refresh(true);
}
},
error: function(jqXHR, exception) {
alFailure.show();
@@ -217,21 +230,21 @@ function add(arg) {
$(document).keypress(function(e) {
if(e.which === 13 && $("#domain").is(":focus")) {
// Enter was pressed, and the input has focus
add("exact");
add(listType);
}
});
// Handle buttons
$("#btnAdd").on("click", function() {
add("exact");
add(listType);
});
$("#btnAddWildcard").on("click", function() {
add("wild");
add(listType+"_wild");
});
$("#btnAddRegex").on("click", function() {
add("regex");
add(listType+"_regex");
});
$("#btnRefresh").on("click", function() {
scripts/pi-hole/php/add.php
+46 -35
View File
@@ -8,51 +8,62 @@
require_once('auth.php');
$type = $_POST['list'];
$list = $_POST['list'];
// Perform all of the authentication for list editing
// when NOT invoked and authenticated from API
if (empty($api)) {
list_verify($type);
list_verify($list);
}
// Don't check if the added item is a valid domain for regex expressions. Regex
// filters are validated by FTL on import and skipped if invalid
if($type !== "regex") {
// Only check domains we add to the exact lists.
// Regex are validated by FTL during import
$check_lists = ["white","black","audit"];
if(in_array($list, $check_lists)) {
check_domain();
}
// Escape shell metacharacters
$domains = escapeshellcmd($_POST['domain']);
// Split individual domains into array
$domains = preg_split('/\s+/', trim($_POST['domain']));
switch($type) {
case "white":
if(!isset($_POST["auditlog"]))
echo shell_exec("sudo pihole -w --web ".$domains);
else
{
echo shell_exec("sudo pihole -w --web ".$domains);
echo shell_exec("sudo pihole -a audit ".$domains);
}
break;
case "black":
if(!isset($_POST["auditlog"]))
echo shell_exec("sudo pihole -b --web ".$domains);
else
{
echo shell_exec("sudo pihole -b --web ".$domains);
echo shell_exec("sudo pihole -a audit ".$domains);
}
break;
case "regex":
echo shell_exec("sudo pihole --regex --web ".$domains);
break;
case "wild":
echo shell_exec("sudo pihole --wild --web ".$domains);
break;
case "audit":
echo shell_exec("sudo pihole -a audit ".$domains);
break;
require_once("func.php");
require_once("database.php");
$GRAVITYDB = getGravityDBFilename();
$db = SQLite3_connect($GRAVITYDB, SQLITE3_OPEN_READWRITE);
switch($list) {
case "white":
echo add_to_table($db, "whitelist", $domains);
break;
case "black":
echo add_to_table($db, "blacklist", $domains);
break;
case "black_regex":
echo add_to_table($db, "regex_blacklist", $domains);
break;
case "white_regex":
echo add_to_table($db, "regex_whitelist", $domains);
break;
case "black_wild":
echo add_to_table($db, "regex_blacklist", $domains, true);
break;
case "white_wild":
echo add_to_table($db, "regex_whitelist", $domains, true);
break;
case "audit":
echo add_to_table($db, "domain_audit", $domains);
break;
default:
die("Invalid list!");
}
// Reload lists in pihole-FTL after having added something
echo shell_exec("sudo pihole restartdns reload");
?>
scripts/pi-hole/php/auth.php
-1
View File
@@ -11,7 +11,6 @@ $ERRORLOG = getenv('PHP_ERROR_LOG');
if (empty($ERRORLOG)) {
$ERRORLOG = '/var/log/lighttpd/error.log';
}
$regexfile = "/etc/pihole/regex.list";
function pi_log($message) {
error_log(date('Y-m-d H:i:s') . ': ' . $message . "\n", 3, $GLOBALS['ERRORLOG']);
scripts/pi-hole/php/database.php
+174
View File
@@ -52,6 +52,180 @@ function SQLite3_connect($filename, $mode=SQLITE3_OPEN_READONLY)
{
die("Error connecting to database");
}
// Add busy timeout so methods don't fail immediately when, e.g., FTL is currently reading from the DB
$db->busyTimeout(5000);
return $db;
}
/**
* Add domains to a given table
*
* @param $db object The SQLite3 database connection object
* @param $table string The target table
* @param $domains array Array of domains (strings) to be added to the table
* @param $wildcardstyle boolean Whether to format the input domains in legacy wildcard notation
* @param $returnnum boolean Whether to return an integer or a string
* @return string Success/error and number of processed domains
*/
function add_to_table($db, $table, $domains, $wildcardstyle=false, $returnnum=false)
{
// Begin transaction
if(!$db->exec("BEGIN TRANSACTION;"))
{
if($returnnum)
return 0;
else
return "Error: Unable to begin transaction for ".$table." table.";
}
$initialcount = intval($db->querySingle("SELECT COUNT(*) FROM ".$table.";"));
// Prepare SQLite statememt
$stmt = $db->prepare("INSERT OR IGNORE INTO ".$table." (domain) VALUES (:domain);");
// Return early if we failed to prepare the SQLite statement
if(!$stmt)
{
if($returnnum)
return 0;
else
return "Error: Failed to prepare statement for ".$table." table.";
}
// Loop over domains and inject the lines into the database
$num = 0;
foreach($domains as $domain)
{
// Limit max length for a domain entry to 253 chars
if(strlen($domain) > 253)
continue;
if($wildcardstyle)
$domain = "(\\.|^)".str_replace(".","\\.",$domain)."$";
$stmt->bindValue(":domain", $domain, SQLITE3_TEXT);
if($stmt->execute() && $stmt->reset())
$num++;
else
{
$stmt->close();
if($returnnum)
return $num;
else
{
if($num === 1)
$plural = "";
else
$plural = "s";
return "Error: ".$db->lastErrorMsg().", added ".$num." domain".$plural;
}
}
}
// Close prepared statement and return number of processed rows
$stmt->close();
$db->exec("COMMIT;");
if($returnnum)
return $num;
else
{
$finalcount = intval($db->querySingle("SELECT COUNT(*) FROM ".$table.";"));
$modified = $finalcount - $initialcount;
// If we add less domains than the user specified, then they wanted to add duplicates
if($modified !== $num)
{
$delta = $num - $modified;
$extra = " (skipped ".$delta." duplicates)";
}
else
{
$extra = "";
}
if($num === 1)
$plural = "";
else
$plural = "s";
return "Success, added ".$modified." of ".$num." domain".$plural.$extra;
}
}
/**
* Remove domains from a given table
*
* @param $db object The SQLite3 database connection object
* @param $table string The target table
* @param $domains array Array of domains (strings) to be removed from the table
* @param $returnnum boolean Whether to return an integer or a string
* @return string Success/error and number of processed domains
*/
function remove_from_table($db, $table, $domains, $returnnum=false)
{
// Begin transaction
if(!$db->exec("BEGIN TRANSACTION;"))
{
if($returnnum)
return 0;
else
return "Error: Unable to begin transaction for ".$table." table.";
}
$initialcount = intval($db->querySingle("SELECT COUNT(*) FROM ".$table.";"));
// Prepare SQLite statememt
$stmt = $db->prepare("DELETE FROM ".$table." WHERE domain = :domain;");
// Return early if we failed to prepare the SQLite statement
if(!$stmt)
{
if($returnnum)
return 0;
else
return "Error: Failed to prepare statement for ".$table." table.";
}
// Loop over domains and remove the lines from the database
$num = 0;
foreach($domains as $domain)
{
$stmt->bindValue(":domain", $domain, SQLITE3_TEXT);
if($stmt->execute() && $stmt->reset())
$num++;
else
{
$stmt->close();
if($returnnum)
return $num;
else
{
if($num === 1)
$plural = "";
else
$plural = "s";
return "Error: ".$db->lastErrorMsg().", removed ".$num." domain".$plural;
}
}
}
// Close prepared statement and return number or processed rows
$stmt->close();
$db->exec("COMMIT;");
if($returnnum)
return $num;
else
{
if($num === 1)
$plural = "";
else
$plural = "s";
return "Success, removed ".$num." domain".$plural;
}
}
?>
scripts/pi-hole/php/func.php
-17
View File
@@ -45,21 +45,4 @@ if(!function_exists('hash_equals')) {
}
}
function add_regex($regex, $mode=FILE_APPEND, $append="\n")
{
global $regexfile;
if(file_put_contents($regexfile, $regex.$append, $mode) === FALSE)
{
$err = error_get_last()["message"];
echo "Unable to add regex \"".htmlspecialchars($regex)."\" to ${regexfile}<br>Error message: $err";
}
else
{
// Send SIGHUP to pihole-FTL using a frontend command
// to force reloading of the regex domains
// This will also wipe the resolver's cache
echo exec("sudo pihole restartdns reload");
}
}
?>
scripts/pi-hole/php/get.php
+6 -4
View File
@@ -21,7 +21,7 @@ function getTableContent($listname) {
global $db;
$entries = array();
$querystr = implode(" ",array("SELECT ${listname}.*,\"group\".enabled as group_enabled",
"FROM $listname",
"FROM ${listname}",
"LEFT JOIN ${listname}_by_group ON ${listname}_by_group.${listname}_id = ${listname}.id",
"LEFT JOIN \"group\" ON \"group\".id = ${listname}_by_group.group_id",
"GROUP BY domain;"));
@@ -54,13 +54,15 @@ function filterArray(&$inArray) {
switch ($listtype)
{
case "white":
$list = getTableContent("whitelist");
$exact = getTableContent("whitelist");
$regex = getTableContent("regex_whitelist");
$list = array_merge($exact, $regex);
break;
case "black":
$exact = getTableContent("blacklist");
$regex = getTableContent("regex");
$list = array_merge($exact, $regex);
$regex = getTableContent("regex_blacklist");
$list = array_merge($exact, $regex);
break;
default:
scripts/pi-hole/php/sub.php
+27 -16
View File
@@ -16,25 +16,36 @@ if (empty($api)) {
list_verify($type);
}
// Don't check if the added item is a valid domain for regex expressions.
// Regex filters are validated by FTL on import and skipped if invalid
if($type !== "regex") {
check_domain();
}
// Split individual domains into array
$domains = preg_split('/\s+/', trim($_POST['domain']));
// Escape shell metacharacters
$domain = escapeshellcmd($_POST['domain']);
require_once("func.php");
require("database.php");
$GRAVITYDB = getGravityDBFilename();
$db = SQLite3_connect($GRAVITYDB, SQLITE3_OPEN_READWRITE);
switch($type) {
case "white":
exec("sudo pihole -w -q -d ".$domain);
break;
case "black":
exec("sudo pihole -b -q -d ".$domain);
break;
case "regex":
exec("sudo pihole --regex -q -d ".$domain);
break;
case "white":
echo remove_from_table($db, "whitelist", $domains);
break;
case "black":
echo remove_from_table($db, "blacklist", $domains);
break;
case "black_regex":
echo remove_from_table($db, "regex_blacklist", $domains);
break;
case "white_regex":
echo remove_from_table($db, "regex_whitelist", $domains);
break;
default:
die("Invalid list!");
}
// Reload lists in pihole-FTL after having removed something
echo shell_exec("sudo pihole restartdns reload");
?>
scripts/pi-hole/php/teleporter.php
+206 -71
View File
@@ -15,7 +15,9 @@ if (php_sapi_name() !== "cli") {
check_csrf(isset($_POST["token"]) ? $_POST["token"] : "");
}
$db = SQLite3_connect(getGravityDBFilename());
$db = SQLite3_connect(getGravityDBFilename(), SQLITE3_OPEN_READWRITE);
$flushed_tables = array();
function archive_add_file($path,$name,$subdir="")
{
@@ -29,20 +31,153 @@ function archive_add_file($path,$name,$subdir="")
*
* @param $name string The name of the file in the archive to save the table to
* @param $table string The table to export
* @param $column string The column on the table to export
*/
function archive_add_table($name, $table, $column)
function archive_add_table($name, $table)
{
global $archive, $db;
$results = $db->query("SELECT $column FROM $table");
$content = "";
$results = $db->query("SELECT * FROM $table");
while($row = $results->fetchArray()) {
$content .= $row[0]."\n";
// Return early without creating a file if the
// requested table cannot be accessed
if(is_null($results))
return;
$content = array();
while ($row = $results->fetchArray(SQLITE3_ASSOC))
{
array_push($content, $row);
}
$archive[$name] = $content;
$archive[$name] = json_encode($content);
}
/**
* Restore the contents of a table from an uploaded archive
*
* @param $file object The file in the archive to restore the table from
* @param $table string The table to import
* @param $flush boolean Whether to flush the table before importing the archived data
* @return integer Number of restored rows
*/
function archive_restore_table($file, $table, $flush=false)
{
global $db, $flushed_tables;
$json_string = file_get_contents($file);
// Return early if we cannot extract the JSON string
if(is_null($json_string))
return 0;
$contents = json_decode($json_string, true);
// Return early if we cannot decode the JSON string
if(is_null($contents))
return 0;
// Flush table if requested, only flush each table once
if($flush && !in_array($table, $flushed_tables))
{
$db->exec("DELETE FROM ".$table);
array_push($flushed_tables, $table);
}
// Prepare field name for domain/address depending on the table we restore to
if($table === "adlist")
{
$sql = "INSERT OR IGNORE INTO adlist";
$sql .= " (id,address,enabled,date_added,comment)";
$sql .= " VALUES (:id,:address,:enabled,:date_added,:comment);";
$field = "address";
}
elseif($table === "domain_audit")
{
$sql = "INSERT OR IGNORE INTO domain_audit";
$sql .= " (id,domain,date_added)";
$sql .= " VALUES (:id,:domain,:date_added);";
$field = "domain";
}
else
{
$sql = "INSERT OR IGNORE INTO ".$table;
$sql .= " (id,domain,enabled,date_added,comment)";
$sql .= " VALUES (:id,:domain,:enabled,:date_added,:comment);";
$field = "domain";
}
// Prepare SQLite statememt
$stmt = $db->prepare($sql);
// Return early if we fail to prepare the SQLite statement
if(!$stmt)
{
echo "Failed to prepare statement for ".$table." table.";
echo $sql;
return 0;
}
// Loop over rows and inject the entries into the database
$num = 0;
foreach($contents as $row)
{
// Limit max length for a domain entry to 253 chars
if(strlen($row[$field]) > 253)
continue;
$stmt->bindValue(":id", $row["id"], SQLITE3_INTEGER);
$stmt->bindValue(":date_added", $row["date_added"], SQLITE3_INTEGER);
$stmt->bindValue(":".$field, $row[$field], SQLITE3_TEXT);
if($table !== "domain_audit")
{
$stmt->bindValue(":enabled", $row["enabled"], SQLITE3_INTEGER);
if(is_null($row["comment"]))
$type = SQLITE3_NULL;
else
$type = SQLITE3_TEXT;
$stmt->bindValue(":comment", $row["comment"], $type);
}
if($stmt->execute() && $stmt->reset() && $stmt->clear())
$num++;
else
{
$stmt->close();
return $num;
}
}
// Close database connection and return number or processed rows
$stmt->close();
return $num;
}
/**
* Create table rows from an uploaded archive file
*
* @param $file object The file of the file in the archive to import
* @param $table string The target table
* @param $flush boolean Whether to flush the table before importing the archived data
* @param $wildcardstyle boolean Whether to format the input domains in legacy wildcard notation
* @return integer Number of processed rows from the imported file
*/
function archive_insert_into_table($file, $table, $flush=false, $wildcardstyle=false)
{
global $db, $flushed_tables;
$domains = array_filter(explode("\n",file_get_contents($file)));
// Return early if we cannot extract the lines in the file
if(is_null($domains))
return 0;
// Flush table if requested, only flush each table once
if($flush && !in_array($table, $flushed_tables))
{
$db->exec("DELETE FROM ".$table);
array_push($flushed_tables, $table);
}
// Add domains to requested table
return add_to_table($db, $table, $domains, $wildcardstyle, true);
}
function archive_add_directory($path,$subdir="")
@@ -60,40 +195,6 @@ function archive_add_directory($path,$subdir="")
}
}
function limit_length(&$item, $key)
{
// limit max length for a domain entry to 253 chars
// return only a part of the string if it is longer
$item = substr($item, 0, 253);
}
function process_file($contents,$check=True)
{
$domains = array_filter(explode("\n",$contents));
// Walk array and apply a max string length
// function to every member of the array of domains
array_walk($domains, "limit_length");
// Check validity of domains (don't do it for regex filters)
if($check)
{
check_domains($domains);
}
return $domains;
}
function check_domains($domains)
{
foreach($domains as $domain)
{
if(!is_valid_domain_name($domain)){
die(htmlspecialchars($domain).' is not a valid domain');
}
}
}
if(isset($_POST["action"]))
{
if($_FILES["zip_file"]["name"] && $_POST["action"] == "in")
@@ -127,59 +228,92 @@ if(isset($_POST["action"]))
$importedsomething = false;
$flushtables = isset($_POST["flushtables"]);
foreach($archive as $file)
{
if(isset($_POST["blacklist"]) && $file->getFilename() === "blacklist.txt")
{
$blacklist = process_file(file_get_contents($file));
echo "Processing blacklist.txt (".count($blacklist)." entries)<br>\n";
exec("sudo pihole -b -nr --nuke");
exec("sudo pihole -b -q -nr ".implode(" ", $blacklist));
$num = archive_insert_into_table($file, "blacklist", $flushtables);
echo "Processed blacklist (exact) (".$num." entries)<br>\n";
$importedsomething = true;
}
if(isset($_POST["whitelist"]) && $file->getFilename() === "whitelist.txt")
{
$whitelist = process_file(file_get_contents($file));
echo "Processing whitelist.txt (".count($whitelist)." entries)<br>\n";
exec("sudo pihole -w -nr --nuke");
exec("sudo pihole -w -q -nr ".implode(" ", $whitelist));
$num = archive_insert_into_table($file, "whitelist", $flushtables);
echo "Processed whitelist (exact) (".$num." entries)<br>\n";
$importedsomething = true;
}
if(isset($_POST["regexlist"]) && $file->getFilename() === "regex.list")
{
$regexlist = process_file(file_get_contents($file),false);
echo "Processing regex.list (".count($regexlist)." entries)<br>\n";
$escapedRegexlist = array_map("escapeshellcmd", $regexlist);
exec("sudo pihole --regex -nr --nuke");
exec("sudo pihole --regex -q -nr ".implode(" ", $escapedRegexlist));
$num = archive_insert_into_table($file, "regex_blacklist", $flushtables);
echo "Processed blacklist (regex) (".$num." entries)<br>\n";
$importedsomething = true;
}
// Also try to import legacy wildcard list if found
if(isset($_POST["regexlist"]) && $file->getFilename() === "wildcardblocking.txt")
{
$wildlist = process_file(file_get_contents($file));
echo "Processing wildcardblocking.txt (".count($wildlist)." entries)<br>\n";
exec("sudo pihole --wild -nr --nuke");
exec("sudo pihole --wild -q -nr ".implode(" ", $wildlist));
$num = archive_insert_into_table($file, "regex_blacklist", $flushtables, true);
echo "Processed blacklist (regex, wildcard style) (".$num." entries)<br>\n";
$importedsomething = true;
}
if(isset($_POST["auditlog"]) && $file->getFilename() === "auditlog.list")
{
$auditlog = process_file(file_get_contents($file));
echo "Processing auditlog.list (".count($auditlog)." entries)<br>\n";
exec("sudo pihole -a clearaudit");
exec("sudo pihole -a audit ".implode(" ",$auditlog));
$num = archive_insert_into_table($file, "domain_audit", $flushtables);
echo "Processed blacklist (regex) (".$num." entries)<br>\n";
$importedsomething = true;
}
if($importedsomething)
if(isset($_POST["blacklist"]) && $file->getFilename() === "blacklist.exact.json")
{
exec("sudo pihole restartdns");
$num = archive_restore_table($file, "blacklist", $flushtables);
echo "Processed blacklist (exact) (".$num." entries)<br>\n";
$importedsomething = true;
}
if(isset($_POST["regexlist"]) && $file->getFilename() === "blacklist.regex.json")
{
$num = archive_restore_table($file, "regex_blacklist", $flushtables);
echo "Processed blacklist (regex) (".$num." entries)<br>\n";
$importedsomething = true;
}
if(isset($_POST["whitelist"]) && $file->getFilename() === "whitelist.exact.json")
{
$num = archive_restore_table($file, "whitelist", $flushtables);
echo "Processed whitelist (exact) (".$num." entries)<br>\n";
$importedsomething = true;
}
if(isset($_POST["regex_whitelist"]) && $file->getFilename() === "whitelist.regex.json")
{
$num = archive_restore_table($file, "regex_whitelist", $flushtables);
echo "Processed whitelist (regex) (".$num." entries)<br>\n";
$importedsomething = true;
}
if(isset($_POST["adlist"]) && $file->getFilename() === "adlist.json")
{
$num = archive_restore_table($file, "adlist", $flushtables);
echo "Processed adlist (".$num." entries)<br>\n";
$importedsomething = true;
}
if(isset($_POST["auditlog"]) && $file->getFilename() === "domain_audit.json")
{
$num = archive_restore_table($file, "domain_audit", $flushtables);
echo "Processed domain_audit (".$num." entries)<br>\n";
$importedsomething = true;
}
}
if($importedsomething)
{
exec("sudo pihole restartdns reload");
}
unlink($fullfilename);
@@ -201,12 +335,13 @@ else
exit("cannot open/create ".htmlentities($archive_file_name)."<br>\nPHP user: ".exec('whoami')."\n");
}
archive_add_table("whitelist.txt", "whitelist", "domain");
archive_add_table("blacklist.txt", "blacklist", "domain");
archive_add_table("regex.list", "regex", "domain");
archive_add_table("adlists.list", "adlist", "address");
archive_add_table("whitelist.exact.json", "whitelist");
archive_add_table("whitelist.regex.json", "regex_whitelist");
archive_add_table("blacklist.exact.json", "blacklist");
archive_add_table("blacklist.regex.json", "regex_blacklist");
archive_add_table("adlists.json", "adlist");
archive_add_table("domain_audit.json", "domain_audit");
archive_add_file("/etc/pihole/","setupVars.conf");
archive_add_file("/etc/pihole/","auditlog.list");
archive_add_directory("/etc/dnsmasq.d/","dnsmasq.d/");
$archive->compress(Phar::GZ); // Creates a gziped copy
settings.php
+17 -2
View File
@@ -1145,7 +1145,12 @@ if (isset($_GET['tab']) && in_array($_GET['tab'], array("sysadmin", "blocklists"
<div class="checkbox">
<label><input type="checkbox" name="whitelist" value="true"
checked>
Whitelist</label>
Whitelist (exact)</label>
</div>
<div class="checkbox">
<label><input type="checkbox" name="regex_whitelist" value="true"
checked>
Whitelist (regex)</label>
</div>
<div class="checkbox">
<label><input type="checkbox" name="blacklist" value="true"
@@ -1155,7 +1160,12 @@ if (isset($_GET['tab']) && in_array($_GET['tab'], array("sysadmin", "blocklists"
<div class="checkbox">
<label><input type="checkbox" name="regexlist" value="true"
checked>
Regex filters</label>
Blacklist (regex)</label>
</div>
<div class="checkbox">
<label><input type="checkbox" name="adlist" value="true"
checked>
Blocklists</label>
</div>
<div class="checkbox">
<label><input type="checkbox" name="auditlog" value="true"
@@ -1172,6 +1182,11 @@ if (isset($_GET['tab']) && in_array($_GET['tab'], array("sysadmin", "blocklists"
<button type="submit" class="btn btn-default" name="action"
value="in">Import
</button>
<div class="checkbox">
<label><input type="checkbox" name="flushtables" value="true"
checked>
Clear existing data</label>
</div>
</div>
</div>
</div>