From dbbc1a770b683a2387a57b23367468c26039b3f5 Mon Sep 17 00:00:00 2001 From: DL6ER Date: Fri, 16 Dec 2016 17:32:44 +0100 Subject: [PATCH 1/5] Add privacy mode --- data.php | 24 ++++++++++++++++++++---- js/pihole/index.js | 7 ++++++- php/savesettings.php | 9 +++++++++ settings.php | 13 +++++++++++++ 4 files changed, 48 insertions(+), 5 deletions(-) diff --git a/data.php b/data.php index 333907c02..064c5453f 100644 --- a/data.php +++ b/data.php @@ -5,6 +5,13 @@ $log = new \SplFileObject('/var/log/pihole.log'); $gravity = new \SplFileObject('/etc/pihole/list.preEventHorizon'); + if(isset($setupVars["API_PRIVACY_MODE"])) + { + $privacyMode = $setupVars["API_PRIVACY_MODE"]; + } else { + $privacyMode = false; + } + /******* Public Members ********/ function getSummaryData() { $domains_being_blocked = gravityCount(); @@ -52,12 +59,19 @@ function getOverTimeData10mins() { } function getTopItems() { - global $log; + global $log,$privacyMode; $dns_queries = getDnsQueries($log); $ads_blocked = getBlockedQueries($log); $topAds = topItems($ads_blocked); - $topQueries = topItems($dns_queries, $topAds); + if(!$privacyMode) + { + $topQueries = topItems($dns_queries, $topAds); + } + else + { + $topQueries = []; + } return Array( 'top_queries' => $topQueries, @@ -182,7 +196,7 @@ function setShowBlockedPermitted() } function getAllQueries($orderBy) { - global $log,$gravity,$showBlocked,$showPermitted; + global $log,$gravity,$showBlocked,$showPermitted,$privacyMode; $allQueries = array("data" => array()); $dns_queries = getDnsQueriesAll($log); $gravity_domains = getGravityDomains($gravity); @@ -198,7 +212,9 @@ function getAllQueries($orderBy) { if (substr($tmp, 0, 5) == "query") { $status = isset($gravity_domains[$domain]) ? "Pi-holed" : "OK"; - if(($status === "Pi-holed" && $showBlocked) || ($status === "OK" && $showPermitted)) + // Display blocked queries if $showBlocked is set + // Display permitted queries if $showPermitted is set and $privacyMode is disabled + if(($status === "Pi-holed" && $showBlocked) || ($status === "OK" && $showPermitted && !$privacyMode)) { $type = substr($exploded[count($exploded)-4], 6, -1); $client = $exploded[count($exploded)-1]; diff --git a/js/pihole/index.js b/js/pihole/index.js index 5d7dba0e9..b010e0707 100644 --- a/js/pihole/index.js +++ b/js/pihole/index.js @@ -180,7 +180,6 @@ function updateTopLists() { var domaintable = $("#domain-frequency").find("tbody:last"); var adtable = $("#ad-frequency").find("tbody:last"); var url, domain, percentage; - for (domain in data.top_queries) { if ({}.hasOwnProperty.call(data.top_queries,domain)){ // Sanitize domain @@ -198,8 +197,14 @@ function updateTopLists() { " " + data.top_queries[domain] + "
"); } + } + // Remove table if there are no results (e.g. privacy mode enabled) + if(jQuery.isEmptyObject(data.top_queries)) + { + $("#domain-frequency").parent().remove(); } + for (domain in data.top_ads) { if ({}.hasOwnProperty.call(data.top_ads,domain)){ // Sanitize domain diff --git a/php/savesettings.php b/php/savesettings.php index 27fa763ca..433c7f0f4 100644 --- a/php/savesettings.php +++ b/php/savesettings.php @@ -209,6 +209,15 @@ function validDomain($domain_name) $success .= "No entries will be shown in Query Log"; } + if(isset($_POST["privacyMode"])) + { + exec("sudo pihole -a privacymode true"); + } + else + { + exec("sudo pihole -a privacymode false"); + } + break; case "webUI": diff --git a/settings.php b/settings.php index ed2e7b0bf..2505e495f 100644 --- a/settings.php +++ b/settings.php @@ -379,6 +379,15 @@ } else { $queryLog = "all"; } + + // Privacy Mode + if(isset($setupVars["API_PRIVACY_MODE"])) + { + $privacyMode = $setupVars["API_PRIVACY_MODE"]; + } else { + $privacyMode = false; + } + ?>
@@ -405,6 +414,10 @@
+

Privacy mode

+
+
+
From 0c7857eed82030434cc2813862bf0f017805cecc Mon Sep 17 00:00:00 2001 From: DL6ER Date: Tue, 27 Dec 2016 22:11:21 +0000 Subject: [PATCH 2/5] Call function setShowBlockedPermitted() only once + immediately return empty array when nothing to be shown (don't show blocked entries + privacy Mode enabled) --- data.php | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/data.php b/data.php index 3a76e893f..feff19b1f 100644 --- a/data.php +++ b/data.php @@ -266,14 +266,20 @@ function getAllQueries($orderBy) { // Create empty array for gravity $gravity_domains = getGravity(); + setShowBlockedPermitted(); + + if(!$showBlocked && $privacyMode) + { + // Nothing to do for us here + return []; + } + foreach ($dns_queries as $query) { $time = date_create(substr($query, 0, 16)); $exploded = explode(" ", trim($query)); $domain = $exploded[count($exploded)-3]; $tmp = $exploded[count($exploded)-4]; - setShowBlockedPermitted(); - $status = isset($gravity_domains[$domain]) ? "Pi-holed" : "OK"; if(($status === "Pi-holed" && $showBlocked) || ($status === "OK" && $showPermitted)) { From 335977fc268bf6fc3d1d082b49c64743ca39e3c2 Mon Sep 17 00:00:00 2001 From: DL6ER Date: Tue, 27 Dec 2016 22:15:06 +0000 Subject: [PATCH 3/5] Fixed indentation + overwrite $showPermitted to false it privacy mode is enabled --- data.php | 66 +++++++++++++++++++++++++++++--------------------------- 1 file changed, 34 insertions(+), 32 deletions(-) diff --git a/data.php b/data.php index feff19b1f..cd42f69e9 100644 --- a/data.php +++ b/data.php @@ -23,7 +23,9 @@ if(isset($setupVars["API_PRIVACY_MODE"])) { $privacyMode = $setupVars["API_PRIVACY_MODE"]; - } else { + } + else + { $privacyMode = false; } @@ -268,7 +270,13 @@ function getAllQueries($orderBy) { setShowBlockedPermitted(); - if(!$showBlocked && $privacyMode) + // Privacy mode? + if($privacyMode) + { + $showPermitted = false; + } + + if(!$showBlocked && !$showPermitted) { // Nothing to do for us here return []; @@ -283,36 +291,30 @@ function getAllQueries($orderBy) { $status = isset($gravity_domains[$domain]) ? "Pi-holed" : "OK"; if(($status === "Pi-holed" && $showBlocked) || ($status === "OK" && $showPermitted)) { - $status = isset($gravity_domains[$domain]) ? "Pi-holed" : "OK"; - // Display blocked queries if $showBlocked is set - // Display permitted queries if $showPermitted is set and $privacyMode is disabled - if(($status === "Pi-holed" && $showBlocked) || ($status === "OK" && $showPermitted && !$privacyMode)) - { - $type = substr($exploded[count($exploded)-4], 6, -1); - $client = $exploded[count($exploded)-1]; - - if($orderBy == "orderByClientDomainTime"){ - $allQueries['data'][hasHostName($client)][$domain][$time->format('Y-m-d\TH:i:s')] = $status; - }elseif ($orderBy == "orderByClientTimeDomain"){ - $allQueries['data'][hasHostName($client)][$time->format('Y-m-d\TH:i:s')][$domain] = $status; - }elseif ($orderBy == "orderByTimeClientDomain"){ - $allQueries['data'][$time->format('Y-m-d\TH:i:s')][hasHostName($client)][$domain] = $status; - }elseif ($orderBy == "orderByTimeDomainClient"){ - $allQueries['data'][$time->format('Y-m-d\TH:i:s')][$domain][hasHostName($client)] = $status; - }elseif ($orderBy == "orderByDomainClientTime"){ - $allQueries['data'][$domain][hasHostName($client)][$time->format('Y-m-d\TH:i:s')] = $status; - }elseif ($orderBy == "orderByDomainTimeClient"){ - $allQueries['data'][$domain][$time->format('Y-m-d\TH:i:s')][hasHostName($client)] = $status; - }else{ - array_push($allQueries['data'], array( - $time->format('Y-m-d\TH:i:s'), - $type, - $domain, - hasHostName($client), - $status, - "" - )); - } + $type = substr($exploded[count($exploded)-4], 6, -1); + $client = $exploded[count($exploded)-1]; + + if($orderBy == "orderByClientDomainTime"){ + $allQueries['data'][hasHostName($client)][$domain][$time->format('Y-m-d\TH:i:s')] = $status; + }elseif ($orderBy == "orderByClientTimeDomain"){ + $allQueries['data'][hasHostName($client)][$time->format('Y-m-d\TH:i:s')][$domain] = $status; + }elseif ($orderBy == "orderByTimeClientDomain"){ + $allQueries['data'][$time->format('Y-m-d\TH:i:s')][hasHostName($client)][$domain] = $status; + }elseif ($orderBy == "orderByTimeDomainClient"){ + $allQueries['data'][$time->format('Y-m-d\TH:i:s')][$domain][hasHostName($client)] = $status; + }elseif ($orderBy == "orderByDomainClientTime"){ + $allQueries['data'][$domain][hasHostName($client)][$time->format('Y-m-d\TH:i:s')] = $status; + }elseif ($orderBy == "orderByDomainTimeClient"){ + $allQueries['data'][$domain][$time->format('Y-m-d\TH:i:s')][hasHostName($client)] = $status; + }else{ + array_push($allQueries['data'], array( + $time->format('Y-m-d\TH:i:s'), + $type, + $domain, + hasHostName($client), + $status, + "" + )); } } } From b7adabaa1ea333c250d4cdb27893e392e22614f9 Mon Sep 17 00:00:00 2001 From: DL6ER Date: Tue, 27 Dec 2016 22:21:28 +0000 Subject: [PATCH 4/5] More detailed messages on Settings page --- php/savesettings.php | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/php/savesettings.php b/php/savesettings.php index 53f3f8bf5..98352ce2e 100644 --- a/php/savesettings.php +++ b/php/savesettings.php @@ -212,12 +212,26 @@ function validDomain($domain_name) if(isset($_POST["querylog-permitted"]) && isset($_POST["querylog-blocked"])) { exec("sudo pihole -a setquerylog all"); - $success .= "All entries will be shown in Query Log"; + if(!isset($_POST["privacyMode"])) + { + $success .= "All entries will be shown in Query Log"; + } + else + { + $success .= "Only blocked entries will be shown in Query Log"; + } } elseif(isset($_POST["querylog-permitted"])) { exec("sudo pihole -a setquerylog permittedonly"); - $success .= "Only permitted will be shown in Query Log"; + if(!isset($_POST["privacyMode"])) + { + $success .= "Only permitted will be shown in Query Log"; + } + else + { + $success .= "No entries will be shown in Query Log"; + } } elseif(isset($_POST["querylog-blocked"])) { @@ -234,6 +248,7 @@ function validDomain($domain_name) if(isset($_POST["privacyMode"])) { exec("sudo pihole -a privacymode true"); + $success .= " (privacy mode enabled)"; } else { From a9dec4ba411029c777504adc1d1781631dff0786 Mon Sep 17 00:00:00 2001 From: DL6ER Date: Tue, 27 Dec 2016 22:23:56 +0000 Subject: [PATCH 5/5] Show that privacy mode is enabled --- queries.php | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/queries.php b/queries.php index 8907367f3..9403c3fba 100644 --- a/queries.php +++ b/queries.php @@ -29,6 +29,14 @@ } } +if(isset($setupVars["API_PRIVACY_MODE"])) +{ + if($setupVars["API_PRIVACY_MODE"]) + { + // Overwrite string from above + $showing = "(privacy mode enabled)"; + } +} ?>