From 7a62b113bf63ad2e11fa219aee1f3b8c30bf7a02 Mon Sep 17 00:00:00 2001 From: Henry Whitaker Date: Mon, 3 Aug 2020 16:22:07 +0100 Subject: [PATCH] Fixed errors picked up by larastan --- app/Console/Commands/AcceptEULACommand.php | 2 +- app/Console/Commands/ClearQueueCommand.php | 2 +- app/Console/Commands/GetConfig.php | 2 +- app/Console/Commands/SetSlackWebhook.php | 2 +- app/Console/Commands/SetTelegramOptions.php | 2 +- app/Console/Commands/SpeedtestCommand.php | 2 +- .../Commands/SpeedtestLatestCommand.php | 2 +- .../Commands/SpeedtestVersionCommand.php | 2 +- app/Console/Commands/TestNotification.php | 2 +- app/Events/SpeedtestCompleteEvent.php | 2 ++ app/Helpers/BackupHelper.php | 4 ++- app/Helpers/SettingsHelper.php | 8 +++--- app/Helpers/SpeedtestHelper.php | 13 +++++---- app/Helpers/UpdateHelper.php | 27 ++++++++++++++----- app/Http/Controllers/BackupController.php | 5 ++-- app/Http/Controllers/SettingsController.php | 16 ++++++++--- app/Http/Controllers/SpeedtestController.php | 15 ++++++----- app/Http/Controllers/UpdateController.php | 15 ++++++----- app/Http/Middleware/Authenticate.php | 2 ++ app/Listeners/SpeedtestFailedListener.php | 1 + .../SpeedtestCompleteTelegram.php | 2 ++ app/Notifications/SpeedtestOverviewSlack.php | 2 ++ .../SpeedtestOverviewTelegram.php | 2 ++ app/User.php | 2 +- 24 files changed, 86 insertions(+), 48 deletions(-) diff --git a/app/Console/Commands/AcceptEULACommand.php b/app/Console/Commands/AcceptEULACommand.php index 76d0fb6d..1a1f5747 100644 --- a/app/Console/Commands/AcceptEULACommand.php +++ b/app/Console/Commands/AcceptEULACommand.php @@ -34,7 +34,7 @@ class AcceptEULACommand extends Command /** * Execute the console command. * - * @return int + * @return void */ public function handle() { diff --git a/app/Console/Commands/ClearQueueCommand.php b/app/Console/Commands/ClearQueueCommand.php index 78dd42d8..84dfdb3b 100644 --- a/app/Console/Commands/ClearQueueCommand.php +++ b/app/Console/Commands/ClearQueueCommand.php @@ -34,7 +34,7 @@ class ClearQueueCommand extends Command /** * Execute the console command. * - * @return int + * @return void */ public function handle() { diff --git a/app/Console/Commands/GetConfig.php b/app/Console/Commands/GetConfig.php index dbfbbf7b..6182887a 100644 --- a/app/Console/Commands/GetConfig.php +++ b/app/Console/Commands/GetConfig.php @@ -34,7 +34,7 @@ class GetConfig extends Command /** * Execute the console command. * - * @return int + * @return void */ public function handle() { diff --git a/app/Console/Commands/SetSlackWebhook.php b/app/Console/Commands/SetSlackWebhook.php index f1fe25de..d67aaa76 100644 --- a/app/Console/Commands/SetSlackWebhook.php +++ b/app/Console/Commands/SetSlackWebhook.php @@ -34,7 +34,7 @@ class SetSlackWebhook extends Command /** * Execute the console command. * - * @return int + * @return void */ public function handle() { diff --git a/app/Console/Commands/SetTelegramOptions.php b/app/Console/Commands/SetTelegramOptions.php index c32715d1..b66ffaed 100644 --- a/app/Console/Commands/SetTelegramOptions.php +++ b/app/Console/Commands/SetTelegramOptions.php @@ -36,7 +36,7 @@ class SetTelegramOptions extends Command /** * Execute the console command. * - * @return int + * @return void */ public function handle() { diff --git a/app/Console/Commands/SpeedtestCommand.php b/app/Console/Commands/SpeedtestCommand.php index cf1dc1ae..27b7fa9a 100644 --- a/app/Console/Commands/SpeedtestCommand.php +++ b/app/Console/Commands/SpeedtestCommand.php @@ -34,7 +34,7 @@ class SpeedtestCommand extends Command /** * Runs a speedtest synchroonously and displays the results.. * - * @return null + * @return void */ public function handle() { diff --git a/app/Console/Commands/SpeedtestLatestCommand.php b/app/Console/Commands/SpeedtestLatestCommand.php index 57d04e55..e76971d8 100644 --- a/app/Console/Commands/SpeedtestLatestCommand.php +++ b/app/Console/Commands/SpeedtestLatestCommand.php @@ -35,7 +35,7 @@ class SpeedtestLatestCommand extends Command /** * Prints the latest speedtest values. * - * @return null + * @return void */ public function handle() { diff --git a/app/Console/Commands/SpeedtestVersionCommand.php b/app/Console/Commands/SpeedtestVersionCommand.php index 5d962b6f..c3617090 100644 --- a/app/Console/Commands/SpeedtestVersionCommand.php +++ b/app/Console/Commands/SpeedtestVersionCommand.php @@ -33,7 +33,7 @@ class SpeedtestVersionCommand extends Command /** * Execute the console command. * - * @return mixed + * @return void */ public function handle() { diff --git a/app/Console/Commands/TestNotification.php b/app/Console/Commands/TestNotification.php index c1796762..7018fec4 100644 --- a/app/Console/Commands/TestNotification.php +++ b/app/Console/Commands/TestNotification.php @@ -34,7 +34,7 @@ class TestNotification extends Command /** * Execute the console command. * - * @return int + * @return void */ public function handle() { diff --git a/app/Events/SpeedtestCompleteEvent.php b/app/Events/SpeedtestCompleteEvent.php index bcda12c5..84af38b5 100644 --- a/app/Events/SpeedtestCompleteEvent.php +++ b/app/Events/SpeedtestCompleteEvent.php @@ -15,6 +15,8 @@ class SpeedtestCompleteEvent { use Dispatchable, InteractsWithSockets, SerializesModels; + public $speedtest; + /** * Create a new event instance. * diff --git a/app/Helpers/BackupHelper.php b/app/Helpers/BackupHelper.php index 49708421..798408db 100644 --- a/app/Helpers/BackupHelper.php +++ b/app/Helpers/BackupHelper.php @@ -55,7 +55,7 @@ class BackupHelper { * * @param array|string $array Backup data * @param string $format json|csv - * @return boolean + * @return bool */ public static function restore($array, $format) { @@ -101,5 +101,7 @@ class BackupHelper { return true; } + + return false; } } diff --git a/app/Helpers/SettingsHelper.php b/app/Helpers/SettingsHelper.php index 8afd637d..ce209d10 100644 --- a/app/Helpers/SettingsHelper.php +++ b/app/Helpers/SettingsHelper.php @@ -12,7 +12,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 +32,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) @@ -153,7 +153,7 @@ class SettingsHelper { * Send test notification to agents * * @param boolean|string $agent - * @return void + * @return bool */ public static function testNotification($agent = true) { @@ -168,5 +168,7 @@ class SettingsHelper { event(new TestNotificationEvent([ $agent ])); return true; } + + return false; } } diff --git a/app/Helpers/SpeedtestHelper.php b/app/Helpers/SpeedtestHelper.php index 4793b990..4abf88a4 100644 --- a/app/Helpers/SpeedtestHelper.php +++ b/app/Helpers/SpeedtestHelper.php @@ -17,7 +17,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) { @@ -61,7 +61,7 @@ class SpeedtestHelper { ]); } - if(!isset($test) || $test == false) { + if($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) { @@ -256,7 +256,7 @@ class SpeedtestHelper { /** * Create a backup of the SQLite database * - * @return boolean + * @return null|boolean */ public static function dbBackup() { @@ -277,7 +277,7 @@ class SpeedtestHelper { /** * Delete all speedtests from the database * - * @return boolean|string + * @return array */ public static function deleteAll() { @@ -290,7 +290,6 @@ class SpeedtestHelper { 'success' => true, ]; } - } return [ diff --git a/app/Helpers/UpdateHelper.php b/app/Helpers/UpdateHelper.php index d14cc551..65655039 100644 --- a/app/Helpers/UpdateHelper.php +++ b/app/Helpers/UpdateHelper.php @@ -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 diff --git a/app/Http/Controllers/BackupController.php b/app/Http/Controllers/BackupController.php index 0354151e..d58e7663 100644 --- a/app/Http/Controllers/BackupController.php +++ b/app/Http/Controllers/BackupController.php @@ -7,6 +7,7 @@ use DateTime; use Illuminate\Http\Request; use Illuminate\Support\Facades\Storage; use Illuminate\Support\Facades\Validator; +use Illuminate\Http\JsonResponse; class BackupController extends Controller { @@ -15,7 +16,7 @@ class BackupController extends Controller * Get backup of speedtests * * @param Request $request - * @return file + * @return mixed|JsonResponse */ public function backup(Request $request) { @@ -36,7 +37,7 @@ class BackupController extends Controller * Retore from a backup * * @param Request $request - * @return Response + * @return JsonResponse */ public function restore(Request $request) { diff --git a/app/Http/Controllers/SettingsController.php b/app/Http/Controllers/SettingsController.php index a3780921..4744bdd4 100644 --- a/app/Http/Controllers/SettingsController.php +++ b/app/Http/Controllers/SettingsController.php @@ -8,6 +8,8 @@ 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 { @@ -15,7 +17,7 @@ class SettingsController extends Controller /** * Return all settings * - * @return array + * @return Collection */ public function index() { @@ -37,7 +39,7 @@ class SettingsController extends Controller * Store/update a setting * * @param Request $request - * @return Response + * @return JsonResponse */ public function store(Request $request) { @@ -72,7 +74,7 @@ class SettingsController extends Controller * Bulk store/update a setting * * @param Request $request - * @return Response + * @return JsonResponse */ public function bulkStore(Request $request) { @@ -94,7 +96,7 @@ class SettingsController extends Controller if(!isset($d['value']) || $d['value'] == null) { $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)) { @@ -134,6 +136,12 @@ class SettingsController extends Controller return SettingsHelper::getConfig(); } + + /** + * Trigger a test of all notification agents + * + * @return JsonResponse + */ public function testNotification() { SettingsHelper::testNotification(); diff --git a/app/Http/Controllers/SpeedtestController.php b/app/Http/Controllers/SpeedtestController.php index c814a673..b1ac3234 100644 --- a/app/Http/Controllers/SpeedtestController.php +++ b/app/Http/Controllers/SpeedtestController.php @@ -11,6 +11,7 @@ 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 { @@ -18,7 +19,7 @@ class SpeedtestController extends Controller /** * Returns paginated list of speedtests * - * @return Response + * @return JsonResponse */ public function index() { @@ -35,7 +36,7 @@ class SpeedtestController extends Controller * Returns speedtest going back 'x' days * * @param int $days - * @return void + * @return JsonResponse */ public function time($days) { @@ -71,7 +72,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 +101,7 @@ class SpeedtestController extends Controller /** * Return latest speedtest * - * @return Response + * @return JsonResponse */ public function latest() { @@ -130,7 +131,7 @@ class SpeedtestController extends Controller /** * Queue a new speedtest * - * @return Response + * @return JsonResponse */ public function run() { @@ -151,7 +152,7 @@ class SpeedtestController extends Controller /** * Delete all speedtests from db * - * @return Response + * @return JsonResponse */ public function deleteAll() { @@ -175,7 +176,7 @@ class SpeedtestController extends Controller * Delete a specific speedtest from the database * * @param Speedtest $speedtest - * @return boolean + * @return JsonResponse */ public function delete(Speedtest $speedtest) { diff --git a/app/Http/Controllers/UpdateController.php b/app/Http/Controllers/UpdateController.php index ed8bbe31..c6544a6e 100644 --- a/app/Http/Controllers/UpdateController.php +++ b/app/Http/Controllers/UpdateController.php @@ -5,6 +5,7 @@ namespace App\Http\Controllers; use Exception; use Updater; use Illuminate\Http\Request; +use Illuminate\Http\JsonResponse; class UpdateController extends Controller { @@ -12,7 +13,7 @@ class UpdateController extends Controller /** * Check for new update * - * @return Response + * @return JsonResponse */ public function checkForUpdate() { @@ -25,7 +26,7 @@ class UpdateController extends Controller /** * Download new update * - * @return Response + * @return JsonResponse */ public function downloadUpdate() { @@ -47,7 +48,7 @@ class UpdateController extends Controller /** * Trigger update extraction * - * @return Response + * @return JsonResponse */ public function extractUpdate() { @@ -69,22 +70,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() { diff --git a/app/Http/Middleware/Authenticate.php b/app/Http/Middleware/Authenticate.php index 67c7dafc..69389c33 100644 --- a/app/Http/Middleware/Authenticate.php +++ b/app/Http/Middleware/Authenticate.php @@ -17,5 +17,7 @@ class Authenticate extends Middleware if (! $request->expectsJson()) { return route('auth.login'); } + + return null; } } diff --git a/app/Listeners/SpeedtestFailedListener.php b/app/Listeners/SpeedtestFailedListener.php index f6a52a07..d3111d74 100644 --- a/app/Listeners/SpeedtestFailedListener.php +++ b/app/Listeners/SpeedtestFailedListener.php @@ -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 { diff --git a/app/Notifications/SpeedtestCompleteTelegram.php b/app/Notifications/SpeedtestCompleteTelegram.php index 591d1117..a512c662 100644 --- a/app/Notifications/SpeedtestCompleteTelegram.php +++ b/app/Notifications/SpeedtestCompleteTelegram.php @@ -14,6 +14,8 @@ class SpeedtestCompleteTelegram extends Notification { use Queueable; + public $speedtest; + /** * Create a new notification instance. * diff --git a/app/Notifications/SpeedtestOverviewSlack.php b/app/Notifications/SpeedtestOverviewSlack.php index f30beb96..cf046ba3 100644 --- a/app/Notifications/SpeedtestOverviewSlack.php +++ b/app/Notifications/SpeedtestOverviewSlack.php @@ -12,6 +12,8 @@ class SpeedtestOverviewSlack extends Notification { use Queueable; + public $data; + /** * Create a new notification instance. * diff --git a/app/Notifications/SpeedtestOverviewTelegram.php b/app/Notifications/SpeedtestOverviewTelegram.php index 3a8a2964..89415f4d 100644 --- a/app/Notifications/SpeedtestOverviewTelegram.php +++ b/app/Notifications/SpeedtestOverviewTelegram.php @@ -14,6 +14,8 @@ class SpeedtestOverviewTelegram extends Notification { use Queueable; + public $data; + /** * Create a new notification instance. * diff --git a/app/User.php b/app/User.php index c9ad0f1c..2f5cf899 100644 --- a/app/User.php +++ b/app/User.php @@ -78,7 +78,7 @@ class User extends Authenticatable implements JWTSubject /** * Returns a user's login sessions * - * @return array + * @return mixed */ public function sessions() {