diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 00000000..f0a5832f --- /dev/null +++ b/.dockerignore @@ -0,0 +1,17 @@ +.dockerignore +.env +.git +.github +.gitignore +docker-compose.yml +Dockerfile +dockerfiles/LICENSE +dockerfiles/README.md +docs +install/pialert_install.sh +install/pialert_install_no_webserver.sh +install/pialert_uninstall.sh +install/pialert_update.sh +LICENSE.txt +README.md +tar diff --git a/.env b/.env new file mode 100644 index 00000000..c75c843a --- /dev/null +++ b/.env @@ -0,0 +1,10 @@ +#GLOBAL +APP_DATA_LOCATION=/path/to/docker_appdata +APP_CONFIG_LOCATION=/path/to/docker_config +LOGS_LOCATION=/path/to/docker_logs +TZ=Europe/Paris +HOST_USER_ID=1000 +HOST_USER_GID=1000 +PORT=20211 + + diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml new file mode 100644 index 00000000..b971a490 --- /dev/null +++ b/.github/workflows/docker.yml @@ -0,0 +1,64 @@ +--- +name: docker + +on: + schedule: + - cron: 0 0 1 * * # The first of the month at 00:00 + push: + branches: + - '**' + tags: + - '*.*.*' + pull_request: + branches: + - master + +jobs: + docker: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v2 + + - name: Set up QEMU + uses: docker/setup-qemu-action@v1 + + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v1 + + - name: Set up dynamic build ARGs + id: getargs + run: echo "::set-output name=version::$(cat ./stable/VERSION)" + + - name: Docker meta + id: meta + uses: docker/metadata-action@v3 + with: + # list of Docker images to use as base name for tags + images: | + jokobsk/pi.alert_dev + # generate Docker tags based on the following events/attributes + tags: | + type=raw,value=latest + type=schedule + type=ref,event=branch + type=ref,event=pr + type=semver,pattern={{version}} + type=semver,pattern={{major}}.{{minor}} + type=semver,pattern={{major}} + type=sha + + - name: Login to DockerHub + if: github.event_name != 'pull_request' + uses: docker/login-action@v1 + with: + username: ${{ secrets.DOCKERHUB_USERNAME }} + password: ${{ secrets.DOCKERHUB_TOKEN }} + + - name: Build and push + uses: docker/build-push-action@v2 + with: + platforms: linux/amd64,linux/arm64,linux/arm/v7 + push: ${{ github.event_name != 'pull_request' }} + tags: ${{ steps.meta.outputs.tags }} + labels: ${{ steps.meta.outputs.labels }} diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 00000000..8270667c --- /dev/null +++ b/Dockerfile @@ -0,0 +1,41 @@ +FROM debian:bullseye-slim + +# default UID and GID +ENV USER=pi USER_ID=1000 USER_GID=1000 TZ=Europe/London PORT=20211 + +# Todo, figure out why using a workdir instead of full paths don't work +# Todo, do we still need all these packages? I can already see sudo which isn't needed + +RUN apt-get update \ + && apt-get install --no-install-recommends ca-certificates curl libwww-perl arp-scan perl apt-utils cron sudo nginx-light php php-cgi php-fpm php-sqlite3 sqlite3 dnsutils net-tools python3 iproute2 nmap python3-pip zip -y \ + && pip3 install requests \ + && update-alternatives --install /usr/bin/python python /usr/bin/python3 10 \ + && apt-get clean autoclean \ + && apt-get autoremove \ + && rm -rf /var/lib/apt/lists/* \ + && rm -rf /var/www/html \ + && ln -s /home/pi/pialert/front /var/www/html + + +# now creating user +RUN groupadd --gid "${USER_GID}" "${USER}" && \ + useradd \ + --uid ${USER_ID} \ + --gid ${USER_GID} \ + --create-home \ + --shell /bin/bash \ + ${USER} + +COPY . /home/pi/pialert + +# Pi.Alert +RUN python /home/pi/pialert/back/pialert.py update_vendors \ + && rm /etc/nginx/sites-available/default \ + && ln -s /home/pi/pialert/install/default /etc/nginx/sites-available/default \ + && sed -ie 's/listen 80/listen '${PORT}'/g' /etc/nginx/sites-available/default \ + && (crontab -l 2>/dev/null; cat /home/pi/pialert/install/pialert.cron) | crontab - + +# it's easy for permissions set in Git to be overridden, so doing it manually +RUN chmod -R a+rxw /home/pi/pialert/ + +CMD ["/home/pi/pialert/dockerfiles/start.sh"] \ No newline at end of file diff --git a/README.md b/README.md index a3f1212d..58ae4f7d 100644 --- a/README.md +++ b/README.md @@ -10,11 +10,20 @@ unknown devices. It also warns if a "always connected" devices disconnects. *(Apologies for my English and my limited knowledge of Python, php and JavaScript)* -## Modifications within this Fork - - Only one scan cycle - - Modified scanmethod. If you want to go back to the original method comment line 488 and uncomment line 491 in ~/pialert/back/pialert.py - - Because of the modified scan, the extended scan parameters in the configuration file do not work. For this reason they were removed. - - The Backend has the additional option "cleanup" +# Docker image 🐳 +[![Docker](https://github.com/jokob-sk/Pi.Alert/actions/workflows/docker.yml/badge.svg)](https://github.com/jokob-sk/Pi.Alert/actions/workflows/docker.yml) +[![Docker Image Size](https://img.shields.io/docker/image-size/jokobsk/pi.alert?logo=Docker)](https://hub.docker.com/r/jokobsk/pi.alert) + + Docker Pulls + + +🥇 Pi.Alert credit goes to [pucherot/Pi.Alert](https://github.com/pucherot/Pi.Alert).
+🐳 Docker Image: [jokobsk/Pi.Alert](https://registry.hub.docker.com/r/jokobsk/pi.alert).
+📄 [Dockerfile](https://github.com/jokob-sk/Pi.Alert/blob/main/Dockerfile)
+📚 [Dockerfile instructions](https://github.com/jokob-sk/Pi.Alert/blob/main//dockerfiles/README.md). + + +Dark mode (and Device presence over time) within this fork courtesy of [leiweibau](https://github.com/leiweibau/Pi.Alert) ## How it works The system continuously scans the network for: @@ -47,13 +56,16 @@ In charge of: described - Store the information in the DB - Report the changes detected by e-mail and/or other services (Pushsafer, NTFY, Gotify) + - Optional speedtest for Device "Internet" - DB cleanup tasks via cron | ![Report 1][report1] | ![Report 2][report2] | | -------------------- | -------------------- | ### Front -There is a configurable login to prevent unauthorized use. The default password is "123456". By default, this is disabled. If you want to use password protection, enable it in the configuration file ~/pialert/config/pialert.conf. +There is a configurable login to prevent unauthorized use. + +> * Set `PIALERT_WEB_PROTECTION = True` in `pialert.conf` to enable. The default password is `123456`. A web frontend that allows: - Manage the devices inventory and the characteristics @@ -67,7 +79,9 @@ A web frontend that allows: - Down alerts - IP's - Manual Nmap scans - - Speedtest for Device "Internet" in the details view + - Optional speedtest for Device "Internet" + - Simple Network relationship display + - CSV Export / Import (Experimental) - ... | ![Screen 1][screen1] | ![Screen 2][screen2] | @@ -93,12 +107,32 @@ In addition, the network page was created from this collaboration. Here you can Initially designed to run on a Raspberry Pi, probably it can run on many other Linux distributions. +> ⚠ Please note, this [fork (jokob-sk)](https://github.com/jokob-sk/Pi.Alert) is only tested via the [docker install method](dockerfiles/README.md) + +Instructions for [pucherot's original code](https://github.com/pucherot/Pi.Alert/) + +- One-step Automated Install: + #### `curl -sSL https://github.com/pucherot/Pi.Alert/raw/main/install/pialert_install.sh | bash` + +Instructions for [leiweibau's fork](https://github.com/leiweibau/Pi.Alert/) + - One-step Automated Install: #### `curl -sSL https://github.com/leiweibau/Pi.Alert/raw/main/install/pialert_install.sh | bash` + +- One-step Automated Install without Webserver if another Webserver is already installed. (not recommended): + #### `curl -sSL https://github.com/leiweibau/Pi.Alert/raw/main/install/pialert_install_no_webserver.sh | bash` -- [Installation Guide (step by step)](docs/INSTALL. +- [Installation Guide (step by step)](docs/INSTALL.md) +# Update + +- One-step Automated Update (pucherot): + #### `curl -sSL https://github.com/pucherot/Pi.Alert/raw/main/install/pialert_update.sh | bash` + +- One-step Automated Update (leiweibau): + #### `curl -sSL https://github.com/leiweibau/Pi.Alert/raw/main/install/pialert_update.sh | bash` + # Uninstall process - [Unistall process](docs/UNINSTALL.md) @@ -146,7 +180,7 @@ Linux distributions. pi.alert.application@gmail.com ***Suggestions and comments are welcome*** - + ### Special thanks 🥇 This code is a collaborative body of work, with special thanks to: @@ -155,7 +189,8 @@ Linux distributions. - [Macleykun](https://github.com/Macleykun): Help with Dockerfile clean-up - [Final-Hawk](https://github.com/Final-Hawk): Help with NTFY, styling and other fixes - [TeroRERO](https://github.com/terorero): Spanish translation - - [jokob-sk](https://github.com/jokob-sk/Pi.Alert): Many more things + - [jokob-sk](https://github.com/jokob-sk/Pi.Alert): DB Maintenance tools + - Please see the [Git commit history](https://github.com/jokob-sk/Pi.Alert/commits/main) for a full list of people and their contributions to the project [main]: ./docs/img/1_devices.jpg "Main screen" @@ -163,7 +198,7 @@ Linux distributions. [screen2]: ./docs/img/2_2_device_sessions.jpg "Screen 2" [screen3]: ./docs/img/2_3_device_presence.jpg "Screen 3" [screen4]: ./docs/img/3_presence.jpg "Screen 4" -[screen5]: ./docs/img/2_4_device_nmap.jpg "Screen 5" +[screen5]: ./docs/img/2_4_network.png "Screen 5" [screen6]: ./docs/img/2_5_device_nmap_ready.jpg "Screen 6" [report1]: ./docs/img/4_report_1.jpg "Report sample 1" [report2]: ./docs/img/4_report_2.jpg "Report sample 2" diff --git a/back/pialert.py b/back/pialert.py index ffe93cb6..c9048dac 100644 --- a/back/pialert.py +++ b/back/pialert.py @@ -75,6 +75,9 @@ def main (): return cycle = str(sys.argv[1]) + ## Upgrade DB if needed + upgradeDB() + ## Main Commands if cycle == 'internet_IP': res = check_internet_IP() @@ -256,28 +259,35 @@ def check_IP_format (pIP): #=============================================================================== -# INTERNET IP CHANGE +# Cleanup Online History chart #=============================================================================== def cleanup_database (): # Header print ('Cleanup Database') print (' Timestamp:', startTime ) - openDB() - strdaystokeepOH = str(DAYS_TO_KEEP_ONLINEHISTORY) - strdaystokeepEV = str(DAYS_TO_KEEP_EVENTS) + openDB() + + # keep 10 years if not specified how many days to keep + try: + strdaystokeepEV = str(DAYS_TO_KEEP_EVENTS) + except NameError: # variable not defined, use a default + strdaystokeepEV = str(3650) # 10 years + # Cleanup Online History - print ('\nCleanup Online_History, up to the lastest '+strdaystokeepOH+' days...') - sql.execute ("DELETE FROM Online_History WHERE Scan_Date <= date('now', '-"+strdaystokeepOH+" day')") + print ('\nCleanup Online_History...') + sql.execute ("DELETE FROM Online_History WHERE Scan_Date <= date('now', '-1 day')") + print ('\nOptimize Database...') + # Cleanup Events print ('\nCleanup Events, up to the lastest '+strdaystokeepEV+' days...') sql.execute ("DELETE FROM Events WHERE eve_DateTime <= date('now', '-"+strdaystokeepEV+" day')") + # Shrink DB print ('\nShrink Database...') sql.execute ("VACUUM;") closeDB() - # OK return 0 @@ -382,15 +392,12 @@ def scan_network (): # ScanCycle data cycle_interval = scanCycle_data['cic_EveryXmin'] - arpscan_retries = scanCycle_data['cic_arpscanCycles'] - # TESTING - Fast scan - # arpscan_retries = 1 # arp-scan command print ('\nScanning...') print (' arp-scan Method...') print_log ('arp-scan starts...') - arpscan_devices = execute_arpscan (arpscan_retries) + arpscan_devices = execute_arpscan () print_log ('arp-scan ends') # DEBUG - print number of rows updated # print (arpscan_devices) @@ -476,27 +483,13 @@ def query_ScanCycle_Data (pOpenCloseDB = False): return sqlRow #------------------------------------------------------------------------------- -def execute_arpscan (pRetries): - +def execute_arpscan (): # #101 - arp-scan subnet configuration # Prepare command arguments - # subnets = SCAN_SUBNETS.strip().split() - - # arp-scan for larger Networks like /16 - # otherwise the system starts multiple processes. the 15min cronjob isn't necessary. - # the scan is about 4min on a /16 network - arpscan_args = ['sudo', 'arp-scan', '--ignoredups', '--bandwidth=512k', '--retry=3', '--localnet'] - - # Default arp-scan - # arpscan_args = ['sudo', 'arp-scan', '--localnet', '--ignoredups', '--retry=' + str(pRetries)] - # print (arpscan_args) - - # TESTING - Fast Scan - # arpscan_args = ['sudo', 'arp-scan', '--localnet', '--ignoredups', '--retry=1'] - - # DEBUG - arp-scan command - # print (" ".join (arpscan_args)) - + subnets = SCAN_SUBNETS.strip().split() + # Retry is 6 to avoid false offline devices + arpscan_args = ['sudo', 'arp-scan', '--ignoredups', '--retry=6'] + subnets + # Execute command arpscan_output = subprocess.check_output (arpscan_args, universal_newlines=True) @@ -510,9 +503,6 @@ def execute_arpscan (pRetries): devices_list = [device.groupdict() for device in re.finditer (re_pattern, arpscan_output)] - # Bugfix #5 - Delete duplicated MAC's with different IP's - # TEST - Force duplicated device - # devices_list.append(devices_list[0]) # Delete duplicate MAC unique_mac = [] unique_devices = [] @@ -730,14 +720,17 @@ def print_scan_stats (): sql.execute("SELECT * FROM Devices") History_All = sql.fetchall() History_All_Devices = len(History_All) + sql.execute("SELECT * FROM Devices WHERE dev_Archived = 1") History_Archived = sql.fetchall() History_Archived_Devices = len(History_Archived) - sql.execute("SELECT * FROM CurrentScan") + + sql.execute("""SELECT * FROM CurrentScan WHERE cur_ScanCycle = ? """, (cycle,)) History_Online = sql.fetchall() History_Online_Devices = len(History_Online) History_Offline_Devices = History_All_Devices - History_Archived_Devices - History_Online_Devices - sql.execute ("INSERT INTO Online_History (Scan_Date, Online_Devices, Down_Devices, All_Devices, Archived_Devices ) "+ + + sql.execute ("INSERT INTO Online_History (Scan_Date, Online_Devices, Down_Devices, All_Devices, Archived_Devices) "+ "VALUES ( ?, ?, ?, ?, ?)", (startTime, History_Online_Devices, History_Offline_Devices, History_All_Devices, History_Archived_Devices ) ) #------------------------------------------------------------------------------- @@ -754,6 +747,16 @@ def create_new_devices (): WHERE dev_MAC = cur_MAC) """, (startTime, cycle) ) + print_log ('New devices - Insert Connection into session table') + sql.execute ("""INSERT INTO Sessions (ses_MAC, ses_IP, ses_EventTypeConnection, ses_DateTimeConnection, + ses_EventTypeDisconnection, ses_DateTimeDisconnection, ses_StillConnected, ses_AdditionalInfo) + SELECT cur_MAC, cur_IP,'Connected',?, NULL , NULL ,1, cur_Vendor + FROM CurrentScan + WHERE cur_ScanCycle = ? + AND NOT EXISTS (SELECT 1 FROM Sessions + WHERE ses_MAC = cur_MAC) """, + (startTime, cycle) ) + # arpscan - Create new devices print_log ('New devices - 2 Create devices') sql.execute ("""INSERT INTO Devices (dev_MAC, dev_name, dev_Vendor, @@ -981,17 +984,10 @@ def update_devices_data_from_scan (): sql.executemany ("UPDATE Devices SET dev_Vendor = ? WHERE dev_MAC = ? ", recordsToUpdate ) - # New Apple devices -> Cycle 15 - print_log ('Update devices - 6 Cycle for Apple devices') - sql.execute ("""UPDATE Devices SET dev_ScanCycle = 1 - WHERE dev_FirstConnection = ? - AND UPPER(dev_Vendor) LIKE '%APPLE%' """, - (startTime,) ) - print_log ('Update devices end') #------------------------------------------------------------------------------- -# Feature #43 - Resoltion name for unknown devices +# Feature #43 - Resolve name for unknown devices def update_devices_names (): # Initialize variables recordsToUpdate = [] @@ -1214,20 +1210,21 @@ def skip_repeated_notifications (): def email_reporting (): global mail_text global mail_html - # Reporting section print ('\nReporting...') openDB() # Disable reporting on events for devices where reporting is disabled based on the MAC address sql.execute ("""UPDATE Events SET eve_PendingAlertEmail = 0 - WHERE eve_PendingAlertEmail = 1 AND eve_MAC IN + WHERE eve_PendingAlertEmail = 1 AND eve_EventType != 'Device Down' AND eve_MAC IN ( - SELECT dev_MAC FROM Devices WHERE dev_AlertEvents = 0 + SELECT dev_MAC FROM Devices WHERE dev_AlertEvents = 0 + )""") + sql.execute ("""UPDATE Events SET eve_PendingAlertEmail = 0 + WHERE eve_PendingAlertEmail = 1 AND eve_EventType = 'Device Down' AND eve_MAC IN + ( + SELECT dev_MAC FROM Devices WHERE dev_AlertDeviceDown = 0 )""") - - # Open text Template - # Open text Template template_file = open(PIALERT_BACK_PATH + '/report_template.txt', 'r') @@ -1274,16 +1271,18 @@ def email_reporting (): WHERE eve_PendingAlertEmail = 1 AND eve_MAC = 'Internet' ORDER BY eve_DateTime""") + for eventAlert in sql : mail_section_Internet = True mail_text_Internet += text_line_template.format ( - eventAlert['eve_EventType'], eventAlert['eve_DateTime'], - eventAlert['eve_IP'], eventAlert['eve_AdditionalInfo']) + 'Event:', eventAlert['eve_EventType'], 'Time:', eventAlert['eve_DateTime'], + 'IP:', eventAlert['eve_IP'], 'More Info:', eventAlert['eve_AdditionalInfo']) mail_html_Internet += html_line_template.format ( REPORT_DEVICE_URL, eventAlert['eve_MAC'], eventAlert['eve_EventType'], eventAlert['eve_DateTime'], eventAlert['eve_IP'], eventAlert['eve_AdditionalInfo']) + format_report_section (mail_section_Internet, 'SECTION_INTERNET', 'TABLE_INTERNET', mail_text_Internet, mail_html_Internet) @@ -1310,7 +1309,7 @@ def email_reporting (): REPORT_DEVICE_URL, eventAlert['eve_MAC'], eventAlert['eve_MAC'], eventAlert['eve_DateTime'], eventAlert['eve_IP'], eventAlert['dev_Name'], eventAlert['eve_AdditionalInfo']) - + format_report_section (mail_section_new_devices, 'SECTION_NEW_DEVICES', 'TABLE_NEW_DEVICES', mail_text_new_devices, mail_html_new_devices) @@ -1385,16 +1384,16 @@ def email_reporting (): send_email (mail_text, mail_html) else : print (' Skip mail...') - if REPORT_PUSHSAFER : - print (' Sending report by PUSHSAFER...') - send_pushsafer (mail_text) - else : - print (' Skip PUSHSAFER...') if REPORT_NTFY : print (' Sending report by NTFY...') send_ntfy (mail_text) else : print (' Skip NTFY...') + if REPORT_PUSHSAFER : + print (' Sending report by PUSHSAFER...') + send_pushsafer (mail_text) + else : + print (' Skip PUSHSAFER...') else : print (' No changes to report...') @@ -1414,8 +1413,16 @@ def email_reporting (): # Commit changes sql_connection.commit() closeDB() - #------------------------------------------------------------------------------- +def send_ntfy (_Text): + requests.post("https://ntfy.sh/{}".format(NTFY_TOPIC), + data=_Text, + headers={ + "Title": "Pi.Alert Notification", + "Actions": "view, Open Dashboard, "+ REPORT_DASHBOARD_URL, + "Priority": "urgent", + "Tags": "warning" + }) def send_pushsafer (_Text): url = 'https://www.pushsafer.com/api' @@ -1431,24 +1438,8 @@ def send_pushsafer (_Text): "ut" : 'Open Pi.Alert', "k" : PUSHSAFER_TOKEN, } - requests.post(url, data=post_fields) - #request = Request(url, urlencode(post_fields).encode()) - #json = urlopen(request).read().decode() - # print(json) - -#------------------------------------------------------------------------------- - -def send_ntfy (_Text): - requests.post("https://ntfy.sh/{}".format(NTFY_TOPIC), - data=_Text, - headers={ - "Title": "Pi.Alert Notification", - "Click": REPORT_DASHBOARD_URL, - "Priority": "urgent", - "Tags": "warning" - }) - + #------------------------------------------------------------------------------- def format_report_section (pActive, pSection, pTable, pText, pHTML): global mail_text @@ -1539,6 +1530,69 @@ def SafeParseGlobalBool(boolVariable): #=============================================================================== # DB #=============================================================================== +def upgradeDB (): + + openDB() + + # indicates, if Online_History table is available + onlineHistoryAvailable = sql.execute(""" + SELECT name FROM sqlite_master WHERE type='table' + AND name='Online_History'; + """).fetchall() != [] + + # Check if it is incompatible (Check if table has all required columns) + isIncompatible = False + + if onlineHistoryAvailable : + isIncompatible = sql.execute (""" + SELECT COUNT(*) AS CNTREC FROM pragma_table_info('Online_History') WHERE name='Archived_Devices' + """).fetchone()[0] == 0 + + # Drop table if available, but incompatible + if onlineHistoryAvailable and isIncompatible: + print_log ('Table is incompatible, Dropping the Online_History table)') + sql.execute("DROP TABLE Online_History;") + onlineHistoryAvailable = False + + if onlineHistoryAvailable == False : + sql.execute(""" + CREATE TABLE "Online_History" ( + "Index" INTEGER, + "Scan_Date" TEXT, + "Online_Devices" INTEGER, + "Down_Devices" INTEGER, + "All_Devices" INTEGER, + "Archived_Devices" INTEGER, + PRIMARY KEY("Index" AUTOINCREMENT) + ); + """) + + # Alter Devices table + # dev_Network_Node_MAC_ADDR column + dev_Network_Node_MAC_ADDR_missing = sql.execute (""" + SELECT COUNT(*) AS CNTREC FROM pragma_table_info('Devices') WHERE name='dev_Network_Node_MAC_ADDR' + """).fetchone()[0] == 0 + + if dev_Network_Node_MAC_ADDR_missing : + sql.execute(""" + ALTER TABLE "Devices" ADD "dev_Network_Node_MAC_ADDR" TEXT + """) + + # dev_Network_Node_port column + dev_Network_Node_port_missing = sql.execute (""" + SELECT COUNT(*) AS CNTREC FROM pragma_table_info('Devices') WHERE name='dev_Network_Node_port' + """).fetchone()[0] == 0 + + if dev_Network_Node_port_missing : + sql.execute(""" + ALTER TABLE "Devices" ADD "dev_Network_Node_port" INTEGER + """) + + # don't hog DB access + closeDB () + +#------------------------------------------------------------------------------- + def openDB (): global sql_connection global sql @@ -1552,6 +1606,7 @@ def openDB (): # Open DB and Cursor sql_connection = sqlite3.connect (DB_PATH, isolation_level=None) + sql_connection.execute('pragma journal_mode=wal') # sql_connection.text_factory = str sql_connection.row_factory = sqlite3.Row sql = sql_connection.cursor() diff --git a/back/report_template.txt b/back/report_template.txt index a25c9af0..9f5ebdad 100644 --- a/back/report_template.txt +++ b/back/report_template.txt @@ -1,11 +1,6 @@ Report Date: Server: - - -Internet ----------------------- - - + New Devices ---------------------- @@ -17,4 +12,8 @@ Devices Down Events ---------------------- - + +Internet +---------------------- + + \ No newline at end of file diff --git a/config/pialert.conf b/config/pialert.conf index 233b94e4..9c1f5b70 100644 --- a/config/pialert.conf +++ b/config/pialert.conf @@ -61,8 +61,18 @@ PIHOLE_DB = '/etc/pihole/pihole-FTL.db' DHCP_ACTIVE = False DHCP_LEASES = '/etc/pihole/dhcp.leases' +# arp-scan options & samples +# +# Scan local network (default) +# SCAN_SUBNETS = '--localnet' +# +# Scan two subnets +# SCAN_SUBNETS = '192.168.11.0/24 192.168.144.0/24' +# +# Scan using interface eth0 +# SCAN_SUBNETS = '--localnet --interface=eth0' +SCAN_SUBNETS = '--localnet' + # Maintenance Tasks Cron # ---------------------- -DAYS_TO_KEEP_ONLINEHISTORY = 30 DAYS_TO_KEEP_EVENTS = 90 - diff --git a/config/version.conf b/config/version.conf index 01663ec1..da01c2c5 100644 --- a/config/version.conf +++ b/config/version.conf @@ -1,3 +1,3 @@ -VERSION = '3.6_leiweibau' +VERSION = '3.6_jokobsk' VERSION_YEAR = '2022' VERSION_DATE = '2022-08-03' diff --git a/db/pialert.db b/db/pialert.db index c47638ea..ff4e2731 100644 Binary files a/db/pialert.db and b/db/pialert.db differ diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 00000000..b1ec288d --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,16 @@ +version: "3" +services: + pialert: + build: . + container_name: pialert + network_mode: "host" + restart: always + volumes: + - ${APP_DATA_LOCATION}/pialert/config:/home/pi/pialert/config + - ${APP_DATA_LOCATION}/pialert/db/pialert.db:/home/pi/pialert/db/pialert.db + - ${LOGS_LOCATION}/tmp:/home/pi/pialert/log + environment: + - TZ=${TZ} + - PORT=${PORT} + - HOST_USER_ID=${HOST_USER_ID} + - HOST_USER_GID=${HOST_USER_GID} diff --git a/dockerfiles/LICENSE b/dockerfiles/LICENSE new file mode 100644 index 00000000..3877ae0a --- /dev/null +++ b/dockerfiles/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/dockerfiles/README.md b/dockerfiles/README.md new file mode 100644 index 00000000..8cd5c096 --- /dev/null +++ b/dockerfiles/README.md @@ -0,0 +1,114 @@ +[![Docker](https://github.com/jokob-sk/Pi.Alert/actions/workflows/docker.yml/badge.svg)](https://github.com/jokob-sk/Pi.Alert/actions/workflows/docker.yml) +[![Docker Image Size](https://img.shields.io/docker/image-size/jokobsk/pi.alert?logo=Docker)](https://hub.docker.com/r/jokobsk/pi.alert) + + Docker Pulls + + +# 🐳 A docker image for Pi.Alert + +🥇 Pi.Alert credit goes to [pucherot/Pi.Alert](https://github.com/pucherot/Pi.Alert).
+🐳 Docker Image: [jokobsk/Pi.Alert](https://registry.hub.docker.com/r/jokobsk/pi.alert).
+📄 [Dockerfile](https://github.com/jokob-sk/Pi.Alert/blob/main/Dockerfile)
+📚 [Dockerfile instructions](https://github.com/jokob-sk/Pi.Alert/blob/main//dockerfiles/README.md). + +Big thanks to @Macleykun for help and tips&tricks for Dockerfile(s): + + + + + +## ℹ Usage + +pialert.conf + - Everytime you rebuilt the container with a new image check if new settings have been added in [pialert.conf](https://github.com/jokob-sk/Pi.Alert/blob/main/config/pialert.conf). + +Network + - You will have to run the container on the host network, e.g: `sudo docker run --rm --net=host jokobsk/pi.alert` + +Default Port + - The app is accessible on the port `:20211`. + +> Please note - the cronjob is executed every 3 and 5 minutes so wait that long for all of the scans to run. + +## 💾 Setup and Backups + +1. (**required**) Download `pialert.conf` and `version.conf` from [here](https://github.com/jokob-sk/Pi.Alert/tree/main/config). +2. (**required**) In `pialert.conf` specify your network adapter (will probably be `eth0` or `eth1`) and the network filter (which **significantly** speeds up the scan process), e.g. if your DHCP server assigns IPs in the 192.168.1.0 to 192.168.1.255 range specify it the following way: + * `SCAN_SUBNETS = '192.168.1.0/24 --interface=eth0'` +3. (**required**) Use your configuration by: + * Mapping the container folder `/home/pi/pialert/config` to a persistent folder containing `pialert.conf` and `version.conf`, + * ... or by mapping the files individually `pialert.conf:/home/pi/pialert/config/pialert.conf` and `version.conf:/home/pi/pialert/config/version.conf` +4. Set the `TZ` environment variable to your current time zone (e.g.`Europe/Paris`). Find your time zone [here](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). +5. Database backup + * The DB is stored under `/home/pi/pialert/db/pialert.db`. Map this file to a persistent location (see [Examples](https://github.com/jokob-sk/Pi.Alert/tree/main/dockerfiles#page_facing_up-examples) for details). If facing issues (AJAX errors, can't write to DB, etc, make sure permissions are set correctly, alternatively check the logs under `/home/pi/pialert/log`) +6. The container supports mapping to local User nad Group IDs. Specify the enviroment variables `HOST_USER_ID` and `HOST_USER_GID` if needed. +7. You can override the port by specifying the `PORT` env variable. + +Config examples can be found below. + +## 📄 Examples + +### Example 1 + +`docker-compose.yml` + +```yaml +version: "3" +services: + pialert: + container_name: pialert + image: "jokobsk/pi.alert:latest" + network_mode: "host" + restart: always + volumes: + - ${APP_DATA_LOCATION}/pialert/config:/home/pi/pialert/config + - ${APP_DATA_LOCATION}/pialert/db/pialert.db:/home/pi/pialert/db/pialert.db + - ${LOGS_LOCATION}/tmp:/home/pi/pialert/log + environment: + - TZ=${TZ} + - PORT=${PORT} + - HOST_USER_ID=${HOST_USER_ID} + - HOST_USER_GID=${HOST_USER_GID} +``` + +`.env` file + +```yaml +#GLOBAL +APP_DATA_LOCATION=/path/to/docker_appdata +APP_CONFIG_LOCATION=/path/to/docker_config +LOGS_LOCATION=/path/to/docker_logs +TZ=Europe/Paris +HOST_USER_ID=1000 +HOST_USER_GID=1000 +PORT=20211 +``` + +To run the container execute: `sudo docker-compose --env-file /path/to/.env up` + +### Example 2 + +Courtesy of [pbek](https://github.com/pbek). The volume `pialert_db` is used by the db directory. The two config files are mounted directly from a local folder to their places in the config folder. You can backup the `docker-compose.yaml` folder and the docker volumes folder. + +```yaml + pialert: + image: jokobsk/pi.alert + ports: + - "80:20211/tcp" + environment: + - TZ=Europe/Vienna + networks: + local: + ipv4_address: 192.168.1.2 + restart: unless-stopped + volumes: + - pialert_db:/home/pi/pialert/db + - ./pialert/pialert.conf:/home/pi/pialert/config/pialert.conf + - ./pialert/version.conf:/home/pi/pialert/config/version.conf +``` + +## ☕ Support + +> Disclaimer: This is my second container and I might have used unconventional hacks so if anyone is more experienced, feel free to fork/create pull requests. Also, please only donate if you don't have any debt yourself. Support yourself first, then others. + +Buy Me A Coffee diff --git a/dockerfiles/start.sh b/dockerfiles/start.sh new file mode 100755 index 00000000..67099939 --- /dev/null +++ b/dockerfiles/start.sh @@ -0,0 +1,17 @@ +#!/bin/sh +/home/pi/pialert/dockerfiles/user-mapping.sh + +# if custom variables not set we do not need to do anything +if [ -n "${TZ}" ]; then + sed -ie "s|Europe/Berlin|${TZ}|g" /home/pi/pialert/install/pialert.cron + sed -ie "s|Europe/Berlin|${TZ}|g" /home/pi/pialert/config/pialert.conf + crontab < /home/pi/pialert/install/pialert.cron +fi + +if [ -n "${PORT}" ]; then + sed -ie 's/listen 20211/listen '${PORT}'/g' /etc/nginx/sites-available/default +fi + +/etc/init.d/php7.4-fpm start +/etc/init.d/nginx start +cron -f diff --git a/dockerfiles/user-mapping.sh b/dockerfiles/user-mapping.sh new file mode 100644 index 00000000..54803092 --- /dev/null +++ b/dockerfiles/user-mapping.sh @@ -0,0 +1,29 @@ +#!/bin/bash + +if [ -z "${USER}" ]; then + echo "We need USER to be set!"; exit 100 +fi + +# if both not set we do not need to do anything +if [ -z "${HOST_USER_ID}" -a -z "${HOST_USER_GID}" ]; then + echo "Nothing to do here." ; exit 0 +fi + +# reset user_?id to either new id or if empty old (still one of above +# might not be set) +USER_ID=${HOST_USER_ID:=$USER_ID} +USER_GID=${HOST_USER_GID:=$USER_GID} + +LINE=$(grep -F "${USER}" /etc/passwd) +# replace all ':' with a space and create array +array=( ${LINE//:/ } ) + +# home is 5th element +USER_HOME=${array[4]} + +sed -i -e "s/^${USER}:\([^:]*\):[0-9]*:[0-9]*/${USER}:\1:${USER_ID}:${USER_GID}/" /etc/passwd +sed -i -e "s/^${USER}:\([^:]*\):[0-9]*/${USER}:\1:${USER_GID}/" /etc/group + +chown -R ${USER_ID}:${USER_GID} ${USER_HOME} + +exec su - "${USER}" \ No newline at end of file diff --git a/docs/img/1_devices_dark.jpg b/docs/img/1_devices_dark.jpg new file mode 100644 index 00000000..1b768f8f Binary files /dev/null and b/docs/img/1_devices_dark.jpg differ diff --git a/docs/img/2_1_device_details.jpg b/docs/img/2_1_device_details.jpg index ba001077..90ad2133 100644 Binary files a/docs/img/2_1_device_details.jpg and b/docs/img/2_1_device_details.jpg differ diff --git a/docs/img/2_2_device_sessions.jpg b/docs/img/2_2_device_sessions.jpg index 32f88447..063c63c1 100644 Binary files a/docs/img/2_2_device_sessions.jpg and b/docs/img/2_2_device_sessions.jpg differ diff --git a/docs/img/2_4_network.png b/docs/img/2_4_network.png new file mode 100644 index 00000000..ee6b8c17 Binary files /dev/null and b/docs/img/2_4_network.png differ diff --git a/docs/img/3_presence.jpg b/docs/img/3_presence.jpg index b619e46f..7589dcca 100644 Binary files a/docs/img/3_presence.jpg and b/docs/img/3_presence.jpg differ diff --git a/docs/img/5_maintain.jpg b/docs/img/5_maintain.jpg index bfa68e09..69c2f569 100644 Binary files a/docs/img/5_maintain.jpg and b/docs/img/5_maintain.jpg differ diff --git a/front/css/dark-patch.css b/front/css/dark-patch.css index 40811a98..0c9ed484 100644 --- a/front/css/dark-patch.css +++ b/front/css/dark-patch.css @@ -594,7 +594,42 @@ input[type="password"]::-webkit-caps-lock-indicator { } /*** Additional fixes For Pi.Alert UI ***/ - +.small-box { + border-radius: 10px; + border-top: 0px; +} +.pa-small-box-aqua .inner { + background-color: rgb(45,108,133); + border-top-left-radius: 10px; + border-top-right-radius: 10px; +} +.pa-small-box-green .inner { + background-color: rgb(31,76,46); + border-top-left-radius: 10px; + border-top-right-radius: 10px; +} +.pa-small-box-yellow .inner { + background-color: rgb(151,104,37); + border-top-left-radius: 10px; + border-top-right-radius: 10px; +} +.pa-small-box-red .inner { + background-color: rgb(120,50,38); + border-top-left-radius: 10px; + border-top-right-radius: 10px; +} +.pa-small-box-gray .inner { + background-color: #777; + /* color: rgba(20,20,20,30%); */ + border-top-left-radius: 10px; + border-top-right-radius: 10px; +} +.pa-small-box-gray .inner h3 { + color: #bbb; +} +.text-gray-20 { + color: rgba(220,220,220,30%); +} .bg-gray { background-color: #888888 !important; } @@ -670,4 +705,21 @@ input[type="password"]::-webkit-caps-lock-indicator { .login-box-body { color: #bec5cb; background-color: #272c30; -} \ No newline at end of file +} +/* Add border radius to bottom of the status boxes*/ +.pa-small-box-footer { + border-bottom-left-radius: 10px; + border-bottom-right-radius: 10px; +} + +.small-box > .inner h3, .small-box > .inner p { + margin-bottom: 0px; + margin-left: 0px; +} +.small-box:hover .icon { + font-size: 3.74em; +} +.small-box .icon { + top: 0.01em; + font-size: 3.25em; +} diff --git a/front/deviceDetails.php b/front/deviceDetails.php index fe57d78b..ff96dcf6 100644 --- a/front/deviceDetails.php +++ b/front/deviceDetails.php @@ -12,7 +12,7 @@ session_start(); if ($_SESSION["login"] != 1) { - header('Location: /pialert/index.php'); + header('Location: index.php'); exit; } @@ -263,7 +263,8 @@ if ($_REQUEST['mac'] == 'Internet') { $DevDetail_Tap_temp = "Tools"; } else { $D - + +

@@ -814,44 +815,85 @@ function initializeiCheck () { // ----------------------------------------------------------------------------- function initializeCombos () { // Initialize combos with queries - initializeCombo ( $('#dropdownOwner')[0], 'getOwners', 'txtOwner'); - initializeCombo ( $('#dropdownDeviceType')[0], 'getDeviceTypes', 'txtDeviceType'); - initializeCombo ( $('#dropdownGroup')[0], 'getGroups', 'txtGroup'); - initializeCombo ( $('#dropdownLocation')[0], 'getLocations', 'txtLocation'); - initializeCombo ( $('#dropdownNetworkNodeMac')[0], 'getNetworkNodes', 'txtNetworkNodeMac'); + initializeCombo ( '#dropdownOwner', 'getOwners', 'txtOwner', true); + initializeCombo ( '#dropdownDeviceType', 'getDeviceTypes', 'txtDeviceType', true); + initializeCombo ( '#dropdownGroup', 'getGroups', 'txtGroup', true); + initializeCombo ( '#dropdownLocation', 'getLocations', 'txtLocation', true); + initializeCombo ( '#dropdownNetworkNodeMac', 'getNetworkNodes', 'txtNetworkNodeMac', false); // Initialize static combos initializeComboSkipRepeated (); } -function initializeCombo (HTMLelement, queryAction, txtDataField) { - // get data from server - $.get('php/server/devices.php?action='+queryAction, function(data) { - var listData = JSON.parse(data); - var order = 1; +function initializeCombo (dropdownId, queryAction, txtDataField, useCache) { - HTMLelement.innerHTML = '' - // for each item - listData.forEach(function (item, index) { - // insert line divisor - if (order != item['order']) { - HTMLelement.innerHTML += '
  • '; - order = item['order']; - } + // check if we have the value cached already + var dropdownHtmlContent = useCache ? getCache(dropdownId) : ""; - id = item['name']; - // use explicitly specified id (value) if avaliable - if(item['id']) - { - id = item['id']; - } + if(dropdownHtmlContent == "") + { + // get data from server + $.get('php/server/devices.php?action='+queryAction, function(data) { + var listData = JSON.parse(data); + var order = 1; + - // add dropdown item - HTMLelement.innerHTML += - '
  • '+ item['name'] + '
  • ' + // for each item + listData.forEach(function (item, index) { + // insert line divisor + if (order != item['order']) { + dropdownHtmlContent += '
  • '; + order = item['order']; + } + + id = item['name']; + // use explicitly specified id (value) if avaliable + if(item['id']) + { + id = item['id']; + } + + // add dropdown item + dropdownHtmlContent += + '
  • '+ item['name'] + '
  • ' + }); + + writeDropdownHtml(dropdownId, dropdownHtmlContent) }); - }); + } else + { + writeDropdownHtml(dropdownId, dropdownHtmlContent) + } +} + +// write out the HTML for the dropdown +function writeDropdownHtml(dropdownId, dropdownHtmlContent) +{ + // cache + setCache(dropdownId, dropdownHtmlContent); + + // write HTML for the dropdown + var HTMLelement = $(dropdownId)[0]; + HTMLelement.innerHTML = '' + HTMLelement.innerHTML += dropdownHtmlContent; +} + +function getCache(key) +{ + // check cache + if(sessionStorage.getItem(key)) + { + return sessionStorage.getItem(key); + } else + { + return ""; + } +} + +function setCache(key, data) +{ + sessionStorage.setItem(key, data); } @@ -1139,7 +1181,7 @@ function getDeviceData (readAllData=false) { $('#txtGroup').val ('--'); $('#txtLocation').val ('--'); $('#txtComments').val ('--'); - $('#txtNetworkNodeMac').val ('--'); + $('#txtNetworkNodeMac').val ('--'); $('#txtNetworkPort').val ('--'); $('#txtFirstConnection').val ('--'); @@ -1228,7 +1270,7 @@ function getDeviceData (readAllData=false) { $('#txtGroup').val (deviceData['dev_Group']); $('#txtLocation').val (deviceData['dev_Location']); $('#txtComments').val (deviceData['dev_Comments']); - $('#txtNetworkNodeMac').val (deviceData['dev_Network_Node_MAC']); + $('#txtNetworkNodeMac').val (deviceData['dev_Network_Node_MAC_ADDR']); $('#txtNetworkPort').val (deviceData['dev_Network_Node_port']); $('#txtFirstConnection').val (deviceData['dev_FirstConnection']); diff --git a/front/devices.php b/front/devices.php index f0033d05..1e8a5682 100644 --- a/front/devices.php +++ b/front/devices.php @@ -12,7 +12,7 @@ session_start(); if ($_SESSION["login"] != 1) { - header('Location: /pialert/index.php'); + header('Location: index.php'); exit; } @@ -114,7 +114,7 @@ if ($_SESSION["login"] != 1)
    -

    12

    +

    @@ -237,6 +237,12 @@ function main () { // ----------------------------------------------------------------------------- function initializeDatatable () { + // If the device has a small width (mobile) only show name, ip, and status columns. + if (window.screen.width < 400) { + var tableColumnShow = [10,11,12,1,2,3,4,5,6,8]; + } else { + var tableColumnShow = [10, 11, 12]; + }; var table= $('#tableDevices').DataTable({ 'paging' : true, @@ -254,7 +260,7 @@ function initializeDatatable () { // 'order' : [[3,'desc'], [0,'asc']], 'columnDefs' : [ - {visible: false, targets: [10, 11, 12] }, + {visible: false, targets: tableColumnShow }, {className: 'text-center', targets: [3, 8, 9] }, {width: '80px', targets: [5, 6] }, {width: '0px', targets: 9 }, diff --git a/front/events.php b/front/events.php index 597cca30..677b9f0a 100644 --- a/front/events.php +++ b/front/events.php @@ -1,6 +1,6 @@ +
    +
    + +
    +
    +
    @@ -338,9 +344,21 @@ if (submit && isset($_POST['langselector_set'])) {
    -
    -
    -
    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    +
    +
    +
    +
    @@ -415,6 +433,20 @@ function deleteEvents() }); } +// delete all Events older than 30 days +function askDeleteEvents30 () { + // Ask + showModalWarning('', '', + '', '', 'deleteEvents30'); +} +function deleteEvents30() +{ + // Execute + $.get('php/server/devices.php?action=deleteEvents30', function(msg) { + showMessage (msg); + }); +} + // delete Hostory function askDeleteActHistory () { // Ask @@ -471,6 +503,32 @@ function PiaPurgeDBBackups() }); } +// Export CSV +function askExportCSV() { + // Ask + showModalWarning('', '', + '', '', 'ExportCSV'); +} +function ExportCSV() +{ + // Execute + openInNewTab(window.location.origin + "/php/server/devices.php?action=ExportCSV") +} + +// Import CSV +function askImportCSV() { + // Ask + showModalWarning('', '', + '', '', 'ImportCSV'); +} +function ImportCSV() +{ + // Execute + $.get('/php/server/devices.php?action=ImportCSV', function(msg) { + showMessage (msg); + }); +} + // Switch Darkmode function askPiaEnableDarkmode() { // Ask diff --git a/front/network.php b/front/network.php index 16696be1..60e53206 100644 --- a/front/network.php +++ b/front/network.php @@ -1,368 +1,430 @@ query($sql); -// ##################################### -// ## Expand Devices Table -// ##################################### -$sql = 'ALTER TABLE "Devices" ADD "dev_Infrastructure" INTEGER'; -$result = $db->query($sql); -$sql = 'ALTER TABLE "Devices" ADD "dev_Infrastructure_port" INTEGER'; -$result = $db->query($sql); -// ##################################### -// Add New Network Devices -// ##################################### -if ($_REQUEST['Networkinsert'] == "yes") { - if (isset($_REQUEST['NetworkDeviceName']) && isset($_REQUEST['NetworkDeviceTyp'])) - { - $sql = 'INSERT INTO "network_infrastructure" ("net_device_name", "net_device_typ", "net_device_port") VALUES("'.$_REQUEST['NetworkDeviceName'].'", "'.$_REQUEST['NetworkDeviceTyp'].'", "'.$_REQUEST['NetworkDevicePort'].'")'; - $result = $db->query($sql); - } -} -// ##################################### -// Add New Network Devices -// ##################################### -if ($_REQUEST['Networkedit'] == "yes") { - if (isset($_REQUEST['NewNetworkDeviceName']) && isset($_REQUEST['NewNetworkDeviceTyp'])) - { - $sql = 'UPDATE "network_infrastructure" SET "net_device_name" = "'.$_REQUEST['NewNetworkDeviceName'].'", "net_device_typ" = "'.$_REQUEST['NewNetworkDeviceTyp'].'", "net_device_port" = "'.$_REQUEST['NewNetworkDevicePort'].'" WHERE "device_id"="'.$_REQUEST['NetworkDeviceID'].'"'; - //$sql = 'INSERT INTO "network_infrastructure" ("net_device_name", "net_device_typ", "net_device_port") VALUES("'.$_REQUEST['NetworkDeviceName'].'", "'.$_REQUEST['NetworkDeviceTyp'].'", "'.$_REQUEST['NetworkDevicePort'].'")'; - $result = $db->query($sql); - } -} -// ##################################### -// remove Network Devices -// ##################################### -if ($_REQUEST['Networkdelete'] == "yes") { - if (isset($_REQUEST['NetworkDeviceID'])) - { - $sql = 'DELETE FROM "network_infrastructure" WHERE "device_id"="'.$_REQUEST['NetworkDeviceID'].'"'; - $result = $db->query($sql); - } -} + // online / offline badges HTML snippets + define('badge_online', '
    Online
    '); + define('badge_offline', '
    Offline
    '); + define('circle_online', '
     
    '); + define('circle_offline', '
     
    '); + + $DBFILE = '../db/pialert.db'; + $NETWORKTYPES = getNetworkTypes(); + + OpenDB(); ?> +
    - -
    - -

    - -

    -
    + +
    + +

    + +

    +
    - - -
    -
    -
    -

    -
    - -
    -
    - -
    -
    -
    -

    - -
    - - -
    - -
    - - -
    -
    - - -
    -
    - -
    - - -
    - -
    -

    -
    -
    - - -
    -
    - - -
    -
    - - -
    -
    - - -
    - -
    - -
    -
    - -
    - -
    -

    -
    -
    - - -
    - -
    - -
    -
    - -
    -
    - -
    - -
    + -'.$pia_func_netdevname.' / '.$pia_func_netdevtyp; - if ($pia_func_netdevport != "") {echo ' ('.$pia_func_netdevport.')';} - echo ''; -} -function createnetworktabcontent($pia_func_netdevid, $pia_func_netdevname, $pia_func_netdevtyp, $pia_func_netdevport, $activetab) { - global $pia_lang; - echo '
    -

    '.$pia_func_netdevname.' (ID: '.$pia_func_netdevid.')


    '; - echo '
    - - - - - - - '; - // Prepare Array for Devices with Port value - // If no Port is set, the Port number is set to 1 - if ($pia_func_netdevport == "") {$pia_func_netdevport = 1;} - // Create Array with specific length - $network_device_portname = array(); - $network_device_portmac = array(); - $network_device_portip = array(); - $network_device_portstate = array(); - // make sql query for Network Hardware ID - global $db; - $func_sql = 'SELECT * FROM "Devices" WHERE "dev_Infrastructure" = "'.$pia_func_netdevid.'"'; - $func_result = $db->query($func_sql);//->fetchArray(SQLITE3_ASSOC); - while($func_res = $func_result->fetchArray(SQLITE3_ASSOC)) { - //if(!isset($func_res['dev_Name'])) continue; - if ($func_res['dev_PresentLastScan'] == 1) {$port_state = '
    Online
    ';} else {$port_state = '
    Offline
    ';} - // Prepare Table with Port > push values in array - if ($pia_func_netdevport > 1) - { - if (stristr($func_res['dev_Infrastructure_port'], ',') == '') { - if ($network_device_portname[$func_res['dev_Infrastructure_port']] != '') {$network_device_portname[$func_res['dev_Infrastructure_port']] = $network_device_portname[$func_res['dev_Infrastructure_port']].','.$func_res['dev_Name'];} else {$network_device_portname[$func_res['dev_Infrastructure_port']] = $func_res['dev_Name'];} - if ($network_device_portmac[$func_res['dev_Infrastructure_port']] != '') {$network_device_portmac[$func_res['dev_Infrastructure_port']] = $network_device_portmac[$func_res['dev_Infrastructure_port']].','.$func_res['dev_MAC'];} else {$network_device_portmac[$func_res['dev_Infrastructure_port']] = $func_res['dev_MAC'];} - if ($network_device_portip[$func_res['dev_Infrastructure_port']] != '') {$network_device_portip[$func_res['dev_Infrastructure_port']] = $network_device_portip[$func_res['dev_Infrastructure_port']].','.$func_res['dev_LastIP'];} else {$network_device_portip[$func_res['dev_Infrastructure_port']] = $func_res['dev_LastIP'];} - if (isset($network_device_portstate[$func_res['dev_Infrastructure_port']])) {$network_device_portstate[$func_res['dev_Infrastructure_port']] = $network_device_portstate[$func_res['dev_Infrastructure_port']].','.$func_res['dev_PresentLastScan'];} else {$network_device_portstate[$func_res['dev_Infrastructure_port']] = $func_res['dev_PresentLastScan'];} - } else { - $multiport = array(); - $multiport = explode(',',$func_res['dev_Infrastructure_port']); - foreach($multiport as $row) { - $network_device_portname[trim($row)] = $func_res['dev_Name']; - $network_device_portmac[trim($row)] = $func_res['dev_MAC']; - $network_device_portip[trim($row)] = $func_res['dev_LastIP']; - $network_device_portstate[trim($row)] = $func_res['dev_PresentLastScan']; - } - unset($multiport); + +
    + echo values - // Specific icon for devicetype - if ($pia_func_netdevtyp == "WLAN") {$dev_port_icon = 'fa-wifi';} - if ($pia_func_netdevtyp == "Powerline") {$dev_port_icon = 'fa-flash';} - echo '
    '; - } - } - // Create table with Port - if ($pia_func_netdevport > 1) - { - for ($x=1; $x<=$pia_func_netdevport; $x++) + + // online/offline status circle (red/green) + $node_badge = ""; + if($node_status == 1) // 1 means online, 0 offline { - // Prepare online/offline badge for later functions - $online_badge = '
    Online
    '; - $offline_badge = '
    Offline
    '; - // Set online/offline badge - echo ''; - echo ''; - // Set online/offline badge - // Check if multiple badges necessary - if (stristr($network_device_portstate[$x],',') == '') { - // Set single online/offline badge - if ($network_device_portstate[$x] == 1) {$port_state = $online_badge;} else {$port_state = $offline_badge;} - echo ''; - } else { - // Set multiple online/offline badges - $multistate = array(); - $multistate = explode(',',$network_device_portstate[$x]); - echo ''; - unset($multistate); - } - // Check if multiple Hostnames are set - // print single hostname - if (stristr($network_device_portmac[$x],',') == '') { - echo ''; - } else { - // print multiple hostnames with separate links - $multimac = array(); - $multimac = explode(',',$network_device_portmac[$x]); - $multiname = array(); - $multiname = explode(',',$network_device_portname[$x]); - echo ''; - unset($multiname, $multimac); - } - // Check if multiple IP are set - // print single IP - if (stristr($network_device_portip[$x],',') == '') { - echo ''; - } else { - // print multiple IPs - $multiip = array(); - $multiip = explode(',',$network_device_portip[$x]); - echo ''; - unset($multiip); - } - echo ''; + $node_badge = circle_online; + } else + { + $node_badge = circle_offline; } - } - echo '
    Port'.$pia_lang['Network_Table_State'].''.$pia_lang['Network_Table_Hostname'].''.$pia_lang['Network_Table_IP'].'
    '.$port_state.''.$func_res['dev_Name'].''.$func_res['dev_LastIP'].'
    '.$x.''.$port_state.''; - foreach($multistate as $key => $value) { - if ($value == 1) {$port_state = $online_badge;} else {$port_state = $offline_badge;} - echo $port_state.'
    '; - } - echo '
    '.$network_device_portname[$x].''; - foreach($multiname as $key => $value) { - echo ''.$value.'
    '; - } - echo '
    '.$network_device_portip[$x].''; - foreach($multiip as $key => $value) { - echo $value.'
    '; - } - echo '
    -
    '; - echo '
    '; -} -// ##################################### -// ## End Function Setup -// ##################################### + -// ##################################### -// ## Create Tabs -// ##################################### -$sql = 'SELECT "device_id", "net_device_name", "net_device_typ", "net_device_port" FROM "network_infrastructure"'; -$result = $db->query($sql);//->fetchArray(SQLITE3_ASSOC); -?> - -
    -
    + $str_tab_header = '
  • + ' + .$node_name.' ' .$str_port.$node_badge. + ' +
  • '; + + echo $str_tab_header; + + } + + // Create pane content (displayed inside of the tabs) + function createPane($node_mac, $node_name, $node_status, $node_type, $node_ports_count, $node_parent_mac, $activetab){ + global $pia_lang; //language strings + + // online/offline status circle (red/green) + $node_badge = ""; + if($node_status == 1) // 1 means online, 0 offline + { + $node_badge = badge_online; + } else + { + $node_badge = badge_offline; + } + + $str_tab_pane = '
    + +

    '.$node_name.'

    +
    + + + + + + + + + + + + + + + + + + + +
    + MAC: + ' + .$node_mac. + '
    + '.$pia_lang['Device_TableHead_Type'].' + + ' .$node_type. ' +
    + '.$pia_lang['Network_Table_State'].': + ' + .$node_badge. + '
    + '.$pia_lang['DevDetail_MainInfo_Network'].' + + + '.$node_parent_mac.' + +
    +
    +
    '; + + $str_table = '

    + '.$pia_lang['Device_Title'].' +

    + + + + + + + + '; + + // Prepare Array for Devices with Port value + // If no Port is set, the Port number is set to 0 + if ($node_ports_count == "") { + $node_ports_count = 0; + } + + // Get all leafs connected to a node based on the node_mac + $func_sql = 'SELECT dev_Network_Node_port as port, + dev_MAC as mac, + dev_PresentLastScan as online, + dev_Name as name, + dev_DeviceType as type, + dev_LastIP as last_ip, + (select dev_DeviceType from Devices a where dev_MAC = "'.$node_mac.'") as node_type + FROM Devices WHERE dev_Network_Node_MAC_ADDR = "'.$node_mac.'" order by port asc'; + + global $db; + $func_result = $db->query($func_sql); + + // array + $tableData = array(); + while ($row = $func_result -> fetchArray (SQLITE3_ASSOC)) { + // Push row data + $tableData[] = array( 'port' => $row['port'], + 'mac' => $row['mac'], + 'online' => $row['online'], + 'name' => $row['name'], + 'type' => $row['type'], + 'last_ip' => $row['last_ip'], + 'node_type' => $row['node_type']); + } + + // Control no rows + if (empty($tableData)) { + $tableData = []; + } + + $str_table_rows = ""; + + foreach ($tableData as $row) { + + if ($row['online'] == 1) { + $port_state = badge_online; + } else { + $port_state = badge_offline; + } + + // prepare HTML for the port table column cell + $port_content = "N/A"; + + if ($row['node_type'] == "WLAN" || $row['node_type'] == "AP" ) { + $port_content = ''; + } elseif ($row['node_type'] == "Powerline") + { + $port_content = ''; + } elseif ($row['port'] != NULL && $row['port'] != "") + { + $port_content = $row['port']; + } + + $str_table_rows = $str_table_rows. + ' + + + + + '; + + } + + $str_table_close = ' +
    Port'.$pia_lang['Network_Table_State'].''.$pia_lang['Network_Table_Hostname'].''.$pia_lang['Network_Table_IP'].'
    + '.$port_content.' + ' + .$port_state. + ' + + '.$row['name'].' + + ' + .$row['last_ip']. + '
    '; + + // no connected device - don't render table, just display some info + if($str_table_rows == "") + { + $str_table = "
    +

    + ".$pia_lang['Device_Title']." +

    +
    + This network device (node) doesn't have any assigned devices (leaf nodes). + Go to ".$pia_lang['Device_Title'].", select a device you want to attach to this node and assign it in the Details tab by selecting it in the ".$pia_lang['DevDetail_MainInfo_Network'] ." dropdown. +
    +
    "; + $str_table_close = ""; + } + + $str_close_pane = '
    +
    '; + + // write the HTML + echo ''.$str_tab_header. + $str_tab_pane. + $str_table. + $str_table_rows. + $str_table_close. + $str_close_pane; + } + + + // Create Top level tabs (List of network devices), explanation of the terminology below: + // + // Switch 1 (node) + // /(p1) \ (p2) <----- port numbers + // / \ + // Smart TV (leaf) Switch 2 (node (for the PC) and leaf (for Switch 1)) + // \ + // PC (leaf) + + $sql = "SELECT node_name, node_mac, online, node_type, node_ports_count, parent_mac + FROM + ( + SELECT a.dev_Name as node_name, + a.dev_MAC as node_mac, + a.dev_PresentLastScan as online, + a.dev_DeviceType as node_type, + a.dev_Network_Node_MAC_ADDR as parent_mac + FROM Devices a + WHERE a.dev_DeviceType in ('AP', 'Gateway', 'Powerline', 'Switch', 'WLAN', 'PLC', 'Router','USB LAN Adapter', 'USB WIFI Adapter', 'Internet') + ) t1 + LEFT JOIN + ( + SELECT b.dev_Network_Node_MAC_ADDR as node_mac_2, + count() as node_ports_count + FROM Devices b + WHERE b.dev_Network_Node_MAC_ADDR NOT NULL group by b.dev_Network_Node_MAC_ADDR + ) t2 + ON (t1.node_mac = t2.node_mac_2); + "; + + $result = $db->query($sql); + + // array + $tableData = array(); + while ($row = $result -> fetchArray (SQLITE3_ASSOC)) { + // Push row data + $tableData[] = array( 'node_mac' => $row['node_mac'], + 'node_name' => $row['node_name'], + 'online' => $row['online'], + 'node_type' => $row['node_type'], + 'parent_mac' => $row['parent_mac'], + 'node_ports_count' => $row['node_ports_count']); + } + + // Control no rows + if (empty($tableData)) { + $tableData = []; + } + + echo ' @@ -371,4 +433,4 @@ unset($i); \ No newline at end of file +?> diff --git a/front/php/server/cache-bottom.php b/front/php/server/cache-bottom.php new file mode 100644 index 00000000..63ff81ca --- /dev/null +++ b/front/php/server/cache-bottom.php @@ -0,0 +1,7 @@ + \ No newline at end of file diff --git a/front/php/server/cache-top.php b/front/php/server/cache-top.php new file mode 100644 index 00000000..17be21e8 --- /dev/null +++ b/front/php/server/cache-top.php @@ -0,0 +1,15 @@ +\n"; + readfile($cachefile); + exit; +} +ob_start(); // Start the output buffer +?> \ No newline at end of file diff --git a/front/php/server/db.php b/front/php/server/db.php index 8e3e7706..d4458bc6 100644 --- a/front/php/server/db.php +++ b/front/php/server/db.php @@ -8,6 +8,13 @@ // Puche 2021 pi.alert.application@gmail.com GNU GPLv3 //------------------------------------------------------------------------------ +// ## TimeZone processing +$config_file = "../../../config/pialert.conf"; +$config_file_lines = file($config_file); +$config_file_lines_timezone = array_values(preg_grep('/^TIMEZONE\s.*/', $config_file_lines)); +$timezone_line = explode("'", $config_file_lines_timezone[0]); +$Pia_TimeZone = $timezone_line[1]; +date_default_timezone_set($Pia_TimeZone); //------------------------------------------------------------------------------ // DB File Path @@ -51,10 +58,11 @@ function OpenDB () { } $db = SQLite3_connect(true); + $db->exec('PRAGMA journal_mode = wal;'); if(!$db) { die ('Error connecting to database'); } } -?> +?> \ No newline at end of file diff --git a/front/php/server/devices.php b/front/php/server/devices.php index 9ea82d40..89ad77e4 100644 --- a/front/php/server/devices.php +++ b/front/php/server/devices.php @@ -7,6 +7,13 @@ //------------------------------------------------------------------------------ // Puche 2021 pi.alert.application@gmail.com GNU GPLv3 //------------------------------------------------------------------------------ +// ## TimeZone processing +$config_file = "../../../config/pialert.conf"; +$config_file_lines = file($config_file); +$config_file_lines_timezone = array_values(preg_grep('/^TIMEZONE\s.*/', $config_file_lines)); +$timezone_line = explode("'", $config_file_lines_timezone[0]); +$Pia_TimeZone = $timezone_line[1]; +date_default_timezone_set($Pia_TimeZone); foreach (glob("../../../db/setting_language*") as $filename) { $pia_lang_selected = str_replace('setting_language_','',basename($filename)); @@ -34,9 +41,9 @@ if (strlen($pia_lang_selected) == 0) {$pia_lang_selected = 'en_us';} switch ($action) { case 'getDeviceData': getDeviceData(); break; case 'setDeviceData': setDeviceData(); break; - case 'deleteDevice': deleteDevice(); break; case 'getNetworkNodes': getNetworkNodes(); break; - case 'deleteAllWithEmptyMACs': deleteAllWithEmptyMACs(); break; + case 'deleteDevice': deleteDevice(); break; + case 'deleteAllWithEmptyMACs': deleteAllWithEmptyMACs(); break; case 'createBackupDB': createBackupDB(); break; case 'restoreBackupDB': restoreBackupDB(); break; case 'deleteAllDevices': deleteAllDevices(); break; @@ -44,13 +51,16 @@ if (strlen($pia_lang_selected) == 0) {$pia_lang_selected = 'en_us';} case 'runScan1min': runScan1min(); break; case 'deleteUnknownDevices': deleteUnknownDevices(); break; case 'deleteEvents': deleteEvents(); break; + case 'deleteEvents30': deleteEvents30(); break; case 'deleteActHistory': deleteActHistory(); break; case 'deleteDeviceEvents': deleteDeviceEvents(); break; case 'PiaBackupDBtoArchive': PiaBackupDBtoArchive(); break; case 'PiaRestoreDBfromArchive': PiaRestoreDBfromArchive(); break; case 'PiaPurgeDBBackups': PiaPurgeDBBackups(); break; case 'PiaEnableDarkmode': PiaEnableDarkmode(); break; - case 'PiaToggleArpScan': PiaToggleArpScan(); break; + case 'PiaToggleArpScan': PiaToggleArpScan(); break; + case 'ExportCSV': ExportCSV(); break; + case 'ImportCSV': ImportCSV(); break; case 'getDevicesTotals': getDevicesTotals(); break; case 'getDevicesList': getDevicesList(); break; @@ -88,8 +98,8 @@ function getDeviceData() { $deviceData = $row; $mac = $deviceData['dev_MAC']; - $deviceData['dev_Network_Node_MAC'] = $row['dev_Infrastructure']; - $deviceData['dev_Network_Node_port'] = $row['dev_Infrastructure_port']; + $deviceData['dev_Network_Node_MAC_ADDR'] = $row['dev_Network_Node_MAC_ADDR']; + $deviceData['dev_Network_Node_port'] = $row['dev_Network_Node_port']; $deviceData['dev_FirstConnection'] = formatDate ($row['dev_FirstConnection']); // Date formated $deviceData['dev_LastConnection'] = formatDate ($row['dev_LastConnection']); // Date formated @@ -120,8 +130,10 @@ function getDeviceData() { $row = $result -> fetchArray (SQLITE3_NUM); $deviceData['dev_DownAlerts'] = $row[0]; + // Get current date using php, sql datetime does not return time respective to timezone. + $currentdate = date("Y-m-d H:i:s"); // Presence hours - $sql = 'SELECT CAST(( MAX (0, SUM (julianday (IFNULL (ses_DateTimeDisconnection, DATETIME("now","localtime"))) + $sql = 'SELECT CAST(( MAX (0, SUM (julianday (IFNULL (ses_DateTimeDisconnection,"'. $currentdate .'" )) - julianday (CASE WHEN ses_DateTimeConnection < '. $periodDate .' THEN '. $periodDate .' ELSE ses_DateTimeConnection END)) *24 )) AS INT) FROM Sessions @@ -149,23 +161,23 @@ function setDeviceData() { // sql $sql = 'UPDATE Devices SET - dev_Name = "'. quotes($_REQUEST['name']) .'", - dev_Owner = "'. quotes($_REQUEST['owner']) .'", - dev_DeviceType = "'. quotes($_REQUEST['type']) .'", - dev_Vendor = "'. quotes($_REQUEST['vendor']) .'", - dev_Favorite = "'. quotes($_REQUEST['favorite']) .'", - dev_Group = "'. quotes($_REQUEST['group']) .'", - dev_Location = "'. quotes($_REQUEST['location']) .'", - dev_Comments = "'. quotes($_REQUEST['comments']) .'", - dev_Infrastructure = "'. quotes($_REQUEST['networknode']).'", - dev_Infrastructure_port = "'. quotes($_REQUEST['networknodeport']).'", - dev_StaticIP = "'. quotes($_REQUEST['staticIP']) .'", - dev_ScanCycle = "'. quotes($_REQUEST['scancycle']) .'", - dev_AlertEvents = "'. quotes($_REQUEST['alertevents']) .'", - dev_AlertDeviceDown = "'. quotes($_REQUEST['alertdown']) .'", - dev_SkipRepeated = "'. quotes($_REQUEST['skiprepeated']) .'", - dev_NewDevice = "'. quotes($_REQUEST['newdevice']) .'", - dev_Archived = "'. quotes($_REQUEST['archived']) .'" + dev_Name = "'. quotes($_REQUEST['name']) .'", + dev_Owner = "'. quotes($_REQUEST['owner']) .'", + dev_DeviceType = "'. quotes($_REQUEST['type']) .'", + dev_Vendor = "'. quotes($_REQUEST['vendor']) .'", + dev_Favorite = "'. quotes($_REQUEST['favorite']) .'", + dev_Group = "'. quotes($_REQUEST['group']) .'", + dev_Location = "'. quotes($_REQUEST['location']) .'", + dev_Comments = "'. quotes($_REQUEST['comments']) .'", + dev_Network_Node_MAC_ADDR = "'. quotes($_REQUEST['networknode']).'", + dev_Network_Node_port = "'. quotes($_REQUEST['networknodeport']).'", + dev_StaticIP = "'. quotes($_REQUEST['staticIP']) .'", + dev_ScanCycle = "'. quotes($_REQUEST['scancycle']) .'", + dev_AlertEvents = "'. quotes($_REQUEST['alertevents']) .'", + dev_AlertDeviceDown = "'. quotes($_REQUEST['alertdown']) .'", + dev_SkipRepeated = "'. quotes($_REQUEST['skiprepeated']) .'", + dev_NewDevice = "'. quotes($_REQUEST['newdevice']) .'", + dev_Archived = "'. quotes($_REQUEST['archived']) .'" WHERE dev_MAC="' . $_REQUEST['mac'] .'"'; // update Data $result = $db->query($sql); @@ -299,6 +311,26 @@ function deleteEvents() { } } +//------------------------------------------------------------------------------ +// Delete all Events older than 30 days +//------------------------------------------------------------------------------ +function deleteEvents30() { + global $db; + global $pia_lang; + + // sql + $sql = "DELETE FROM Events WHERE eve_DateTime <= date('now', '-30 day')"; + // execute sql + $result = $db->query($sql); + + // check result + if ($result == TRUE) { + echo $pia_lang['BackDevices_DBTools_DelEvents']; + } else { + echo $pia_lang['BackDevices_DBTools_DelEventsError']."\n\n$sql \n\n". $db->lastErrorMsg(); + } +} + //------------------------------------------------------------------------------ // Delete History //------------------------------------------------------------------------------ @@ -407,6 +439,120 @@ function PiaPurgeDBBackups() { } +//------------------------------------------------------------------------------ +// Export CSV of devices +//------------------------------------------------------------------------------ +function ExportCSV() { + + header("Content-Type: application/octet-stream"); + header("Content-Transfer-Encoding: Binary"); + header("Content-disposition: attachment; filename=\"devices.csv\""); + + global $db; + $func_result = $db->query("SELECT * FROM Devices"); + + // prepare CSV header row + // header array with column names + $columns = getDevicesColumns(); + + // wrap the headers with " (quotes) + $resultCSV = '"'.implode('","', $columns).'"'; + + //and append a new line + $resultCSV = $resultCSV."\n"; + + // retrieve the devices from the DB + while ($row = $func_result -> fetchArray (SQLITE3_ASSOC)) { + + // loop through columns and add values to the string + $index = 0; + foreach ($columns as $columnName) { + + // add quotes around the value to prevent issues with commas in fields + $resultCSV = $resultCSV.'"'.$row[$columnName].'"'; + + // detect last loop - skip as no comma needed + if ($index != count($columns) - 1 ) + { + $resultCSV = $resultCSV.','; + } + $index++; + } + + //$resultCSV = $resultCSV.implode(",", [$row["dev_MAC"], $row["dev_Name"]]); + $resultCSV = $resultCSV."\n"; + } + + //write the built CSV string + echo $resultCSV; +} + +//------------------------------------------------------------------------------ +// Import CSV of devices +//------------------------------------------------------------------------------ +function ImportCSV() { + + + $file = '../../../config/devices.csv'; + + if (file_exists($file)) { + + global $db; + global $pia_lang; + + $error = ""; + + // sql + $sql = 'DELETE FROM Devices'; + // execute sql + $result = $db->query($sql); + + // Open the CSV file with read-only mode + $csvFile = fopen($file, 'r'); + + // Skip the first line + fgetcsv($csvFile); + + $columns = getDevicesColumns(); + + // Parse data from CSV file line by line (max 10000 lines) + while (($row = fgetcsv($csvFile, 10000, ",")) !== FALSE) + { + $sql = 'INSERT INTO Devices ('.implode(',', $columns).') VALUES ("' .implode('","', $row).'")'; + + $result = $db->query($sql); + + // check result + if ($result != TRUE) { + $error = $db->lastErrorMsg(); + // break the while loop on error + break; + } + } + + // Close opened CSV file + fclose($csvFile); + + if($error == "") + { + // import succesful + echo $pia_lang['BackDevices_DBTools_ImportCSV']; + + } + else{ + // an error occurred while writing to the DB, display the last error message + echo $pia_lang['BackDevices_DBTools_ImportCSVError']."\n\n$sql \n\n".$error; + } + + } else { + echo $pia_lang['BackDevices_DBTools_ImportCSVMissing']; + } + + + $db->close(); + +} + //------------------------------------------------------------------------------ // Toggle Dark/Light Themes //------------------------------------------------------------------------------ @@ -448,22 +594,35 @@ function PiaToggleArpScan() { // Query total numbers of Devices by status //------------------------------------------------------------------------------ function getDevicesTotals() { - global $db; - // combined query - $result = $db->query( - 'SELECT - (SELECT COUNT(*) FROM Devices '. getDeviceCondition ('all').') as devices, - (SELECT COUNT(*) FROM Devices '. getDeviceCondition ('connected').') as connected, - (SELECT COUNT(*) FROM Devices '. getDeviceCondition ('favorites').') as favorites, - (SELECT COUNT(*) FROM Devices '. getDeviceCondition ('new').') as new, - (SELECT COUNT(*) FROM Devices '. getDeviceCondition ('down').') as down, - (SELECT COUNT(*) FROM Devices '. getDeviceCondition ('archived').') as archived - '); + $resultJSON = ""; - $row = $result -> fetchArray (SQLITE3_NUM); + if(getCache("getDevicesTotals") != "") + { + $resultJSON = getCache("getDevicesTotals"); + } else + { + global $db; - echo (json_encode (array ($row[0], $row[1], $row[2], $row[3], $row[4], $row[5]))); + // combined query + $result = $db->query( + 'SELECT + (SELECT COUNT(*) FROM Devices '. getDeviceCondition ('all').') as devices, + (SELECT COUNT(*) FROM Devices '. getDeviceCondition ('connected').') as connected, + (SELECT COUNT(*) FROM Devices '. getDeviceCondition ('favorites').') as favorites, + (SELECT COUNT(*) FROM Devices '. getDeviceCondition ('new').') as new, + (SELECT COUNT(*) FROM Devices '. getDeviceCondition ('down').') as down, + (SELECT COUNT(*) FROM Devices '. getDeviceCondition ('archived').') as archived + '); + + $row = $result -> fetchArray (SQLITE3_NUM); + $resultJSON = json_encode (array ($row[0], $row[1], $row[2], $row[3], $row[4], $row[5])); + + // save to cache + setCache("getDevicesTotals", $resultJSON ); + } + + echo ($resultJSON); } @@ -574,12 +733,43 @@ function getOwners() { } +//------------------------------------------------------------------------------ +// Query Device Data +//------------------------------------------------------------------------------ +function getNetworkNodes() { + global $db; + + // Device Data + $sql = 'SELECT * FROM Devices WHERE dev_DeviceType in ( "AP", "Gateway", "Powerline", "Switch", "WLAN", "PLC", "Router","USB LAN Adapter", "USB WIFI Adapter")'; + + $result = $db->query($sql); + + // arrays of rows + $tableData = array(); + while ($row = $result -> fetchArray (SQLITE3_ASSOC)) { + // Push row data + $tableData[] = array('id' => $row['dev_MAC'], + 'name' => $row['dev_Name'] ); + } + + // Control no rows + if (empty($tableData)) { + $tableData = []; + } + + // Return json + echo (json_encode ($tableData)); +} + + //------------------------------------------------------------------------------ // Query the List of types //------------------------------------------------------------------------------ function getDeviceTypes() { global $db; + $networkTypes = getNetworkTypes(); + // SQL $sql = 'SELECT DISTINCT 9 as dev_Order, dev_DeviceType FROM Devices @@ -588,7 +778,7 @@ function getDeviceTypes() { "Laptop", "Mini PC", "PC", "Printer", "Server", "Singleboard Computer (SBC)", "Game Console", "SmartTV", "TV Decoder", "Virtual Assistance", "Clock", "House Appliance", "Phone", "Radio", - "AP", "NAS", "PLC", "Router") + "AP", "Gateway", "Powerline", "Switch", "WLAN", "PLC", "Router","USB LAN Adapter", "USB WIFI Adapter" ) UNION SELECT 1 as dev_Order, "Smartphone" UNION SELECT 1 as dev_Order, "Tablet" @@ -599,6 +789,7 @@ function getDeviceTypes() { UNION SELECT 2 as dev_Order, "Printer" UNION SELECT 2 as dev_Order, "Server" UNION SELECT 2 as dev_Order, "Singleboard Computer (SBC)" + UNION SELECT 2 as dev_Order, "NAS" UNION SELECT 3 as dev_Order, "Domotic" UNION SELECT 3 as dev_Order, "Game Console" @@ -611,8 +802,12 @@ function getDeviceTypes() { UNION SELECT 4 as dev_Order, "Phone" UNION SELECT 4 as dev_Order, "Radio" + -- network devices UNION SELECT 5 as dev_Order, "AP" - UNION SELECT 5 as dev_Order, "NAS" + UNION SELECT 5 as dev_Order, "Gateway" + UNION SELECT 5 as dev_Order, "Powerline" + UNION SELECT 5 as dev_Order, "Switch" + UNION SELECT 5 as dev_Order, "WLAN" UNION SELECT 5 as dev_Order, "PLC" UNION SELECT 5 as dev_Order, "Router" UNION SELECT 5 as dev_Order, "USB LAN Adapter" @@ -621,6 +816,8 @@ function getDeviceTypes() { UNION SELECT 10 as dev_Order, "Other" ORDER BY 1,2'; + + $result = $db->query($sql); // arrays of rows @@ -633,8 +830,6 @@ function getDeviceTypes() { // Return json echo (json_encode ($tableData)); } - - //------------------------------------------------------------------------------ // Query the List of groups //------------------------------------------------------------------------------ @@ -761,4 +956,5 @@ function getDeviceCondition ($deviceStatus) { } } + ?> diff --git a/front/php/server/events.php b/front/php/server/events.php index 60e79478..b5450543 100644 --- a/front/php/server/events.php +++ b/front/php/server/events.php @@ -7,7 +7,13 @@ //------------------------------------------------------------------------------ // Puche 2021 pi.alert.application@gmail.com GNU GPLv3 //------------------------------------------------------------------------------ - +// ## TimeZone processing +$config_file = "../../../config/pialert.conf"; +$config_file_lines = file($config_file); +$config_file_lines_timezone = array_values(preg_grep('/^TIMEZONE\s.*/', $config_file_lines)); +$timezone_line = explode("'", $config_file_lines_timezone[0]); +$Pia_TimeZone = $timezone_line[1]; +date_default_timezone_set($Pia_TimeZone); //------------------------------------------------------------------------------ // External files @@ -46,51 +52,57 @@ function getEventsTotals() { global $db; // Request Parameters - $periodDate = getDateFromPeriod(); + $periodDate = $_REQUEST['period']; - // SQL - $SQL1 = 'SELECT Count(*) - FROM Events - WHERE eve_DateTime >= '. $periodDate; - - $SQL2 = 'SELECT Count(*) - FROM Sessions '; + $periodDateSQL = ""; + $days = ""; - // All - $result = $db->query($SQL1); - $row = $result -> fetchArray (SQLITE3_NUM); - $eventsAll = $row[0]; + switch ($periodDate) { + case '7 days': + $days = "7"; + break; + case '1 month': + $days = "30"; + break; + case '1 year': + $days = "365"; + break; + case '100 years': + $days = "3650"; //10 years + break; + default: + $days = "1"; + } - // Sessions - $result = $db->query($SQL2. ' WHERE ( ses_DateTimeConnection >= '. $periodDate .' - OR ses_DateTimeDisconnection >= '. $periodDate .' - OR ses_StillConnected = 1 ) '); - $row = $result -> fetchArray (SQLITE3_NUM); - $eventsSessions = $row[0]; + $periodDateSQL = "-".$days." day"; - // Missing - $result = $db->query($SQL2. ' WHERE (ses_DateTimeConnection IS NULL AND ses_DateTimeDisconnection >= '. $periodDate .' ) - OR (ses_DateTimeDisconnection IS NULL AND ses_StillConnected = 0 AND ses_DateTimeConnection >= '. $periodDate .' )' ); - $row = $result -> fetchArray (SQLITE3_NUM); - $eventsMissing = $row[0]; + $resultJSON = ""; - // Voided - $result = $db->query($SQL1. ' AND eve_EventType LIKE "VOIDED%" '); - $row = $result -> fetchArray (SQLITE3_NUM); - $eventsVoided = $row[0]; + // check cache if JSON available in a cookie + if(getCache("getEventsTotals".$days) != "") + { + $resultJSON = getCache("getEventsTotals".$days); + } else + { + // one query to get all numbers, whcih is quicker than multiple queries + $sql = "select + (SELECT Count(*) FROM Events WHERE eve_DateTime >= date('now', '".$periodDateSQL."')) as all_events, + (SELECT Count(*) FROM Sessions as sessions WHERE ( ses_DateTimeConnection >= date('now', '".$periodDateSQL."') OR ses_DateTimeDisconnection >= date('now', '".$periodDateSQL."') OR ses_StillConnected = 1 )) as sessions, + (SELECT Count(*) FROM Sessions WHERE ((ses_DateTimeConnection IS NULL AND ses_DateTimeDisconnection >= date('now', '".$periodDateSQL."' )) OR (ses_DateTimeDisconnection IS NULL AND ses_StillConnected = 0 AND ses_DateTimeConnection >= date('now', '".$periodDateSQL."' )))) as missing, + (SELECT Count(*) FROM Events WHERE eve_DateTime >= date('now', '".$periodDateSQL."') AND eve_EventType LIKE 'VOIDED%' ) as voided, + (SELECT Count(*) FROM Events WHERE eve_DateTime >= date('now', '".$periodDateSQL."') AND eve_EventType LIKE 'New Device' ) as new, + (SELECT Count(*) FROM Events WHERE eve_DateTime >= date('now', '".$periodDateSQL."') AND eve_EventType LIKE 'Device Down' ) as down"; - // New - $result = $db->query($SQL1. ' AND eve_EventType LIKE "New Device" '); - $row = $result -> fetchArray (SQLITE3_NUM); - $eventsNew = $row[0]; + $result = $db->query($sql); + $row = $result -> fetchArray (SQLITE3_NUM); + $resultJSON = json_encode (array ($row[0], $row[1], $row[2], $row[3], $row[4], $row[5])); - // Down - $result = $db->query($SQL1. ' AND eve_EventType LIKE "Device Down" '); - $row = $result -> fetchArray (SQLITE3_NUM); - $eventsDown = $row[0]; - - // Return json - echo (json_encode (array ($eventsAll, $eventsSessions, $eventsMissing, $eventsVoided, $eventsNew, $eventsDown))); + // save JSON result to cache + setCache("getEventsTotals".$days, $resultJSON ); + } + + // Return json + echo ($resultJSON); } @@ -217,15 +229,15 @@ function getDeviceSessions() { // Disconnection DateTime if ($row['ses_StillConnected'] == true) { - $end = '...'; + $end = '...'; } elseif ($row['ses_EventTypeDisconnection'] == '') { - $end = $row['ses_EventTypeDisconnection']; + $end = $row['ses_EventTypeDisconnection']; } else { $end = formatDate ($row['ses_DateTimeDisconnection']); } // Duration - if ($row['ses_EventTypeConnection'] == '' || $row['ses_EventTypeDisconnection'] == '') { + if ($row['ses_EventTypeConnection'] == '' || $row['ses_EventTypeConnection'] == NULL || $row['ses_EventTypeDisconnection'] == '' || $row['ses_EventTypeDisconnection'] == NULL) { $dur = '...'; } elseif ($row['ses_StillConnected'] == true) { $dur = formatDateDiff ($row['ses_DateTimeConnection'], ''); //*********** @@ -261,7 +273,6 @@ function getDevicePresence() { // Request Parameters $mac = $_REQUEST['mac']; - $periodDate = getDateFromPeriod(); $startDate = '"'. formatDateISO ($_REQUEST ['start']) .'"'; $endDate = '"'. formatDateISO ($_REQUEST ['end']) .'"'; @@ -276,7 +287,7 @@ function getDevicePresence() { END AS ses_DateTimeConnectionCorrected, CASE - WHEN ses_EventTypeDisconnection = "" THEN + WHEN ses_EventTypeDisconnection = "" OR ses_EventTypeDisconnection = NULL THEN (SELECT MIN(ses_DateTimeConnection) FROM Sessions AS SES2 WHERE SES2.ses_MAC = SES1.ses_MAC AND SES2.ses_DateTimeConnection > SES1.ses_DateTimeConnection) ELSE ses_DateTimeDisconnection END AS ses_DateTimeDisconnectionCorrected @@ -290,13 +301,14 @@ function getDevicePresence() { // arrays of rows while ($row = $result -> fetchArray (SQLITE3_ASSOC)) { // Event color - if ($row['ses_EventTypeConnection'] == '' || $row['ses_EventTypeDisconnection'] == '') { - $color = '#f39c12'; - } elseif ($row['ses_StillConnected'] == 1 ) { - $color = '#00a659'; - } else { - $color = '#0073b7'; - } + if ($row['ses_EventTypeConnection'] == '' || $row['ses_EventTypeDisconnection'] == '') { + $color = '#f39c12'; + } elseif ($row['ses_StillConnected'] == 1 ) { + $color = '#00a659'; + } else { + $color = '#0073b7'; + } + // tooltip $tooltip = 'Connection: ' . formatEventDate ($row['ses_DateTimeConnection'], $row['ses_EventTypeConnection']) . chr(13) . @@ -333,7 +345,7 @@ function getEventsCalendar() { $startDate = '"'. $_REQUEST ['start'] .'"'; $endDate = '"'. $_REQUEST ['end'] .'"'; - // SQL + // SQL $SQL = 'SELECT ses_MAC, ses_EventTypeConnection, ses_DateTimeConnection, ses_EventTypeDisconnection, ses_DateTimeDisconnection, ses_IP, ses_AdditionalInfo, ses_StillConnected, @@ -358,12 +370,12 @@ function getEventsCalendar() { while ($row = $result -> fetchArray (SQLITE3_ASSOC)) { // Event color if ($row['ses_EventTypeConnection'] == '' || $row['ses_EventTypeDisconnection'] == '') { - $color = '#f39c12'; - } elseif ($row['ses_StillConnected'] == 1 ) { - $color = '#00a659'; - } else { - $color = '#0073b7'; - } + $color = '#f39c12'; + } elseif ($row['ses_StillConnected'] == 1 ) { + $color = '#00a659'; + } else { + $color = '#0073b7'; + } // tooltip $tooltip = 'Connection: ' . formatEventDate ($row['ses_DateTimeConnection'], $row['ses_EventTypeConnection']) . chr(13) . diff --git a/front/php/server/util.php b/front/php/server/util.php index a4f345f3..58e75f4f 100644 --- a/front/php/server/util.php +++ b/front/php/server/util.php @@ -8,6 +8,13 @@ // Puche 2021 pi.alert.application@gmail.com GNU GPLv3 //------------------------------------------------------------------------------ +// ## TimeZone processing +$config_file = "../../../config/pialert.conf"; +$config_file_lines = file($config_file); +$config_file_lines_timezone = array_values(preg_grep('/^TIMEZONE\s.*/', $config_file_lines)); +$timezone_line = explode("'", $config_file_lines_timezone[0]); +$Pia_TimeZone = $timezone_line[1]; +date_default_timezone_set($Pia_TimeZone); //------------------------------------------------------------------------------ // Formatting data functions @@ -58,4 +65,62 @@ function logServerConsole ($text) { $y = $x['__________'. $text .'__________']; } +function getNetworkTypes(){ + + $array = array( + "AP", "Gateway", "Powerline", "Switch", "WLAN", "PLC", "Router","USB LAN Adapter", "USB WIFI Adapter" + ); + + return $array; +} + +function getDevicesColumns(){ + + $columns = ["dev_MAC", + "dev_Name", + "dev_Owner", + "dev_DeviceType", + "dev_Vendor", + "dev_Favorite", + "dev_Group", + "dev_Comments", + "dev_FirstConnection", + "dev_LastConnection", + "dev_LastIP", + "dev_StaticIP", + "dev_ScanCycle", + "dev_LogEvents", + "dev_AlertEvents", + "dev_AlertDeviceDown", + "dev_SkipRepeated", + "dev_LastNotification", + "dev_PresentLastScan", + "dev_NewDevice", + "dev_Location", + "dev_Archived", + "dev_Network_Node_port", + "dev_Network_Node_MAC_ADDR"]; + + return $columns; +} + +//------------------------------------------------------------------------------ +// Simple cookie cache +//------------------------------------------------------------------------------ +function getCache($key) { + if( isset($_COOKIE[$key])) + { + return $_COOKIE[$key]; + }else + { + return ""; + } +} + +function setCache($key, $value) { + setcookie($key, $value, time()+300, "/","", 0); // 5min cache +} + + + ?> diff --git a/front/php/templates/graph.php b/front/php/templates/graph.php index 3765820e..8b1a9751 100644 --- a/front/php/templates/graph.php +++ b/front/php/templates/graph.php @@ -1,10 +1,16 @@ query('SELECT * FROM Online_History ORDER BY Scan_Date DESC LIMIT 144'); while ($row = $results->fetchArray()) { $time_raw = explode(' ', $row['Scan_Date']); @@ -23,4 +29,5 @@ function pia_graph_devices_data($Pia_Graph_Array) { } } $db->close(); + ?> \ No newline at end of file diff --git a/front/php/templates/header.php b/front/php/templates/header.php index 064bf4d6..113764d9 100644 --- a/front/php/templates/header.php +++ b/front/php/templates/header.php @@ -88,6 +88,7 @@ if ($ENABLED_DARKMODE === True) { ?>