From 436d9977c281b7762540bfbcf8a875a65e9355d7 Mon Sep 17 00:00:00 2001 From: Arunas Skirius Date: Fri, 18 Nov 2022 11:18:16 +0200 Subject: [PATCH] small refactor + version bump --- README.md | 8 ++++++++ composer.json | 2 +- config/log-viewer.php | 16 ++++++++------- src/LogViewerServiceProvider.php | 35 ++++++++++++++------------------ 4 files changed, 33 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index ccf305f4..4c8eff54 100644 --- a/README.md +++ b/README.md @@ -279,6 +279,14 @@ Gate::define('deleteLogFolder', function (?User $user, LogFolder $folder) { **NOTE:** Individual file permissions are also checked before deleting them, to avoid accidental deletion of protected log files. +### Disabling Log Viewer + +To disable web access to the Log Viewer, just add an environment variable to your `.env` file: + +```env +LOG_VIEWER_ENABLED=false +``` + ## Troubleshooting Here are some common problems and solutions. diff --git a/composer.json b/composer.json index 4e22f60d..295a5982 100644 --- a/composer.json +++ b/composer.json @@ -1,6 +1,6 @@ { "name": "opcodesio/log-viewer", - "version": "v1.7.0", + "version": "v1.7.1", "description": "Fast and easy-to-use log viewer for your Laravel application", "keywords": [ "arukompas", diff --git a/config/log-viewer.php b/config/log-viewer.php index 590006a9..d24e87c9 100644 --- a/config/log-viewer.php +++ b/config/log-viewer.php @@ -4,6 +4,15 @@ return [ + /* + |-------------------------------------------------------------------------- + | Log Viewer + |-------------------------------------------------------------------------- + | Log Viewer can be disabled, so it's no longer accessible via browser. + | + */ + 'enabled' => env('LOG_VIEWER_ENABLED', true), + /* |-------------------------------------------------------------------------- | Log Viewer Domain @@ -25,13 +34,6 @@ 'route_path' => 'log-viewer', - /* - |-------------------------------------------------------------------------- - | Log Viewer Activation - |-------------------------------------------------------------------------- - */ - 'enabled' => true, - /* |-------------------------------------------------------------------------- | Back to system URL diff --git a/src/LogViewerServiceProvider.php b/src/LogViewerServiceProvider.php index cd9c7eb2..c4a6779e 100644 --- a/src/LogViewerServiceProvider.php +++ b/src/LogViewerServiceProvider.php @@ -24,21 +24,6 @@ public function register() $this->app->singleton(PreferenceStore::class, PreferenceStore::class); } - private function basePath(string $path): string - { - return __DIR__ . '/..' . $path; - } - - /** - * Check if config is enabled - * - * @return bool - */ - public function isEnabled(): bool - { - return (bool) $this->app['config']->get("{$this->name}.enabled", true); - } - public function boot() { if ($this->app->runningInConsole()) { @@ -51,7 +36,7 @@ public function boot() $this->commands([GenerateDummyLogsCommand::class]); } - if (!$this->isEnabled()) { + if (! $this->isEnabled()) { return; } @@ -68,20 +53,30 @@ public function boot() LogViewer::clearFileCache(); }); - if (!Gate::has('downloadLogFile')) { + if (! Gate::has('downloadLogFile')) { Gate::define('downloadLogFile', fn (mixed $user, LogFile $file) => true); } - if (!Gate::has('downloadLogFolder')) { + if (! Gate::has('downloadLogFolder')) { Gate::define('downloadLogFolder', fn (mixed $user, LogFolder $folder) => true); } - if (!Gate::has('deleteLogFile')) { + if (! Gate::has('deleteLogFile')) { Gate::define('deleteLogFile', fn (mixed $user, LogFile $file) => true); } - if (!Gate::has('deleteLogFolder')) { + if (! Gate::has('deleteLogFolder')) { Gate::define('deleteLogFolder', fn (mixed $user, LogFolder $folder) => true); } } + + private function basePath(string $path): string + { + return __DIR__ . '/..' . $path; + } + + private function isEnabled(): bool + { + return (bool) $this->app['config']->get("{$this->name}.enabled", true); + } }