Merge pull request #302 from henrywhitaker3/dev-docker

This commit is contained in:
Henry Whitaker
2020-09-05 01:34:25 +01:00
committed by GitHub
4101 changed files with 223978 additions and 82220 deletions

16
.github/workflows/docker-image-dev.yml vendored Normal file
View File

@@ -0,0 +1,16 @@
name: Docker Dev
on:
push:
branches: [ dev-docker ]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Build the Docker image
run: docker build . --file Dockerfile --tag my-image-name:$(date +%s)

16
.github/workflows/docker-image-pr.yml vendored Normal file
View File

@@ -0,0 +1,16 @@
name: DockerPR
on:
pull_request:
branches: [ docker, dev-docker, alpha-docker ]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Build the Docker image
run: docker build . --file Dockerfile --tag my-image-name:$(date +%s)

View File

@@ -0,0 +1,16 @@
name: Docker Stable
on:
push:
branches: [ docker ]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Build the Docker image
run: docker build . --file Dockerfile --tag my-image-name:$(date +%s)

View File

@@ -1,9 +1,11 @@
# Speedtest Tracker
[![Docker pulls](https://img.shields.io/docker/pulls/henrywhitaker3/speedtest-tracker?style=flat-square)](https://hub.docker.com/r/henrywhitaker3/speedtest-tracker) [![last_commit](https://img.shields.io/github/last-commit/henrywhitaker3/Speedtest-Tracker?style=flat-square)](https://github.com/henrywhitaker3/Speedtest-Tracker/commits) [![issues](https://img.shields.io/github/issues/henrywhitaker3/Speedtest-Tracker?style=flat-square)](https://github.com/henrywhitaker3/Speedtest-Tracker/issues) [![commit_freq](https://img.shields.io/github/commit-activity/m/henrywhitaker3/Speedtest-Tracker?style=flat-square)](https://github.com/henrywhitaker3/Speedtest-Tracker/commits) ![version](https://img.shields.io/badge/version-v1.7.15-success?style=flat-square) [![license](https://img.shields.io/github/license/henrywhitaker3/Speedtest-Tracker?style=flat-square)](https://github.com/henrywhitaker3/Speedtest-Tracker/blob/master/LICENSE)
[![Docker pulls](https://img.shields.io/docker/pulls/henrywhitaker3/speedtest-tracker?style=flat-square)](https://hub.docker.com/r/henrywhitaker3/speedtest-tracker) [![GitHub Workflow Status](https://img.shields.io/github/workflow/status/henrywhitaker3/Speedtest-Tracker/Stable?label=master&logo=github&style=flat-square)](https://github.com/henrywhitaker3/Speedtest-Tracker/actions) [![GitHub Workflow Status](https://img.shields.io/github/workflow/status/henrywhitaker3/Speedtest-Tracker/Dev?label=dev&logo=github&style=flat-square)](https://github.com/henrywhitaker3/Speedtest-Tracker/actions) [![last_commit](https://img.shields.io/github/last-commit/henrywhitaker3/Speedtest-Tracker?style=flat-square)](https://github.com/henrywhitaker3/Speedtest-Tracker/commits) [![issues](https://img.shields.io/github/issues/henrywhitaker3/Speedtest-Tracker?style=flat-square)](https://github.com/henrywhitaker3/Speedtest-Tracker/issues) [![commit_freq](https://img.shields.io/github/commit-activity/m/henrywhitaker3/Speedtest-Tracker?style=flat-square)](https://github.com/henrywhitaker3/Speedtest-Tracker/commits) ![version](https://img.shields.io/badge/version-v1.9.6-success?style=flat-square) [![license](https://img.shields.io/github/license/henrywhitaker3/Speedtest-Tracker?style=flat-square)](https://github.com/henrywhitaker3/Speedtest-Tracker/blob/master/LICENSE)
This program runs a speedtest check every hour and graphs the results. The back-end is written in [Laravel](https://laravel.com/) and the front-end uses [React](https://reactjs.org/). It uses [Ookla's Speedtest cli](https://www.speedtest.net/apps/cli) to get the data and uses [Chart.js](https://www.chartjs.org/) to plot the results.
A demo site is available [here](https://speedtest.henrywhitaker.com).
Disclaimer: You will need to accept Ookla's [EULA](https://www.speedtest.net/about/eula) and privacy agreements in order to use this container.
![speedtest](https://user-images.githubusercontent.com/36062479/78822484-a82b8300-79ca-11ea-8525-fdeae496a0bd.gif)
@@ -14,6 +16,7 @@ Disclaimer: You will need to accept Ookla's [EULA](https://www.speedtest.net/abo
- Graph of previous speedtests going back x days
- Backup/restore data in JSON/CSV format
- Slack/Discord/Telegram notifications
- [healthchecks.io](https://healthchecks.io) integration
- Organizr integration
## Usage
@@ -76,7 +79,20 @@ Container images are configured using parameters passed at runtime (such as thos
| `-e TELEGRAM_CHAT_ID` | Optional. Telegram chat ID. |
| `-e PUID` | Optional. Supply a local user ID for volume permissions |
| `-e PGID` | Optional. Supply a local group ID for volume permissions |
| `-e AUTH` | Optional. Set to 'true' to enable authentication for the app |
### Authentication
Authentication is optional. When enabled, unauthenticated users will only be able to see the graphs and tests table. To be able to queue a new speedtest, backup/restore data and update instance settings you will need to log in. To enable authentication, pass the `AUTH=true` environment variable.
The default credentials are:
| Field | Function |
| --- | --- |
| username | admin@admin.com |
| password | password |
After enabling, you should change the password through the web UI.
## Getting the Image

View File

@@ -104,6 +104,19 @@ else
sed "s,BASE_PATH=.*,BASE_PATH=$BASE_PATH," -i.bak /config/www/.env
fi
if [ -z ${AUTH+x} ]; then
echo "AUTH variable not set. Disabling authentication"
php /config/www/artisan speedtest:auth --disable
else
if [ $AUTH == 'true' ]; then
echo "AUTH variable set. Enabling authentication"
php /config/www/artisan speedtest:auth --enable
else
echo "AUTH variable set, but not to 'true'. Disabling authentication"
php /config/www/artisan speedtest:auth --disable
fi
fi
echo "Clearing old jobs from queue"
php /config/www/artisan queue:clear
@@ -112,3 +125,4 @@ mkdir -p /config/log/speedtest
cp /defaults/crontab /etc/crontabs/root
chown -R abc:abc /config
chmod +x /config/www/app/Bin/speedtest

View File

@@ -1,9 +1,11 @@
# Speedtest Tracker
[![Docker pulls](https://img.shields.io/docker/pulls/henrywhitaker3/speedtest-tracker?style=flat-square)](https://hub.docker.com/r/henrywhitaker3/speedtest-tracker) [![last_commit](https://img.shields.io/github/last-commit/henrywhitaker3/Speedtest-Tracker?style=flat-square)](https://github.com/henrywhitaker3/Speedtest-Tracker/commits) [![issues](https://img.shields.io/github/issues/henrywhitaker3/Speedtest-Tracker?style=flat-square)](https://github.com/henrywhitaker3/Speedtest-Tracker/issues) [![commit_freq](https://img.shields.io/github/commit-activity/m/henrywhitaker3/Speedtest-Tracker?style=flat-square)](https://github.com/henrywhitaker3/Speedtest-Tracker/commits) ![version](https://img.shields.io/badge/version-v1.7.15-success?style=flat-square) [![license](https://img.shields.io/github/license/henrywhitaker3/Speedtest-Tracker?style=flat-square)](https://github.com/henrywhitaker3/Speedtest-Tracker/blob/master/LICENSE)
[![Docker pulls](https://img.shields.io/docker/pulls/henrywhitaker3/speedtest-tracker?style=flat-square)](https://hub.docker.com/r/henrywhitaker3/speedtest-tracker) [![GitHub Workflow Status](https://img.shields.io/github/workflow/status/henrywhitaker3/Speedtest-Tracker/Stable?label=master&logo=github&style=flat-square)](https://github.com/henrywhitaker3/Speedtest-Tracker/actions) [![GitHub Workflow Status](https://img.shields.io/github/workflow/status/henrywhitaker3/Speedtest-Tracker/Dev?label=dev&logo=github&style=flat-square)](https://github.com/henrywhitaker3/Speedtest-Tracker/actions) [![last_commit](https://img.shields.io/github/last-commit/henrywhitaker3/Speedtest-Tracker?style=flat-square)](https://github.com/henrywhitaker3/Speedtest-Tracker/commits) [![issues](https://img.shields.io/github/issues/henrywhitaker3/Speedtest-Tracker?style=flat-square)](https://github.com/henrywhitaker3/Speedtest-Tracker/issues) [![commit_freq](https://img.shields.io/github/commit-activity/m/henrywhitaker3/Speedtest-Tracker?style=flat-square)](https://github.com/henrywhitaker3/Speedtest-Tracker/commits) ![version](https://img.shields.io/badge/version-v1.9.6-success?style=flat-square) [![license](https://img.shields.io/github/license/henrywhitaker3/Speedtest-Tracker?style=flat-square)](https://github.com/henrywhitaker3/Speedtest-Tracker/blob/master/LICENSE)
This program runs a speedtest check every hour and graphs the results. The back-end is written in [Laravel](https://laravel.com/) and the front-end uses [React](https://reactjs.org/). It uses the [Ookla's speedtest cli](https://www.speedtest.net/apps/cli) package to get the data and uses [Chart.js](https://www.chartjs.org/) to plot the results.
A demo can be found [here](https://speedtest.henrywhitaker.com)
Disclaimer: You will need to accept Ookla's EULA and privacy agreements in order to use this container.
![speedtest](https://user-images.githubusercontent.com/36062479/78822484-a82b8300-79ca-11ea-8525-fdeae496a0bd.gif)
@@ -14,6 +16,7 @@ Disclaimer: You will need to accept Ookla's EULA and privacy agreements in order
- Graph of previous speedtests going back x days
- Backup/restore data in JSON/CSV format
- Slack/Discord/Telegram notifications
- [healthchecks.io](https://healthchecks.io) integration
- Organizr integration
## Installation & Setup
@@ -80,7 +83,21 @@ Container images are configured using parameters passed at runtime (such as thos
| `-e TELEGRAM_CHAT_ID` | Optional. Telegram chat ID. |
| `-e PUID` | Optional. Supply a local user ID for volume permissions |
| `-e PGID` | Optional. Supply a local group ID for volume permissions |
| `-e AUTH` | Optional. Set to 'true' to enable authentication for the app |
### Authentication
Authentication is optional. When enabled, unauthenticated users will only be able to see the graphs and tests table. To be able to queue a new speedtest, backup/restore data and update instance settings you will need to log in. To enable authentication, pass the `AUTH=true` environment variable in docker or run `php artisan speedtest:auth --enable` for manual installs (same command with `--disable` to turn it off).
The default credentials are:
| Field | Function |
| --- | --- |
| username | admin@admin.com |
| password | password |
After enabling, you should change the password through the web UI.
### Manual Install
For manual installtions, please follow the instrucitons [here](https://github.com/henrywhitaker3/Speedtest-Tracker/wiki/Manual-Installation).

View File

@@ -34,7 +34,7 @@ class AcceptEULACommand extends Command
/**
* Execute the console command.
*
* @return int
* @return void
*/
public function handle()
{

View File

@@ -0,0 +1,59 @@
<?php
namespace App\Console\Commands;
use App\Helpers\SettingsHelper;
use Illuminate\Console\Command;
class AuthenticationCommand extends Command
{
/**
* The name and signature of the console command.
*
* @var string
*/
protected $signature = 'speedtest:auth {--enable} {--disable}';
/**
* The console command description.
*
* @var string
*/
protected $description = 'Toggle authentication for the app';
/**
* Create a new command instance.
*
* @return void
*/
public function __construct()
{
parent::__construct();
}
/**
* Execute the console command.
*
* @return int
*/
public function handle()
{
$opts = $this->options();
if($opts['enable'] === true && $opts['disable'] === true) {
$this->warn('Please specify only ONE of --enable and --disable');
} else if($opts['enable'] === false && $opts['disable'] === false) {
$this->warn('You need to specify either --enable OR --disable');
} else {
if($opts['enable'] === true) {
$this->info('Enabling authentication');
SettingsHelper::set('auth', true);
}
if($opts['disable'] === true) {
$this->info('Disabling authentication');
SettingsHelper::set('auth', false);
}
}
}
}

View File

@@ -0,0 +1,48 @@
<?php
namespace App\Console\Commands;
use App\Auth\LoginSession;
use Carbon\Carbon;
use Illuminate\Console\Command;
use Log;
class ClearOldSessionsCommand extends Command
{
/**
* The name and signature of the console command.
*
* @var string
*/
protected $signature = 'speedtest:clear-sessions';
/**
* The console command description.
*
* @var string
*/
protected $description = 'Clear expired sessions from database';
/**
* Create a new command instance.
*
* @return void
*/
public function __construct()
{
parent::__construct();
}
/**
* Execute the console command.
*
* @return int
*/
public function handle()
{
$now = Carbon::now()->timestamp;
$sessions = LoginSession::where('expires', '<=', $now)
->delete();
$this->info('Invalidated expired sessions');
}
}

View File

@@ -34,7 +34,7 @@ class ClearQueueCommand extends Command
/**
* Execute the console command.
*
* @return int
* @return void
*/
public function handle()
{

View File

@@ -34,7 +34,7 @@ class GetConfig extends Command
/**
* Execute the console command.
*
* @return int
* @return void
*/
public function handle()
{

View File

@@ -34,7 +34,7 @@ class SetSlackWebhook extends Command
/**
* Execute the console command.
*
* @return int
* @return void
*/
public function handle()
{

View File

@@ -36,7 +36,7 @@ class SetTelegramOptions extends Command
/**
* Execute the console command.
*
* @return int
* @return void
*/
public function handle()
{

View File

@@ -34,7 +34,7 @@ class SpeedtestCommand extends Command
/**
* Runs a speedtest synchroonously and displays the results..
*
* @return null
* @return void
*/
public function handle()
{

View File

@@ -35,7 +35,7 @@ class SpeedtestLatestCommand extends Command
/**
* Prints the latest speedtest values.
*
* @return null
* @return void
*/
public function handle()
{

View File

@@ -33,7 +33,7 @@ class SpeedtestVersionCommand extends Command
/**
* Execute the console command.
*
* @return mixed
* @return void
*/
public function handle()
{

View File

@@ -34,7 +34,7 @@ class TestNotification extends Command
/**
* Execute the console command.
*
* @return int
* @return void
*/
public function handle()
{

View File

@@ -28,8 +28,9 @@ class Kernel extends ConsoleKernel
*/
protected function schedule(Schedule $schedule)
{
$schedule->job(new SpeedtestJob)->cron(SettingsHelper::get('schedule')['value']);
$schedule->job(new SpeedtestJob(true, config('integrations')))->cron(SettingsHelper::get('schedule')['value']);
$schedule->command('speedtest:overview')->cron('0 ' . SettingsHelper::get('speedtest_overview_time')->value . ' * * *');
$schedule->command('speedtest:clear-sessions')->everyMinute();
}
/**

View File

@@ -15,6 +15,8 @@ class SpeedtestCompleteEvent
{
use Dispatchable, InteractsWithSockets, SerializesModels;
public $speedtest;
/**
* Create a new event instance.
*

View File

@@ -0,0 +1,13 @@
<?php
namespace App\Facades;
use Illuminate\Support\Facades\Facade;
class HealthchecksFacade extends Facade
{
protected static function getFacadeAccessor()
{
return 'healthcheck';
}
}

View File

@@ -3,6 +3,7 @@
namespace App\Helpers;
use App\Speedtest;
use Cache;
use DateTime;
use Exception;
use Illuminate\Support\Facades\Log;
@@ -26,13 +27,13 @@ class BackupHelper {
case 'csv':
$data = Speedtest::get();
$csv = Storage::disk('local')->getDriver()->getAdapter()->getPathPrefix() . $name . '.csv';
$csv = storage_path() . '/app/' . $name . '.csv';
$name = $name . '.csv';
$handle = fopen($csv, 'w+');
fputcsv($handle, array('id', 'ping', 'download', 'upload', 'created_at', 'updated_at'));
fputcsv($handle, array('id', 'ping', 'download', 'upload', 'server_id', 'server_name', 'server_host', 'url', 'scheduled', 'failed', 'created_at', 'updated_at'));
foreach($data as $d) {
fputcsv($handle, array($d->id, $d->ping, $d->download, $d->upload, $d->created_at, $d->updated_at));
fputcsv($handle, BackupHelper::createCSVBackupArray($d));
}
fclose($handle);
@@ -55,29 +56,32 @@ class BackupHelper {
*
* @param array|string $array Backup data
* @param string $format json|csv
* @return boolean
* @return bool
*/
public static function restore($array, $format)
{
Cache::flush();
if($format == 'json') {
foreach($array as $test) {
try {
$st = Speedtest::create([
'ping' => $test['ping'],
'download' => $test['download'],
'upload' => $test['upload'],
'created_at' => $test['created_at'],
]);
$data = BackupHelper::backupJSONToArray($test);
if($data === false) {
continue;
}
Speedtest::create($data);
} catch(Exception $e) {
Log::error($e);
continue;
}
}
return true;
} else if($format == 'csv') {
$csv = explode(PHP_EOL, $array);
$headers = 'id,ping,download,upload,created_at,updated_at';
if($csv[0] != $headers) {
Log::error('Incorrect CSV format');
$headers = BackupHelper::validateCSV($csv[0]);
if($headers === false) {
return false;
}
@@ -85,14 +89,14 @@ class BackupHelper {
$csv = array_values($csv);
for($i = 0; $i < sizeof($csv); $i++) {
$e = explode(',', $csv[$i]);
$data = BackupHelper::backupCSVToArray($csv[$i]);
if($data === false) {
continue;
}
try {
$st = Speedtest::create([
'ping' => $e[1],
'download' => $e[2],
'upload' => $e[3],
'created_at' => substr($e[4], 1, -1),
]);
Speedtest::create($data);
} catch(Exception $e) {
Log::error($e);
continue;
@@ -101,5 +105,182 @@ class BackupHelper {
return true;
}
return false;
}
/**
* Validate a CSV file passed for restore
*
* @param String $csv The line containing the CSV headers
* @return bool|string
*/
public static function validateCSV(String $csv)
{
$headers = [
'old' => 'id,ping,download,upload,created_at,updated_at',
'new' => 'id,ping,download,upload,server_id,server_name,server_host,url,scheduled,failed,created_at,updated_at',
];
$backupHeaders = null;
foreach($headers as $key => $h) {
if($csv == $h) {
$backupHeaders = $key;
}
}
if($backupHeaders === null) {
Log::info('Incorrect CSV format');
return false;
}
return $backupHeaders;
}
/**
* Return an array from the raw CSV data
*
* @param String $line The line of CSV data
* @param String $header The type of backup header
* @return array|bool
*/
public static function backupCSVToArray(String $line, String $header = 'new')
{
$basic = explode(',', $line);
if($header == 'old') {
$array = [
'ping' => $basic[1],
'download' => $basic[2],
'upload' => $basic[3],
'created_at' => substr($basic[4], 1, -1),
];
}
if($header == 'new') {
$array = [
'ping' => $basic[1],
'download' => $basic[2],
'upload' => $basic[3],
'server_id' => $basic[4],
'server_name' => $basic[5],
'server_host' => $basic[6],
'url' => $basic[7],
'scheduled' => $basic[8],
'failed' => $basic[9],
'created_at' => substr($basic[10], 1, -1),
];
}
if(!isset($array)) {
return false;
}
return BackupHelper::cleanRestoreDataArray($array);
}
/**
* Clean an array, setting values with '' to null
*
* @param array $array
* @return array
*/
public static function cleanRestoreDataArray(array $array)
{
foreach($array as $key => $val) {
if($val === '') {
$array[$key] = null;
}
}
return $array;
}
/**
* Return an array from the JSON data
*
* @param array $json json_decoded data
* @return array|bool
*/
public static function backupJSONToArray($json)
{
$required = [
'ping',
'upload',
'download',
'created_at',
];
$extras = [
'server_id',
'server_name',
'server_host',
'url',
'failed',
'scheduled'
];
$array = [];
foreach($required as $req) {
if(!array_key_exists($req, $json)) {
return false;
}
$val = $json[$req];
if($val === '') {
$val = null;
}
$array[$req] = $val;
}
foreach($extras as $extra) {
if(array_key_exists($extra, $json)) {
$val = $json[$extra];
if($val === '') {
$val = null;
}
$array[$extra] = $val;
}
}
return $array;
}
/**
* Return an array to store in CSV
*
* @param Speedtest $test
* @return array
*/
public static function createCSVBackupArray(Speedtest $test)
{
$data = [
$test->id,
$test->ping,
$test->download,
$test->upload,
$test->server_id,
$test->server_name,
$test->server_host,
$test->url,
$test->scheduled,
$test->failed,
$test->created_at,
$test->updated_at
];
foreach($data as $key => $val) {
if(strpos($val, ',') !== false) {
$val = str_replace(',', ' -', $val);
}
$data[$key] = $val;
}
return $data;
}
}

View File

@@ -0,0 +1,67 @@
<?php
namespace App\Helpers;
class NotificationsHelper {
/**
* Parse $errors and format message
*
* @param array $errors
* @return String
*/
public static function formatPercentageThresholdMessage(array $errors)
{
$msg = NotificationsHelper::thresholdMessageStart($errors);
$msg = $msg . 'exceeded the percentage threshold';
return $msg;
}
/**
* Parse $errors and format message
*
* @param array $errors
* @return String
*/
public static function formatAbsoluteThresholdMessage(array $errors)
{
$msg = NotificationsHelper::thresholdMessageStart($errors);
$msg = $msg . 'exceeded the absolute threshold';
return $msg;
}
/**
* Iterate through errors to format message
*
* @param array $errors
* @return String
*/
public static function thresholdMessageStart(array $errors)
{
$msg = 'For the latest speedtest, the ';
for($i = 0; $i < sizeof($errors); $i++) {
$key = $errors[$i];
$msg = $msg . $key;
if(sizeof($errors) > 1 && $i < (sizeof($errors) - 1)) {
$msg = $msg . ', ';
}
}
if($msg[-1] != '') {
$msg = $msg . ' ';
}
if(sizeof($errors) > 1) {
$msg = $msg . 'values ';
} else {
$msg = $msg . 'value ';
}
return $msg;
}
}

View File

@@ -4,6 +4,7 @@ namespace App\Helpers;
use App\Events\TestNotificationEvent;
use App\Setting;
use Cache;
use Carbon\Carbon;
class SettingsHelper {
@@ -12,7 +13,7 @@ class SettingsHelper {
* Get a Setting object by name
*
* @param String $name The name field in the setting table
* @return \App\Setting|boolean $name The Setting object. Returns false if no mathcing obj.
* @return \App\Setting|bool|array $name The Setting object. Returns false if no mathcing obj.
*/
public static function get(String $name)
{
@@ -32,7 +33,7 @@ class SettingsHelper {
* Create / update value for Setting object.
*
* @param String $name Name of setting
* @param String $value Value of setting
* @param String|bool $value Value of setting
* @return \App\Setting
*/
public static function set(String $name, $value)
@@ -53,6 +54,10 @@ class SettingsHelper {
]);
}
if($name == 'show_failed_tests_on_graph') {
Cache::flush();
}
return $setting;
}
@@ -145,7 +150,8 @@ class SettingsHelper {
'slack_webhook' => SettingsHelper::settingIsEditable('slack_webhook'),
'telegram_bot_token' => SettingsHelper::settingIsEditable('telegram_bot_token'),
'telegram_chat_id' => SettingsHelper::settingIsEditable('telegram_chat_id'),
]
],
'auth' => (bool)SettingsHelper::get('auth')->value
];
}
@@ -153,7 +159,7 @@ class SettingsHelper {
* Send test notification to agents
*
* @param boolean|string $agent
* @return void
* @return bool
*/
public static function testNotification($agent = true)
{
@@ -168,5 +174,28 @@ class SettingsHelper {
event(new TestNotificationEvent([ $agent ]));
return true;
}
return false;
}
public static function loadIntegrationConfig()
{
$settings = [
'healthchecks_enabled' => (bool)SettingsHelper::get('healthchecks_enabled')->value,
'healthchecks_uuid' => SettingsHelper::get('healthchecks_uuid')->value,
'slack_webhook' => SettingsHelper::get('slack_webhook')->value,
'telegram_bot_token' => SettingsHelper::get('telegram_bot_token')->value,
'telegram_chat_id' => SettingsHelper::get('telegram_chat_id')->value,
];
foreach($settings as $key => $value) {
$key = 'integrations.' . $key;
if($value === "") {
$value = null;
}
config()->set([ $key => $value ]);
}
}
}

View File

@@ -5,10 +5,12 @@ namespace App\Helpers;
use App\Speedtest;
use Carbon\Carbon;
use Exception;
use Henrywhitaker3\Healthchecks\Healthchecks;
use Illuminate\Support\Facades\File;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\Log;
use InvalidArgumentException;
use JsonException;
class SpeedtestHelper {
@@ -17,7 +19,7 @@ class SpeedtestHelper {
* Runs/processes speedtest output to created a Speedtest object
*
* @param boolean|string $output If false, new speedtest runs. If anything else, will try to parse as JSON for speedtest results.
* @return \App\Speedtest|boolean
* @return \App\Speedtest|bool
*/
public static function runSpeedtest($output = false, $scheduled = true)
{
@@ -51,7 +53,7 @@ class SpeedtestHelper {
$test = false;
}
if(!$test) {
if($test == false) {
Speedtest::create([
'ping' => 0,
'upload' => 0,
@@ -59,9 +61,7 @@ class SpeedtestHelper {
'failed' => true,
'scheduled' => $scheduled,
]);
}
if(!isset($test) || $test == false) {
return false;
}
@@ -142,14 +142,14 @@ class SpeedtestHelper {
/**
* Parses network speeds and return converted to Mbps
*
* @param array $input
* @param string $input
* @return array
*/
public static function parseUnits($input)
{
$input = explode(' ', $input);
$val = $input[0];
$val = (float)$input[0];
$unit = explode('/', $input[1])[0];
switch($unit) {
@@ -228,7 +228,7 @@ class SpeedtestHelper {
$range = [
Carbon::today()
];
for($i = 0; $i < $days; $i++) {
for($i = 0; $i < ($days - 1); $i++) {
$prev = end($range);
$new = $prev->copy()->subDays(1);
array_push($range, $new);
@@ -256,15 +256,19 @@ class SpeedtestHelper {
/**
* Create a backup of the SQLite database
*
* @return boolean
* @return null|boolean
*/
public static function dbBackup()
{
if(env('DB_CONNECTION') === 'sqlite') {
if(env('DB_DATABASE') !== null) {
$current = env('DB_DATABASE');
if(File::copy($current, $current . '.bak')) {
return true;
try {
if(File::copy($current, $current . '.bak')) {
return true;
}
}catch(Exception $e) {
return false;
}
}
@@ -277,30 +281,97 @@ class SpeedtestHelper {
/**
* Delete all speedtests from the database
*
* @return boolean|string
* @return array
*/
public static function deleteAll()
{
Cache::flush();
if(SpeedtestHelper::dbBackup() !== false) {
if(sizeof(Speedtest::whereNotNull('id')->get()) > 0) {
if(Speedtest::whereNotNull('id')->delete()) {
return [
'success' => true,
];
}
SpeedtestHelper::dbBackup();
if(sizeof(Speedtest::whereNotNull('id')->get()) > 0) {
if(Speedtest::whereNotNull('id')->delete()) {
return [
'success' => true,
];
}
return [
'success' => true,
];
}
return [
'success' => false,
'msg' => 'There was an error backing up the database. No speedtests have been deleted.'
'success' => true,
];
}
/**
* Work out if a test is lower than the threshold for historic tests
*
* @param String $type
* @param Speedtest $test
* @return array
*/
public static function testIsLowerThanThreshold(String $type, Speedtest $test)
{
if($type == 'percentage') {
$avg = Speedtest::select(DB::raw('AVG(ping) as ping, AVG(download) as download, AVG(upload) as upload'))
->where('failed', false)
->get()
->toArray()[0];
$threshold = SettingsHelper::get('threshold_alert_percentage')->value;
if($threshold == '') {
return [];
}
$errors = [];
foreach($avg as $key => $value) {
if($key == 'ping') {
$threshold = (float)$value * (1 + ( $threshold / 100 ));
if($test->$key > $threshold) {
array_push($errors, $key);
}
} else {
$threshold = (float)$value * (1 - ( $threshold / 100 ));
if($test->$key < $threshold) {
array_push($errors, $key);
}
}
}
return $errors;
}
if($type == 'absolute') {
$thresholds = [
'download' => SettingsHelper::get('threshold_alert_absolute_download')->value,
'upload' => SettingsHelper::get('threshold_alert_absolute_upload')->value,
'ping' => SettingsHelper::get('threshold_alert_absolute_ping')->value,
];
$errors = [];
foreach($thresholds as $key => $value) {
if($value == '') {
continue;
}
if($key == 'ping') {
if($test->$key > $value) {
array_push($errors, $key);
}
} else {
if($test->$key < $value) {
array_push($errors, $key);
}
}
}
return $errors;
}
throw new InvalidArgumentException();
}
}

View File

@@ -13,38 +13,52 @@ class UpdateHelper {
/**
* URL of updates
*
* @var string
* @var string|bool
*/
public $url;
/**
* Current app version number
*
* @var string
* @var string|bool
*/
public $currentVersion;
/**
* Latest app version number
*
* @var string|bool
*/
public $latestVersion;
/**
* Username of GitHub repo
*
* @var string
* @var string|bool
*/
public $user;
/**
* Name of GitHub repo
*
* @var string
* @var string|bool
*/
public $repo;
/**
* Branch of GitHub repo
*
* @var string
* @var string|bool
*/
public $branch;
/**
* Store download
*
* @var string|null
*/
public $download;
function __construct() {
$this->currentVersion = config('speedtest.version');
$this->user = config('speedtest.user');
@@ -87,7 +101,7 @@ class UpdateHelper {
/**
* Gets the latest version number from GitHub
*
* @return array [ repo, branch, version ]
* @return array|bool [ repo, branch, version ]
*/
public function checkLatestVersion()
{
@@ -256,7 +270,6 @@ class UpdateHelper {
$zip->open($backupZip, ZipArchive::CREATE | ZipArchive::OVERWRITE);
// Create recursive directory iterator
/** @var SplFileInfo[] $files */
$files = new RecursiveIteratorIterator(
new RecursiveDirectoryIterator($rootPath),
RecursiveIteratorIterator::LEAVES_ONLY

View File

@@ -8,11 +8,14 @@ use App\Helpers\EmailVerificationHelper;
use Illuminate\Support\Facades\Auth;
use App\Http\Controllers\Controller;
use App\LoginSession;
use App\Rules\CurrentPasswordMatches;
use App\User;
use DateTime;
use Hash;
use Illuminate\Support\Facades\Request as RequestFacade;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Validator;
use Log;
use Ramsey\Uuid\Uuid;
class AuthController extends Controller
@@ -164,6 +167,10 @@ class AuthController extends Controller
[ 'expires', '>', time() ]
])->get();
$sessions = $sessions->map(function ($item) {
return collect($item)->forget(['token']);
});
return response()->json([
'method' => 'get auth sessions',
'response' => $sessions
@@ -211,4 +218,36 @@ class AuthController extends Controller
'success' => true,
], 200);
}
public function changePassword(Request $request)
{
$rules = [
'currentPassword' => [ 'string', 'required', new CurrentPasswordMatches() ],
'newPassword' => [ 'required', 'string', 'confirmed', 'min:8' ],
'logoutDevices' => [ 'required', 'bool' ]
];
$validator = Validator::make($request->all(), $rules);
if($validator->fails()) {
return response()->json([
'method' => 'reset password',
'success' => false,
'error' => $validator->errors()
], 403);
}
$user = Auth::user();
$user->password = $request->newPassword;
$user->save();
if($request->logoutDevices == true) {
AuthLoginSession::where('user_id', $user->id)->update([ 'active' => false ]);
}
return response()->json([
'method' => 'reset password',
'success' => true
], 200);
}
}

View File

@@ -3,19 +3,28 @@
namespace App\Http\Controllers;
use App\Helpers\BackupHelper;
use App\Helpers\SettingsHelper;
use DateTime;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Storage;
use Illuminate\Support\Facades\Validator;
use Illuminate\Http\JsonResponse;
class BackupController extends Controller
{
public function __construct()
{
if((bool)SettingsHelper::get('auth')->value === true) {
$this->middleware('auth:api');
}
}
/**
* Get backup of speedtests
*
* @param Request $request
* @return file
* @return mixed|JsonResponse
*/
public function backup(Request $request)
{
@@ -36,7 +45,7 @@ class BackupController extends Controller
* Retore from a backup
*
* @param Request $request
* @return Response
* @return JsonResponse
*/
public function restore(Request $request)
{

View File

@@ -0,0 +1,84 @@
<?php
namespace App\Http\Controllers;
use App\Helpers\SettingsHelper;
use Exception;
use Healthcheck;
use Henrywhitaker3\Healthchecks\Exceptions\HealthchecksUuidNotFoundException;
use Henrywhitaker3\Healthchecks\Healthchecks;
use Illuminate\Http\Request;
use Illuminate\Http\JsonResponse;
use Ramsey\Uuid\Exception\InvalidUuidStringException;
class IntegrationsController extends Controller
{
public function __construct()
{
if((bool)SettingsHelper::get('auth')->value === true) {
$this->middleware('auth:api');
}
}
/**
* Test the healthchecks config
*
* @return JsonResponse
*/
public function testHealthchecks(String $method)
{
$methodResp = 'test healthchecks \'' . $method . '\' endpoint';
try {
// SettingsHelper::loadIntegrationConfig();
if($method == 'success') {
Healthcheck::success();
}
if($method == 'fail') {
Healthcheck::fail();
}
if($method == 'start') {
Healthcheck::start();
}
return response()->json([
'method' => $methodResp,
'success' => true
], 200);
} catch(InvalidUuidStringException $e) {
return response()->json([
'method' => $methodResp,
'success' => false,
'error' => 'Invalid UUID'
], 422);
} catch(HealthchecksUuidNotFoundException $e) {
return response()->json([
'method' => $methodResp,
'success' => false,
'error' => 'UUID not found'
], 404);
} catch(Exception $e) {
return response()->json([
'method' => $methodResp,
'success' => false,
'error' => $e->getMessage()
], 422);
}
}
/**
* Trigger a test of all notification agents
*
* @return JsonResponse
*/
public function testNotification()
{
SettingsHelper::testNotification();
return response()->json([
'method' => 'test notification agents'
], 200);
}
}

View File

@@ -8,14 +8,23 @@ use App\Setting;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Log;
use Illuminate\Support\Facades\Validator;
use Illuminate\Http\JsonResponse;
use Illuminate\Support\Collection;
class SettingsController extends Controller
{
public function __construct()
{
if((bool)SettingsHelper::get('auth')->value === true) {
$this->middleware('auth:api')
->except([ 'config' ]);
}
}
/**
* Return all settings
*
* @return array
* @return Collection
*/
public function index()
{
@@ -37,7 +46,7 @@ class SettingsController extends Controller
* Store/update a setting
*
* @param Request $request
* @return Response
* @return JsonResponse
*/
public function store(Request $request)
{
@@ -72,7 +81,7 @@ class SettingsController extends Controller
* Bulk store/update a setting
*
* @param Request $request
* @return Response
* @return JsonResponse
*/
public function bulkStore(Request $request)
{
@@ -92,11 +101,10 @@ class SettingsController extends Controller
$settings = [];
foreach($request->data as $d) {
if(!isset($d['value']) || $d['value'] == null) {
$d['value'] = '';
$d['value'] = '';
}
if($d['name'] == 'speedtest_overview_time') {
$ok = [ '00', '01', '02', '03', '04', '05', '06', '07', '08', '09', '10', '11', '12', '13', '14', '15', '16', '17', '18', '19', '20', '21', '22', '23' ];
if(!in_array($d['value'], $ok)) {
return response()->json([
@@ -134,13 +142,4 @@ class SettingsController extends Controller
{
return SettingsHelper::getConfig();
}
public function testNotification()
{
SettingsHelper::testNotification();
return response()->json([
'method' => 'test notificaiton agents'
], 200);
}
}

View File

@@ -2,6 +2,7 @@
namespace App\Http\Controllers;
use App\Helpers\SettingsHelper;
use App\Helpers\SpeedtestHelper;
use App\Jobs\SpeedtestJob;
use App\Speedtest;
@@ -11,14 +12,22 @@ use Illuminate\Http\Request;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\Validator;
use Illuminate\Http\JsonResponse;
class SpeedtestController extends Controller
{
public function __construct()
{
if((bool)SettingsHelper::get('auth')->value === true) {
$this->middleware('auth:api')
->only([ 'run', 'delete', 'deleteAll' ]);
}
}
/**
* Returns paginated list of speedtests
*
* @return Response
* @return JsonResponse
*/
public function index()
{
@@ -35,7 +44,7 @@ class SpeedtestController extends Controller
* Returns speedtest going back 'x' days
*
* @param int $days
* @return void
* @return JsonResponse
*/
public function time($days)
{
@@ -54,6 +63,14 @@ class SpeedtestController extends Controller
$ttl = Carbon::now()->addDays(1);
$data = Cache::remember('speedtest-days-' . $days, $ttl, function () use ($days) {
$showFailed = (bool)SettingsHelper::get('show_failed_tests_on_graph')->value;
if($showFailed === true) {
return Speedtest::where('created_at', '>=', Carbon::now()->subDays($days))
->orderBy('created_at', 'asc')
->get();
}
return Speedtest::where('created_at', '>=', Carbon::now()->subDays($days))
->where('failed', false)
->orderBy('created_at', 'asc')
@@ -71,7 +88,7 @@ class SpeedtestController extends Controller
* Returns speedtest failure rate going back 'x' days
*
* @param int $days
* @return void
* @return JsonResponse
*/
public function fail($days)
{
@@ -100,7 +117,7 @@ class SpeedtestController extends Controller
/**
* Return latest speedtest
*
* @return Response
* @return JsonResponse
*/
public function latest()
{
@@ -130,12 +147,13 @@ class SpeedtestController extends Controller
/**
* Queue a new speedtest
*
* @return Response
* @return JsonResponse
*/
public function run()
{
try {
$data = SpeedtestJob::dispatch(false);
SettingsHelper::loadIntegrationConfig();
$data = SpeedtestJob::dispatch(false, config('integrations'));
return response()->json([
'method' => 'run speedtest',
'data' => 'a new speedtest has been added to the queue'
@@ -151,7 +169,7 @@ class SpeedtestController extends Controller
/**
* Delete all speedtests from db
*
* @return Response
* @return JsonResponse
*/
public function deleteAll()
{
@@ -175,7 +193,7 @@ class SpeedtestController extends Controller
* Delete a specific speedtest from the database
*
* @param Speedtest $speedtest
* @return boolean
* @return JsonResponse
*/
public function delete(Speedtest $speedtest)
{

View File

@@ -2,17 +2,25 @@
namespace App\Http\Controllers;
use App\Helpers\SettingsHelper;
use Exception;
use Updater;
use Illuminate\Http\Request;
use Illuminate\Http\JsonResponse;
class UpdateController extends Controller
{
public function __construct()
{
if((bool)SettingsHelper::get('auth')->value === true) {
$this->middleware('auth:api');
}
}
/**
* Check for new update
*
* @return Response
* @return JsonResponse
*/
public function checkForUpdate()
{
@@ -25,7 +33,7 @@ class UpdateController extends Controller
/**
* Download new update
*
* @return Response
* @return JsonResponse
*/
public function downloadUpdate()
{
@@ -47,7 +55,7 @@ class UpdateController extends Controller
/**
* Trigger update extraction
*
* @return Response
* @return JsonResponse
*/
public function extractUpdate()
{
@@ -69,22 +77,22 @@ class UpdateController extends Controller
/**
* Trigger update file move
*
* @return Response
* @return JsonResponse
*/
public function moveUpdate()
{
$cp = Updater::updateFiles();
Updater::updateFiles();
return response()->json([
'method' => 'copy latest version',
'success' => $cp,
'success' => null,
], 200);
}
/**
* Get local changelog
*
* @return Response
* @return JsonResponse
*/
public function changelog()
{

View File

@@ -17,5 +17,7 @@ class Authenticate extends Middleware
if (! $request->expectsJson()) {
return route('auth.login');
}
return null;
}
}

View File

@@ -4,7 +4,11 @@ namespace App\Jobs;
use App\Events\SpeedtestCompleteEvent;
use App\Events\SpeedtestFailedEvent;
use App\Helpers\SettingsHelper;
use App\Helpers\SpeedtestHelper;
use Exception;
use Healthcheck;
use Henrywhitaker3\Healthchecks\Healthchecks;
use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Bus\Dispatchable;
@@ -16,16 +20,29 @@ class SpeedtestJob implements ShouldQueue
{
use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
/**
* Scheduled bool
*
* @var bool
*/
private $scheduled;
/**
* Integrations config array
*
* @var array
*/
private $config;
/**
* Create a new job instance.
*
* @return void
*/
public function __construct($scheduled = true)
public function __construct($scheduled = true, $config = [])
{
$this->scheduled = $scheduled;
$this->config = $config;
}
/**
@@ -35,13 +52,50 @@ class SpeedtestJob implements ShouldQueue
*/
public function handle()
{
if($this->config['healthchecks_enabled'] === true) {
$this->healthcheck('start');
}
$output = SpeedtestHelper::output();
$speedtest = SpeedtestHelper::runSpeedtest($output, $this->scheduled);
if($speedtest == false) {
if($this->config['healthchecks_enabled'] === true) {
$this->healthcheck('fail');
}
event(new SpeedtestFailedEvent());
} else {
if($this->config['healthchecks_enabled'] === true) {
$this->healthcheck('success');
}
event(new SpeedtestCompleteEvent($speedtest));
}
return $speedtest;
}
/**
* Wrapper to reduce duplication of try/catch for hc
*
* @param String $method
* @return void
*/
private function healthcheck(String $method)
{
try {
$hc = new Healthchecks(SettingsHelper::get('healthchecks_uuid')->value);
if($method === 'start') {
$hc->start();
}
if($method === 'success') {
$hc->success();
}
if($method === 'fail') {
$hc->fail();
}
} catch(Exception $e) {
Log::error($e->getMessage());
}
}
}

View File

@@ -3,8 +3,13 @@
namespace App\Listeners;
use App\Helpers\SettingsHelper;
use App\Helpers\SpeedtestHelper;
use App\Notifications\SpeedtestAbsoluteThresholdNotificationSlack;
use App\Notifications\SpeedtestAbsoluteThresholdTelegram;
use App\Notifications\SpeedtestCompleteSlack;
use App\Notifications\SpeedtestCompleteTelegram;
use App\Notifications\SpeedtestPercentageThresholdNotificationSlack;
use App\Notifications\SpeedtestPercentageThresholdTelegram;
use Exception;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Queue\InteractsWithQueue;
@@ -32,9 +37,63 @@ class SpeedtestCompleteListener
*/
public function handle($event)
{
if((bool)SettingsHelper::get('threshold_alert_percentage_notifications')->value == true) {
$data = $event->speedtest;
$errors = SpeedtestHelper::testIsLowerThanThreshold('percentage', $data);
if(sizeof($errors) > 0) {
if(SettingsHelper::get('slack_webhook')->value) {
try {
Notification::route('slack', SettingsHelper::get('slack_webhook')->value)
->notify(new SpeedtestPercentageThresholdNotificationSlack($errors));
} catch(Exception $e) {
Log::notice('Your sleck webhook is invalid');
Log::notice($e);
}
}
if(SettingsHelper::get('telegram_bot_token')->value == true && SettingsHelper::get('telegram_chat_id')->value == true) {
try {
config([ 'services.telegram-bot-api' => [ 'token' => SettingsHelper::get('telegram_bot_token')->value ] ]);
Notification::route(TelegramChannel::class, SettingsHelper::get('telegram_chat_id')->value)
->notify(new SpeedtestPercentageThresholdTelegram($errors));
} catch(Exception $e) {
Log::notice('Your telegram settings are invalid');
Log::notice($e);
}
}
}
}
if((bool)SettingsHelper::get('threshold_alert_absolute_notifications')->value == true) {
$data = $event->speedtest;
$errors = SpeedtestHelper::testIsLowerThanThreshold('absolute', $data);
if(sizeof($errors) > 0) {
if(SettingsHelper::get('slack_webhook')->value) {
try {
Notification::route('slack', SettingsHelper::get('slack_webhook')->value)
->notify(new SpeedtestAbsoluteThresholdNotificationSlack($errors));
} catch(Exception $e) {
Log::notice('Your sleck webhook is invalid');
Log::notice($e);
}
}
if(SettingsHelper::get('telegram_bot_token')->value == true && SettingsHelper::get('telegram_chat_id')->value == true) {
try {
config([ 'services.telegram-bot-api' => [ 'token' => SettingsHelper::get('telegram_bot_token')->value ] ]);
Notification::route(TelegramChannel::class, SettingsHelper::get('telegram_chat_id')->value)
->notify(new SpeedtestAbsoluteThresholdTelegram($errors));
} catch(Exception $e) {
Log::notice('Your telegram settings are invalid');
Log::notice($e);
}
}
}
}
if(SettingsHelper::get('speedtest_notifications')->value == true) {
$data = $event->speedtest;
if(SettingsHelper::get('slack_webhook')) {
if(SettingsHelper::get('slack_webhook')->value) {
try {
Notification::route('slack', SettingsHelper::get('slack_webhook')->value)
->notify(new SpeedtestCompleteSlack($data));

View File

@@ -10,6 +10,7 @@ use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Support\Facades\Log;
use Illuminate\Support\Facades\Notification;
use NotificationChannels\Telegram\TelegramChannel;
class SpeedtestFailedListener
{

View File

@@ -0,0 +1,57 @@
<?php
namespace App\Notifications;
use App\Helpers\NotificationsHelper;
use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Notifications\Messages\MailMessage;
use Illuminate\Notifications\Messages\SlackMessage;
use Illuminate\Notifications\Notification;
class SpeedtestAbsoluteThresholdNotificationSlack extends Notification
{
use Queueable;
protected $errors;
/**
* Create a new notification instance.
*
* @param array $errors
* @return void
*/
public function __construct(array $errors)
{
$this->errors = $errors;
}
/**
* Get the notification's delivery channels.
*
* @param mixed $notifiable
* @return array
*/
public function via($notifiable)
{
return ['slack'];
}
/**
* Format slack notification
*
* @param mixed $notifiable
* @return SlackMessage
*/
public function toSlack($notifiable)
{
$msg = NotificationsHelper::formatAbsoluteThresholdMessage($this->errors);
return (new SlackMessage)
->warning()
->attachment(function ($attachment) use ($msg) {
$attachment->title('Speedtest absolute threshold error')
->content($msg);
});
}
}

View File

@@ -0,0 +1,58 @@
<?php
namespace App\Notifications;
use App\Helpers\NotificationsHelper;
use App\Helpers\SettingsHelper;
use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Notifications\Messages\MailMessage;
use Illuminate\Notifications\Notification;
use NotificationChannels\Telegram\TelegramChannel;
use NotificationChannels\Telegram\TelegramMessage;
class SpeedtestAbsoluteThresholdTelegram extends Notification
{
use Queueable;
private $errors;
/**
* Create a new notification instance.
*
* @return void
*/
public function __construct($errors)
{
$this->errors = $errors;
}
/**
* Get the notification's delivery channels.
*
* @param mixed $notifiable
* @return array
*/
public function via($notifiable)
{
return [
TelegramChannel::class
];
}
/**
* Format telegram notification
*
* @param mixed $notifiable
* @return TelegramMessage
*/
public function toTelegram($notifiable)
{
$msg = NotificationsHelper::formatAbsoluteThresholdMessage($this->errors);
return TelegramMessage::create()
->to(SettingsHelper::get('telegram_chat_id')->value)
->content($msg)
->options(['parse_mode' => 'Markdown']);
}
}

View File

@@ -14,6 +14,8 @@ class SpeedtestCompleteTelegram extends Notification
{
use Queueable;
public $speedtest;
/**
* Create a new notification instance.
*

View File

@@ -12,6 +12,8 @@ class SpeedtestOverviewSlack extends Notification
{
use Queueable;
public $data;
/**
* Create a new notification instance.
*

View File

@@ -14,6 +14,8 @@ class SpeedtestOverviewTelegram extends Notification
{
use Queueable;
public $data;
/**
* Create a new notification instance.
*

View File

@@ -0,0 +1,57 @@
<?php
namespace App\Notifications;
use App\Helpers\NotificationsHelper;
use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Notifications\Messages\MailMessage;
use Illuminate\Notifications\Messages\SlackMessage;
use Illuminate\Notifications\Notification;
class SpeedtestPercentageThresholdNotificationSlack extends Notification
{
use Queueable;
protected $errors;
/**
* Create a new notification instance.
*
* @param array $errors
* @return void
*/
public function __construct(array $errors)
{
$this->errors = $errors;
}
/**
* Get the notification's delivery channels.
*
* @param mixed $notifiable
* @return array
*/
public function via($notifiable)
{
return ['slack'];
}
/**
* Format slack notification
*
* @param mixed $notifiable
* @return SlackMessage
*/
public function toSlack($notifiable)
{
$msg = NotificationsHelper::formatPercentageThresholdMessage($this->errors);
return (new SlackMessage)
->warning()
->attachment(function ($attachment) use ($msg) {
$attachment->title('Speedtest percentage threshold error')
->content($msg);
});
}
}

View File

@@ -0,0 +1,58 @@
<?php
namespace App\Notifications;
use App\Helpers\NotificationsHelper;
use App\Helpers\SettingsHelper;
use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Notifications\Messages\MailMessage;
use Illuminate\Notifications\Notification;
use NotificationChannels\Telegram\TelegramChannel;
use NotificationChannels\Telegram\TelegramMessage;
class SpeedtestPercentageThresholdTelegram extends Notification
{
use Queueable;
private $errors;
/**
* Create a new notification instance.
*
* @return void
*/
public function __construct($errors)
{
$this->errors = $errors;
}
/**
* Get the notification's delivery channels.
*
* @param mixed $notifiable
* @return array
*/
public function via($notifiable)
{
return [
TelegramChannel::class
];
}
/**
* Format telegram notification
*
* @param mixed $notifiable
* @return TelegramMessage
*/
public function toTelegram($notifiable)
{
$msg = NotificationsHelper::formatAbsoluteThresholdMessage($this->errors);
return TelegramMessage::create()
->to(SettingsHelper::get('telegram_chat_id')->value)
->content($msg)
->options(['parse_mode' => 'Markdown']);
}
}

View File

@@ -0,0 +1,56 @@
<?php
namespace App\Providers;
use App\Helpers\SettingsHelper;
use Exception;
use File;
use Henrywhitaker3\Healthchecks\Healthchecks;
use Illuminate\Support\Facades\App;
use Illuminate\Support\Facades\Log;
use Illuminate\Support\ServiceProvider;
use Ramsey\Uuid\Exception\InvalidUuidStringException;
use Schema;
/**
* This class updates the integrations.php config with the relevant values
* from the databse.
*/
class IntegrationsServiceProvider extends ServiceProvider
{
/**
* Register services.
*
* @return void
*/
public function register()
{
//
}
/**
* Bootstrap services.
*
* @return void
*/
public function boot()
{
if(File::exists(env('DB_DATABASE'))) {
if(Schema::hasTable('settings')) {
$setting = SettingsHelper::get('healthchecks_uuid');
if($setting !== false) {
try {
App::bind('healthcheck', function() use ($setting) {
return new Healthchecks($setting->value);
});
} catch(InvalidUuidStringException $e) {
Log::error('Invalid healthchecks UUID');
} catch(Exception $e) {
Log::error($e->getMessage());
}
}
}
}
}
}

View File

@@ -0,0 +1,41 @@
<?php
namespace App\Rules;
use Hash;
use Illuminate\Contracts\Validation\Rule;
class CurrentPasswordMatches implements Rule
{
/**
* Create a new rule instance.
*
* @return void
*/
public function __construct()
{
//
}
/**
* Determine if the validation rule passes.
*
* @param string $attribute
* @param mixed $value
* @return bool
*/
public function passes($attribute, $value)
{
return Hash::check($value, auth()->user()->password);
}
/**
* Get the validation error message.
*
* @return string
*/
public function message()
{
return 'The current password doesn\'t match.';
}
}

View File

@@ -78,7 +78,7 @@ class User extends Authenticatable implements JWTSubject
/**
* Returns a user's login sessions
*
* @return array
* @return mixed
*/
public function sessions()
{

View File

@@ -1,4 +1,106 @@
{
"1.9.6": [
{
"description": "Clear the cache on restore.",
"link": ""
},
{
"description": "Updated dependencies.",
"link": ""
}
],
"1.9.5": [
{
"description": "Added toggle to show failed tests on graphs.",
"link": ""
},
{
"description": "Updated dependencies.",
"link": ""
}
],
"1.9.4": [
{
"description": "Changed integration config loading.",
"link": ""
},
{
"description": "Added more tests.",
"link": ""
}
],
"1.9.3": [
{
"description": "Updated dependencies.",
"link": ""
}
],
"1.9.2": [
{
"description": "Authentication bugfixes.",
"link": ""
}
],
"1.9.1": [
{
"description": "Added conditional notifications.",
"link": ""
}
],
"1.9.0": [
{
"description": "Added optional authentication.",
"link": ""
}
],
"1.8.1": [
{
"description": "Added healthchecks.io test buttons.",
"link": ""
},
{
"description": "Added close buttons to modals.",
"link": ""
},
{
"description": "Back-end config handling changes.",
"link": ""
}
],
"1.8.0": [
{
"description": "Added healthchecks.io integration.",
"link": ""
}
],
"1.7.19": [
{
"description": "Updated dependencies.",
"link": ""
}
],
"1.7.18": [
{
"description": "Fixed issue with widgets not updating when switching between failed/successful tests.",
"link": ""
},
{
"description": "Updated backup/restore functions to reflect new DB fields.",
"link": ""
}
],
"1.7.17": [
{
"description": "Updated dependencies.",
"link": ""
}
],
"1.7.16": [
{
"description": "Updated dependencies.",
"link": ""
}
],
"1.7.15": [
{
"description": "Updates for manual installs.",

View File

@@ -14,6 +14,7 @@
"fideloper/proxy": "^4.2",
"fruitcake/laravel-cors": "^2.0",
"guzzlehttp/guzzle": "^7.0",
"henrywhitaker3/healthchecks-io": "^1.0",
"laravel-notification-channels/telegram": "^0.4.0",
"laravel/framework": "^7.0",
"laravel/slack-notification-channel": "^2.0",
@@ -22,10 +23,12 @@
"tymon/jwt-auth": "^1.0"
},
"require-dev": {
"barryvdh/laravel-ide-helper": "^2.8",
"facade/ignition": "^2.0",
"fzaninotto/faker": "^1.9.1",
"mockery/mockery": "^1.3.1",
"nunomaduro/collision": "^4.1",
"nunomaduro/larastan": "^0.6.2",
"phpunit/phpunit": "^8.5"
},
"config": {

1687
conf/site/composer.lock generated

File diff suppressed because it is too large Load Diff

View File

@@ -178,6 +178,11 @@ return [
App\Providers\RouteServiceProvider::class,
App\Providers\UpdaterServiceProvider::class,
/*
* Custom providers...
*/
App\Providers\IntegrationsServiceProvider::class,
],
/*
@@ -230,6 +235,7 @@ return [
'Validator' => Illuminate\Support\Facades\Validator::class,
'View' => Illuminate\Support\Facades\View::class,
'Updater' => App\Facades\UpdaterFacade::class,
'Healthcheck' => App\Facades\HealthchecksFacade::class,
],
];

View File

@@ -0,0 +1,59 @@
<?php
return [
/*
|--------------------------------------------------------------------------
| Healthchecks enabled
|--------------------------------------------------------------------------
|
| This option defines whether healthchecks integrations are enabled
|
*/
'healthchecks_enabled' => false,
/*
|--------------------------------------------------------------------------
| Healthchecks UUID
|--------------------------------------------------------------------------
|
| This option defines the UUID for healthchecks
|
*/
'healthchecks_uuid' => null,
/*
|--------------------------------------------------------------------------
| Slack webhook
|--------------------------------------------------------------------------
|
| This option defines the slack webhook url
|
*/
'slack_webhook' => null,
/*
|--------------------------------------------------------------------------
| Telegram bot token
|--------------------------------------------------------------------------
|
| This option defines the telegram bot token
|
*/
'telegram_bot_token' => null,
/*
|--------------------------------------------------------------------------
| Telegram chat id
|--------------------------------------------------------------------------
|
| This option defines the telegram chat id
|
*/
'telegram_chat_id' => null,
];

View File

@@ -7,7 +7,7 @@ return [
|--------------------------------------------------------------------------
*/
'version' => '1.7.15',
'version' => '1.9.6',
/*
|--------------------------------------------------------------------------

View File

@@ -0,0 +1,47 @@
<?php
use App\Helpers\SettingsHelper;
use App\Setting;
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
class AddHealthchecksSettings extends Migration
{
/**
* Run the migrations.
*
* @return void
*/
public function up()
{
if(!SettingsHelper::get('healthchecks_enabled')) {
Setting::create([
'name' => 'healthchecks_enabled',
'value' => false,
'description' => 'Enable the healthchecks.io integration for speedtests.'
]);
}
if(!SettingsHelper::get('healthchecks_uuid')) {
Setting::create([
'name' => 'healthchecks_uuid',
'value' => '',
'description' => ''
]);
}
}
/**
* Reverse the migrations.
*
* @return void
*/
public function down()
{
Setting::whereIn('name', [
'healthchecks_enabled',
'healthchecks_uuid',
])->delete();
}
}

View File

@@ -0,0 +1,38 @@
<?php
use App\Helpers\SettingsHelper;
use App\Setting;
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
class AddAuthenticationSettings extends Migration
{
/**
* Run the migrations.
*
* @return void
*/
public function up()
{
if(!SettingsHelper::get('auth')) {
Setting::create([
'name' => 'auth',
'value' => false,
'description' => 'Enable authentication.'
]);
}
}
/**
* Reverse the migrations.
*
* @return void
*/
public function down()
{
Setting::whereIn('name', [
'auth',
])->delete();
}
}

View File

@@ -0,0 +1,83 @@
<?php
use App\Helpers\SettingsHelper;
use App\Setting;
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
class AddConditionalNotificationsSettings extends Migration
{
/**
* Run the migrations.
*
* @return void
*/
public function up()
{
if(!SettingsHelper::get('threshold_alert_percentage_notifications')) {
Setting::create([
'name' => 'threshold_alert_percentage_notifications',
'value' => false,
'description' => 'Enable/disable theshold percentage notifications'
]);
}
if(!SettingsHelper::get('threshold_alert_percentage')) {
Setting::create([
'name' => 'threshold_alert_percentage',
'value' => 15,
'description' => 'When any value of a speedtest is x percent lower than the average, a notification will be sent.'
]);
}
if(!SettingsHelper::get('threshold_alert_absolute_notifications')) {
Setting::create([
'name' => 'threshold_alert_absolute_notifications',
'value' => false,
'description' => 'Enable/disable absolute theshold notifications'
]);
}
if(!SettingsHelper::get('threshold_alert_absolute_download')) {
Setting::create([
'name' => 'threshold_alert_absolute_download',
'value' => '',
'description' => 'When the download is lower than this value, a notification will be sent. Leave blank to disable'
]);
}
if(!SettingsHelper::get('threshold_alert_absolute_upload')) {
Setting::create([
'name' => 'threshold_alert_absolute_upload',
'value' => '',
'description' => 'When the upload is lower than this value, a notification will be sent. Leave blank to disable'
]);
}
if(!SettingsHelper::get('threshold_alert_absolute_ping')) {
Setting::create([
'name' => 'threshold_alert_absolute_ping',
'value' => '',
'description' => 'When the ping is higher than this value, a notification will be sent. Leave blank to disable'
]);
}
}
/**
* Reverse the migrations.
*
* @return void
*/
public function down()
{
Setting::whereIn('name', [
'threshold_alert_percentage',
'threshold_alert_absolute_download',
'threshold_alert_absolute_upload',
'threshold_alert_absolute_ping',
'threshold_alert_percentage_notifications',
'threshold_alert_absolute_notifications'
])->delete();
}
}

View File

@@ -0,0 +1,38 @@
<?php
use App\Helpers\SettingsHelper;
use App\Setting;
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
class AddShowFailedTestsSetting extends Migration
{
/**
* Run the migrations.
*
* @return void
*/
public function up()
{
if(!SettingsHelper::get('show_failed_tests_on_graph')) {
Setting::create([
'name' => 'show_failed_tests_on_graph',
'value' => true,
'description' => 'If enabled, failed tests will appear on the graphs as 0.'
]);
}
}
/**
* Reverse the migrations.
*
* @return void
*/
public function down()
{
Setting::whereIn('name', [
'show_failed_tests_on_graph',
])->delete();
}
}

Binary file not shown.

1
conf/site/node_modules/.bin/concat generated vendored Symbolic link
View File

@@ -0,0 +1 @@
../concat/bin/concat

Some files were not shown because too many files have changed in this diff Show More