Update readme and add notification to backend screens

Author: Jacob de Keizer

README.md

@@ -29,6 +29,12 @@ php artisan vendor:publish --provider="Vdlp\BasicAuthentication\ServiceProviders
 This will create a `config/basicauthentication.php` file in your app where you can modify the configuration if you don't
 want to use .env variables.
 
+## Enable / disable plugin
+
+By default basic authentication is disabled. 
+
+To enable basic authentication, you have to set the env variable to `BASIC_AUTHENTICATION_ENABLED` to `true` in your `.env` file or edit the published config file.
+
 ## Questions? Need help?
 
 If you have any question about how to use this plugin, please don't hesitate to contact us at octobercms@vdlp.nl. We're happy to help you. You can also visit the support forum and drop your questions/issues there.

controllers/Credentials.php

@@ -8,6 +8,7 @@
 use Backend\Behaviors\ListController;
 use Backend\Classes\NavigationManager;
 use Backend\Classes\Controller;
+use Illuminate\Contracts\Config\Repository;
 use System\Classes\SettingsManager;
 
 /**
@@ -36,14 +37,19 @@ class Credentials extends Controller
     /** {@inheritdoc} */
     public $requiredPermissions = ['vdlp.basicauthentication.access_settings'];
 
+    /** @var bool */
+    public $enabled;
+
     /**
      * {@inheritdoc}
      */
-    public function __construct()
+    public function __construct(Repository $config)
     {
         parent::__construct();
 
         NavigationManager::instance()->setContext('October.System', 'system', 'settings');
         SettingsManager::setContext('Vdlp.BasicAuthentication', 'credentials');
+
+        $this->enabled = $config->get('basicauthentication.enabled');
     }
 }

controllers/ExcludedUrls.php

@@ -8,6 +8,7 @@
 use Backend\Behaviors\ListController;
 use Backend\Classes\NavigationManager;
 use Backend\Classes\Controller;
+use Illuminate\Contracts\Config\Repository;
 use System\Classes\SettingsManager;
 
 /**
@@ -36,14 +37,19 @@ class ExcludedUrls extends Controller
     /** {@inheritdoc} */
     public $requiredPermissions = ['vdlp.basicauthentication.access_settings'];
 
+    /** @var bool */
+    public $enabled;
+
     /**
      * {@inheritdoc}
      */
-    public function __construct()
+    public function __construct(Repository $config)
     {
         parent::__construct();
 
         NavigationManager::instance()->setContext('October.System', 'system', 'settings');
         SettingsManager::setContext('Vdlp.BasicAuthentication', 'excludedurls');
+
+        $this->enabled = $config->get('basicauthentication.enabled');
     }
 }

controllers/credentials/index.htm

@@ -1 +1,12 @@
+<?php if(!$this->enabled): ?>
+    <div class="container-fluid">
+        <div class="callout fade in callout-warning no-subheader">
+            <div class="header">
+                <i class="icon-warning"></i>
+                <h3><?= e(trans('vdlp.basicauthentication::lang.notifications.disabled')) ?></h3>
+            </div>
+        </div>
+    </div>
+<?php endif; ?>
+
 <?= $this->listRender() ?>

controllers/excludedurls/index.htm

@@ -1 +1,12 @@
+<?php if(!$this->enabled): ?>
+    <div class="container-fluid">
+        <div class="callout fade in callout-warning no-subheader">
+            <div class="header">
+                <i class="icon-warning"></i>
+                <h3><?= e(trans('vdlp.basicauthentication::lang.notifications.disabled')) ?></h3>
+            </div>
+        </div>
+    </div>
+<?php endif; ?>
+
 <?= $this->listRender() ?>

lang/en/lang.php

@@ -58,4 +58,7 @@
             'create_button' => 'New excluded URL',
         ],
     ],
+    'notifications' => [
+        'disabled' => 'Basic Authentication is disabled, you can enable it in the configuration file. Read the README for more information.',
+    ],
 ];