feat(settings): Add a test button to check if settings are ok

Author: julienloizelet

inc/admin/init.php

@@ -104,6 +104,27 @@ function pruneBouncerCacheInAdminPage()
         }
     }
 
+    function testBouncerConnexionInAdminPage($ip)
+    {
+        try {
+            $settings = getDatabaseSettings();
+            $bouncer = getBouncerInstance($settings);
+            $remediation = $bouncer->getRemediationForIp($ip);
+            $message = __("Bouncing has been successfully tested for IP: $ip. Result is: $remediation.");
+
+            AdminNotice::displaySuccess($message);
+        } catch (BouncerException $e) {
+            getCrowdSecLoggerInstance()->error('', [
+                'type' => 'WP_EXCEPTION_WHILE_TESTING_CONNECTION',
+                'message' => $e->getMessage(),
+                'code' => $e->getCode(),
+                'file' => $e->getFile(),
+                'line' => $e->getLine(),
+            ]);
+            AdminNotice::displayError('Technical error while testing bouncer connection: '.$e->getMessage());
+        }
+    }
+
     // ACTIONS
     add_action('admin_post_crowdsec_clear_cache', function () {
         if (
@@ -132,6 +153,16 @@ function pruneBouncerCacheInAdminPage()
         header("Location: {$_SERVER['HTTP_REFERER']}");
         exit(0);
     });
+    add_action('admin_post_crowdsec_test_connection', function () {
+        if (
+            !isset($_POST['nonce']) || !wp_verify_nonce($_POST['nonce'], 'crowdsec_test_connection')) {
+            die('This link expired.');
+        }
+        $ip = isset($_POST['crowdsec_test_connection_ip']) ? $_POST['crowdsec_test_connection_ip'] : $_SERVER['REMOTE_ADDR'];
+        testBouncerConnexionInAdminPage($ip);
+        header("Location: {$_SERVER['HTTP_REFERER']}");
+        exit(0);
+    });
 
     // THEME
     add_action('admin_enqueue_scripts', function () {

inc/admin/settings.php

@@ -25,7 +25,6 @@ function adminSettings()
     /************************************
      ** Section "Bouncing refinements" **
      ***********************************/
-
     add_settings_section('crowdsec_admin_boucing', 'Bouncing', function () {
         echo 'Refine bouncing according to your needs.';
     }, 'crowdsec_settings');

inc/templates/settings.php

@@ -12,6 +12,17 @@
                 submit_button();
                 ?>
 			</form>
+            <h2><?php echo __("Test your settings");?></h2>
+            <p><?php echo __("Here you can check if your saved settings are correct.");?></p>
+            <p><?php echo __("Click the 'Test bouncing' button and the bouncer will try to get the remediation for the following IP:");?></p>
+            <form action="admin-post.php" method="post" id="crowdsec_action_test_connection">
+                <input type="hidden" name="action" value="crowdsec_test_connection"/>
+                <input type="hidden" name="nonce" value="<?php echo wp_create_nonce('crowdsec_test_connection'); ?>"/>
+                <input type="text" name="crowdsec_test_connection_ip" value="<?php echo $_SERVER['REMOTE_ADDR'];?>"/>
+                <?php
+                submit_button('Test bouncing', 'secondary');
+                ?>
+            </form>
 			<p>
 			Feel free to ask any questions about this plugin, make your suggestions or raise issues on the <a href="https://wordpress.org/support/plugin/crowdsec/">plugin support page</a> or directly on <a href="https://github.com/crowdsecurity/cs-wordpress-bouncer/issues/new">Github</a>.
 			</p>