62191b21b8
> Version 0.6 brings DashMachine one big step forward to being a finished product by adding a gui to edit the various settings in the config.ini. **Changelog** - improvements to /home including 'pinned' cards, multi-select tag filtering, 'action providers' allowing you to do web searches from the searchbar - rebuilt sidenav with list view, mirroring filter/search/collapse state of the homepage - /settings and /home now on same route - dynamic reloading of settings (no more page reloads) - dedicated config.ini editor slide-out - settings editor slide-out - card editor slide-out - better access group control - dedicated documentation pages - improved documentation - new system for automatically generating documentation for platforms - ability to load custom platforms - added an 'on_starup' method for platforms allowing for registering api routes. (example coming soon)
276 lines
8.7 KiB
Python
276 lines
8.7 KiB
Python
from flask import render_template_string
|
|
|
|
|
|
import requests
|
|
import time
|
|
import hashlib
|
|
|
|
|
|
def inApiLink(ip, endpoint):
|
|
return "http://" + str(ip) + "/admin/scripts/pi-hole/php/" + str(endpoint) + ".php"
|
|
|
|
|
|
class Auth(object):
|
|
def __init__(self, password):
|
|
# PiHole's web token is just a double sha256 hash of the utf8 encoded password
|
|
self.token = hashlib.sha256(
|
|
hashlib.sha256(str(password).encode()).hexdigest().encode()
|
|
).hexdigest()
|
|
self.auth_timestamp = time.time()
|
|
|
|
|
|
class PiHole(object):
|
|
# Takes in an ip address of a pihole server
|
|
def __init__(self, ip_address):
|
|
self.ip_address = ip_address
|
|
self.auth_data = None
|
|
self.refresh()
|
|
self.pw = None
|
|
|
|
def refresh(self):
|
|
rawdata = requests.get(
|
|
"http://" + self.ip_address + "/admin/api.php?summary"
|
|
).json()
|
|
|
|
if self.auth_data != None:
|
|
topdevicedata = requests.get(
|
|
"http://"
|
|
+ self.ip_address
|
|
+ "/admin/api.php?getQuerySources=25&auth="
|
|
+ self.auth_data.token
|
|
).json()
|
|
|
|
self.top_devices = topdevicedata["top_sources"]
|
|
|
|
self.forward_destinations = requests.get(
|
|
"http://"
|
|
+ self.ip_address
|
|
+ "/admin/api.php?getForwardDestinations&auth="
|
|
+ self.auth_data.token
|
|
).json()
|
|
|
|
self.query_types = requests.get(
|
|
"http://"
|
|
+ self.ip_address
|
|
+ "/admin/api.php?getQueryTypes&auth="
|
|
+ self.auth_data.token
|
|
).json()["querytypes"]
|
|
|
|
# Data that is returned is now parsed into vars
|
|
self.status = rawdata["status"]
|
|
self.domain_count = rawdata["domains_being_blocked"]
|
|
self.queries = rawdata["dns_queries_today"]
|
|
self.blocked = rawdata["ads_blocked_today"]
|
|
self.ads_percentage = rawdata["ads_percentage_today"]
|
|
self.unique_domains = rawdata["unique_domains"]
|
|
self.forwarded = rawdata["queries_forwarded"]
|
|
self.cached = rawdata["queries_cached"]
|
|
self.total_clients = rawdata["clients_ever_seen"]
|
|
self.unique_clients = rawdata["unique_clients"]
|
|
self.total_queries = rawdata["dns_queries_all_types"]
|
|
self.gravity_last_updated = rawdata["gravity_last_updated"]
|
|
|
|
def refreshTop(self, count):
|
|
if self.auth_data == None:
|
|
print("Unable to fetch top items. Please authenticate.")
|
|
exit(1)
|
|
|
|
rawdata = requests.get(
|
|
"http://"
|
|
+ self.ip_address
|
|
+ "/admin/api.php?topItems="
|
|
+ str(count)
|
|
+ "&auth="
|
|
+ self.auth_data.token
|
|
).json()
|
|
self.top_queries = rawdata["top_queries"]
|
|
self.top_ads = rawdata["top_ads"]
|
|
|
|
def getGraphData(self):
|
|
rawdata = requests.get(
|
|
"http://" + self.ip_address + "/admin/api.php?overTimeData10mins"
|
|
).json()
|
|
return {
|
|
"domains": rawdata["domains_over_time"],
|
|
"ads": rawdata["ads_over_time"],
|
|
}
|
|
|
|
def authenticate(self, password):
|
|
self.auth_data = Auth(password)
|
|
self.pw = password
|
|
|
|
# print(self.auth_data.token)
|
|
|
|
def getAllQueries(self):
|
|
if self.auth_data == None:
|
|
print("Unable to get queries. Please authenticate")
|
|
exit(1)
|
|
return requests.get(
|
|
"http://"
|
|
+ self.ip_address
|
|
+ "/admin/api.php?getAllQueries&auth="
|
|
+ self.auth_data.token
|
|
).json()["data"]
|
|
|
|
def enable(self):
|
|
if self.auth_data == None:
|
|
print("Unable to enable pihole. Please authenticate")
|
|
exit(1)
|
|
requests.get(
|
|
"http://"
|
|
+ self.ip_address
|
|
+ "/admin/api.php?enable&auth="
|
|
+ self.auth_data.token
|
|
)
|
|
|
|
def disable(self, seconds):
|
|
if self.auth_data == None:
|
|
print("Unable to disable pihole. Please authenticate")
|
|
exit(1)
|
|
requests.get(
|
|
"http://"
|
|
+ self.ip_address
|
|
+ "/admin/api.php?disable="
|
|
+ str(seconds)
|
|
+ "&auth="
|
|
+ self.auth_data.token
|
|
)
|
|
|
|
def getVersion(self):
|
|
return requests.get(
|
|
"http://" + self.ip_address + "/admin/api.php?versions"
|
|
).json()
|
|
|
|
def getDBfilesize(self):
|
|
if self.auth_data == None:
|
|
print("Please authenticate")
|
|
exit(1)
|
|
return float(
|
|
requests.get(
|
|
"http://"
|
|
+ self.ip_address
|
|
+ "/admin/api_db.php?getDBfilesize&auth="
|
|
+ self.auth_data.token
|
|
).json()["filesize"]
|
|
)
|
|
|
|
def getList(self, list):
|
|
return requests.get(
|
|
inApiLink(self.ip_address, "get") + "?list=" + str(list)
|
|
).json()
|
|
|
|
def add(self, list, domain):
|
|
if self.auth_data == None:
|
|
print("Please authenticate")
|
|
exit(1)
|
|
with requests.session() as s:
|
|
s.get(
|
|
"http://" + str(self.ip_address) + "/admin/scripts/pi-hole/php/add.php"
|
|
)
|
|
requests.post(
|
|
"http://" + str(self.ip_address) + "/admin/scripts/pi-hole/php/add.php",
|
|
data={"list": list, "domain": domain, "pw": self.pw},
|
|
).text
|
|
|
|
def sub(self, list, domain):
|
|
if self.auth_data == None:
|
|
print("Please authenticate")
|
|
exit(1)
|
|
with requests.session() as s:
|
|
s.get(
|
|
"http://" + str(self.ip_address) + "/admin/scripts/pi-hole/php/sub.php"
|
|
)
|
|
requests.post(
|
|
"http://" + str(self.ip_address) + "/admin/scripts/pi-hole/php/sub.php",
|
|
data={"list": list, "domain": domain, "pw": self.pw},
|
|
).text
|
|
|
|
|
|
class Platform:
|
|
def docs(self):
|
|
documentation = {
|
|
"name": "pihole",
|
|
"author": "Nixellion",
|
|
"author_url": "https://github.com/Nixellion",
|
|
"version": 1.0,
|
|
"description": "Display information from the PiHole API",
|
|
"example": """
|
|
```ini
|
|
[pihole-data]
|
|
platform = pihole
|
|
host = 192.168.x.x
|
|
password = password123
|
|
value_template = Ads Blocked Today: {{ blocked }}<br>Status: {{ status }}<br>Queries today: {{ queries }}
|
|
|
|
[PiHole]
|
|
prefix = http://
|
|
url = 192.168.x.x
|
|
icon = static/images/apps/pihole.png
|
|
description = A black hole for Internet advertisements
|
|
open_in = new_tab
|
|
data_sources = pihole-data
|
|
```
|
|
""",
|
|
"returns": "`value_template` as rendered string",
|
|
"returns_json_keys": [
|
|
"domain_count",
|
|
"queries",
|
|
"blocked",
|
|
"ads_percentage",
|
|
"unique_domains",
|
|
"forwarded",
|
|
"cached",
|
|
"total_clients",
|
|
"unique_clients",
|
|
"total_queries",
|
|
"gravity_last_updated",
|
|
],
|
|
"variables": [
|
|
{
|
|
"variable": "[variable_name]",
|
|
"description": "Name for the data source.",
|
|
"default": "",
|
|
"options": ".ini header",
|
|
},
|
|
{
|
|
"variable": "platform",
|
|
"description": "Name of the platform.",
|
|
"default": "pihole",
|
|
"options": "pihole",
|
|
},
|
|
{
|
|
"variable": "host",
|
|
"description": "Host of the PiHole",
|
|
"default": "192.168.x.x",
|
|
"options": "host",
|
|
},
|
|
{
|
|
"variable": "password",
|
|
"description": "Password for the PiHole ",
|
|
"default": "password123",
|
|
"options": "password",
|
|
},
|
|
{
|
|
"variable": "value_template",
|
|
"description": "Jinja template for how the returned data from API is displayed.",
|
|
"default": "Ads Blocked Today: {{ blocked }}<br>Status: {{ status }}<br>Queries today: {{ queries }}",
|
|
"options": "jinja template",
|
|
},
|
|
],
|
|
}
|
|
return documentation
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
# parse the user's options from the config entries
|
|
for key, value in kwargs.items():
|
|
self.__dict__[key] = value
|
|
|
|
# self.pihole = PiHole(self.host)
|
|
|
|
def process(self):
|
|
self.pihole.refresh()
|
|
value_template = render_template_string(
|
|
self.value_template, **self.pihole.__dict__
|
|
)
|
|
return value_template
|