mirror of
https://github.com/pi-hole/web.git
synced 2024-12-06 19:36:21 +01:00
Calling FTL API directly from PHP
- Using constants for default values - Remove unnecessary variable - Replace `piholeStatusAPI()` with a call to FTL API - Transfer `api.php?status` code from `api.php` to `api_FTL.php` - Change `piholeStatus()` to use FTL info (no need to use `pihole`). Signed-off-by: RD WebDesign <github@rdwebdesign.com.br>
This commit is contained in:
RD WebDesign
+20
-10
@@ -583,7 +583,7 @@ function updateForwardDestinationsPie() {
|
||||
}
|
||||
|
||||
function updateTopClientsChart() {
|
||||
$.getJSON("api.php?summaryRaw&getQuerySources&topClientsBlocked", function (data) {
|
||||
$.getJSON("api.php?getQuerySources&topClientsBlocked", function (data) {
|
||||
if ("FTLnotrunning" in data) {
|
||||
return;
|
||||
}
|
||||
@@ -618,12 +618,14 @@ function updateTopClientsChart() {
|
||||
'">' +
|
||||
clientname +
|
||||
"</a>";
|
||||
percentage = (data.top_sources[client] / data.dns_queries_today) * 100;
|
||||
percentage = (data.top_sources[client] / summary.dns_queries_today) * 100;
|
||||
clienttable.append(
|
||||
"<tr> " +
|
||||
utils.addTD(url) +
|
||||
utils.addTD(data.top_sources[client]) +
|
||||
utils.addTD(utils.colorBar(percentage, data.dns_queries_today, "progress-bar-blue")) +
|
||||
utils.addTD(
|
||||
utils.colorBar(percentage, summary.dns_queries_today, "progress-bar-blue")
|
||||
) +
|
||||
"</tr> "
|
||||
);
|
||||
}
|
||||
@@ -658,12 +660,14 @@ function updateTopClientsChart() {
|
||||
'">' +
|
||||
clientname +
|
||||
"</a>";
|
||||
percentage = (data.top_sources_blocked[client] / data.ads_blocked_today) * 100;
|
||||
percentage = (data.top_sources_blocked[client] / summary.ads_blocked_today) * 100;
|
||||
clientblockedtable.append(
|
||||
"<tr> " +
|
||||
utils.addTD(url) +
|
||||
utils.addTD(data.top_sources_blocked[client]) +
|
||||
utils.addTD(utils.colorBar(percentage, data.ads_blocked_today, "progress-bar-blue")) +
|
||||
utils.addTD(
|
||||
utils.colorBar(percentage, summary.ads_blocked_today, "progress-bar-blue")
|
||||
) +
|
||||
"</tr> "
|
||||
);
|
||||
}
|
||||
@@ -687,7 +691,7 @@ function updateTopClientsChart() {
|
||||
}
|
||||
|
||||
function updateTopLists() {
|
||||
$.getJSON("api.php?summaryRaw&topItems", function (data) {
|
||||
$.getJSON("api.php?topItems", function (data) {
|
||||
if ("FTLnotrunning" in data) {
|
||||
return;
|
||||
}
|
||||
@@ -709,12 +713,14 @@ function updateTopLists() {
|
||||
domain = utils.escapeHtml(domain);
|
||||
urlText = domain === "" ? "." : domain;
|
||||
url = '<a href="queries.php?domain=' + domain + '">' + urlText + "</a>";
|
||||
percentage = (data.top_queries[domain] / data.dns_queries_today) * 100;
|
||||
percentage = (data.top_queries[domain] / summary.dns_queries_today) * 100;
|
||||
domaintable.append(
|
||||
"<tr> " +
|
||||
utils.addTD(url) +
|
||||
utils.addTD(data.top_queries[domain]) +
|
||||
utils.addTD(utils.colorBar(percentage, data.dns_queries_today, "queries-permitted")) +
|
||||
utils.addTD(
|
||||
utils.colorBar(percentage, summary.dns_queries_today, "queries-permitted")
|
||||
) +
|
||||
"</tr> "
|
||||
);
|
||||
}
|
||||
@@ -736,12 +742,12 @@ function updateTopLists() {
|
||||
domain = utils.escapeHtml(domain);
|
||||
urlText = domain === "" ? "." : domain;
|
||||
url = '<a href="queries.php?domain=' + domain + '">' + urlText + "</a>";
|
||||
percentage = (data.top_ads[domain] / data.ads_blocked_today) * 100;
|
||||
percentage = (data.top_ads[domain] / summary.ads_blocked_today) * 100;
|
||||
adtable.append(
|
||||
"<tr> " +
|
||||
utils.addTD(url) +
|
||||
utils.addTD(data.top_ads[domain]) +
|
||||
utils.addTD(utils.colorBar(percentage, data.ads_blocked_today, "queries-blocked")) +
|
||||
utils.addTD(utils.colorBar(percentage, summary.ads_blocked_today, "queries-blocked")) +
|
||||
"</tr> "
|
||||
);
|
||||
}
|
||||
@@ -759,6 +765,7 @@ function updateTopLists() {
|
||||
});
|
||||
}
|
||||
|
||||
var summary;
|
||||
var FTLoffline = false;
|
||||
function updateSummaryData(runOnce) {
|
||||
var setTimer = function (timeInSeconds) {
|
||||
@@ -792,6 +799,9 @@ function updateSummaryData(runOnce) {
|
||||
updateTopLists();
|
||||
}
|
||||
|
||||
// use the same data to update all lists
|
||||
summary = data;
|
||||
|
||||
var formatter = new Intl.NumberFormat();
|
||||
//Element name might have a different name to the property of the API so we split it at |
|
||||
[
|
||||
|
||||
+70
-65
@@ -6,88 +6,93 @@
|
||||
* This file is copyright under the latest version of the EUPL.
|
||||
* Please see LICENSE file for your rights under this license. */
|
||||
|
||||
$piholeFTLConfFile = "/etc/pihole/pihole-FTL.conf";
|
||||
const DEFAULT_FTLCONFFILE = "/etc/pihole/pihole-FTL.conf";
|
||||
const DEFAULT_FTL_IP = "127.0.0.1";
|
||||
const DEFAULT_FTL_PORT = 4711;
|
||||
|
||||
function piholeFTLConfig($force=false)
|
||||
{
|
||||
static $piholeFTLConfig;
|
||||
global $piholeFTLConfFile;
|
||||
function piholeFTLConfig($piholeFTLConfFile = DEFAULT_FTLCONFFILE, $force = false) {
|
||||
static $piholeFTLConfig;
|
||||
|
||||
if(isset($piholeFTLConfig) && !$force)
|
||||
{
|
||||
return $piholeFTLConfig;
|
||||
}
|
||||
if (isset($piholeFTLConfig) && !$force) {
|
||||
return $piholeFTLConfig;
|
||||
}
|
||||
|
||||
if(is_readable($piholeFTLConfFile))
|
||||
{
|
||||
$piholeFTLConfig = parse_ini_file($piholeFTLConfFile);
|
||||
}
|
||||
else
|
||||
{
|
||||
$piholeFTLConfig = array();
|
||||
}
|
||||
if (is_readable($piholeFTLConfFile)) {
|
||||
$piholeFTLConfig = parse_ini_file($piholeFTLConfFile);
|
||||
} else {
|
||||
$piholeFTLConfig = array();
|
||||
}
|
||||
|
||||
return $piholeFTLConfig;
|
||||
return $piholeFTLConfig;
|
||||
}
|
||||
|
||||
function connectFTL($address, $port=4711)
|
||||
{
|
||||
if($address == "127.0.0.1")
|
||||
{
|
||||
$config = piholeFTLConfig();
|
||||
// Read port
|
||||
$portfileName = isset($config['PORTFILE']) ? $config['PORTFILE'] : '';
|
||||
if ($portfileName != '')
|
||||
{
|
||||
$portfileContents = file_get_contents($portfileName);
|
||||
if(is_numeric($portfileContents))
|
||||
$port = intval($portfileContents);
|
||||
}
|
||||
}
|
||||
function connectFTL($address, $port) {
|
||||
if ($address == DEFAULT_FTL_IP) {
|
||||
$config = piholeFTLConfig();
|
||||
// Read port
|
||||
$portfileName = isset($config['PORTFILE']) ? $config['PORTFILE'] : '';
|
||||
if ($portfileName != '') {
|
||||
$portfileContents = file_get_contents($portfileName);
|
||||
if (is_numeric($portfileContents)) {
|
||||
$port = intval($portfileContents);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Open Internet socket connection
|
||||
$socket = @fsockopen($address, $port, $errno, $errstr, 1.0);
|
||||
// Open Internet socket connection
|
||||
$socket = @fsockopen($address, $port, $errno, $errstr, 1.0);
|
||||
|
||||
return $socket;
|
||||
return $socket;
|
||||
}
|
||||
|
||||
function sendRequestFTL($requestin)
|
||||
{
|
||||
global $socket;
|
||||
|
||||
$request = ">".$requestin;
|
||||
fwrite($socket, $request) or die('{"error":"Could not send data to server"}');
|
||||
function sendRequestFTL($requestin, $socket) {
|
||||
$request = ">".$requestin;
|
||||
fwrite($socket, $request) or die('{"error":"Could not send data to server"}');
|
||||
}
|
||||
|
||||
function getResponseFTL()
|
||||
{
|
||||
global $socket;
|
||||
function getResponseFTL($socket) {
|
||||
$response = [];
|
||||
|
||||
$response = [];
|
||||
$errCount = 0;
|
||||
while (true) {
|
||||
$out = fgets($socket);
|
||||
if ($out == "") {
|
||||
$errCount++;
|
||||
}
|
||||
|
||||
$errCount = 0;
|
||||
while(true)
|
||||
{
|
||||
$out = fgets($socket);
|
||||
if ($out == "") $errCount++;
|
||||
if ($errCount > 100) {
|
||||
// Tried 100 times, but never got proper reply, fail to prevent busy loop
|
||||
die('{"error":"Tried 100 times to connect to FTL server, but never got proper reply. Please check Port and logs!"}');
|
||||
}
|
||||
if(strrpos($out,"---EOM---") !== false)
|
||||
break;
|
||||
if ($errCount > 100) {
|
||||
// Tried 100 times, but never got proper reply, fail to prevent busy loop
|
||||
die('{"error":"Tried 100 times to connect to FTL server, but never got proper reply. Please check Port and logs!"}');
|
||||
}
|
||||
|
||||
$out = rtrim($out);
|
||||
if(strlen($out) > 0)
|
||||
$response[] = $out;
|
||||
}
|
||||
if (strrpos($out,"---EOM---") !== false) {
|
||||
break;
|
||||
}
|
||||
|
||||
return $response;
|
||||
$out = rtrim($out);
|
||||
if (strlen($out) > 0) {
|
||||
$response[] = $out;
|
||||
}
|
||||
}
|
||||
|
||||
return $response;
|
||||
}
|
||||
|
||||
function disconnectFTL()
|
||||
{
|
||||
global $socket;
|
||||
fclose($socket);
|
||||
function disconnectFTL($socket) {
|
||||
fclose($socket);
|
||||
}
|
||||
|
||||
function callFTLAPI($request, $FTL_IP = DEFAULT_FTL_IP, $port = DEFAULT_FTL_PORT) {
|
||||
$socket = connectFTL($FTL_IP, $port);
|
||||
|
||||
if (!is_resource($socket)) {
|
||||
$data = array("FTLnotrunning" => true);
|
||||
} else {
|
||||
sendRequestFTL($request, $socket);
|
||||
$data = getResponseFTL($socket);
|
||||
}
|
||||
disconnectFTL($socket);
|
||||
|
||||
return $data;
|
||||
}
|
||||
?>
|
||||
|
||||
@@ -484,30 +484,33 @@ function getQueryTypeStr($querytype)
|
||||
}
|
||||
|
||||
// Returns an integer representing pihole blocking status
|
||||
function piholeStatus()
|
||||
{
|
||||
// Receive the return of "pihole status web"
|
||||
$pistatus = pihole_execute('status web');
|
||||
return isset($pistatus[0]) ? intval($pistatus[0]) : -2;
|
||||
}
|
||||
function piholeStatus() {
|
||||
// Retrieve DNS Port calling FTL API directly
|
||||
$port = callFTLAPI("dns-port");
|
||||
|
||||
// Returns pihole status, using only valid API responses (enabled/disabled)
|
||||
function piholeStatusAPI()
|
||||
{
|
||||
// Receive the return of "pihole status web"
|
||||
$pistatus = piholeStatus();
|
||||
// Retrieve FTL status
|
||||
$FTLstats = callFTLAPI("stats");
|
||||
|
||||
switch ($pistatus) {
|
||||
case -2: // Unkown
|
||||
case -1: // DNS service not running"
|
||||
case 0: // Offline
|
||||
$response = "disabled";
|
||||
break;
|
||||
|
||||
default:
|
||||
// DNS service running on port $returncode
|
||||
$response = "enabled";
|
||||
if (array_key_exists("FTLnotrunning", $port) || array_key_exists("FTLnotrunning", $FTLstats)){
|
||||
// FTL is not running
|
||||
$ret = -1;
|
||||
} elseif (in_array("status enabled", $FTLstats)) {
|
||||
// FTL is enabled
|
||||
if (intval($port[0]) <= 0) {
|
||||
// Port=0; FTL is not listening
|
||||
$ret = -1;
|
||||
} else {
|
||||
// FTL is running on this port
|
||||
$ret = intval($port[0]);
|
||||
}
|
||||
} elseif (in_array("status disabled", $FTLstats)) {
|
||||
// FTL is disabled
|
||||
$ret = 0;
|
||||
} else {
|
||||
// Unknown (unexpected) response
|
||||
$ret = -2;
|
||||
}
|
||||
return $response;
|
||||
|
||||
return $ret;
|
||||
}
|
||||
?>
|
||||
|
||||
Reference in New Issue
Block a user