Improve detection of map provider with missing Api key

app/Module/BingMaps.php

@@ -19,11 +19,8 @@
 
 namespace Fisharebest\Webtrees\Module;
 
-use Fisharebest\Webtrees\Auth;
 use Fisharebest\Webtrees\FlashMessages;
-use Fisharebest\Webtrees\Http\Exceptions\HttpServerErrorException;
 use Fisharebest\Webtrees\I18N;
-use Fisharebest\Webtrees\Registry;
 use Fisharebest\Webtrees\Validator;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
@@ -111,16 +108,6 @@ public function leafletJsTileLayers(): array
     {
         $api_key = $this->getPreference('api_key');
 
-        if ($api_key === '') {
-            $message = I18N::translate('This service requires an API key.');
-
-            if (Auth::isAdmin()) {
-                $message = '<a href="' . e($this->getConfigLink()) . '">' . $message . '</a>';
-            }
-
-            throw new HttpServerErrorException($message);
-        }
-
         return [
             (object) [
                 'bingMapsKey' => $api_key,

app/Module/GoogleMaps.php

@@ -19,15 +19,12 @@
 
 namespace Fisharebest\Webtrees\Module;
 
-use Fisharebest\Webtrees\Auth;
 use Fisharebest\Webtrees\FlashMessages;
-use Fisharebest\Webtrees\Http\Exceptions\HttpServerErrorException;
 use Fisharebest\Webtrees\I18N;
 use Fisharebest\Webtrees\Validator;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
 
-use function e;
 use function redirect;
 
 /**
@@ -111,16 +108,6 @@ public function leafletJsTileLayers(): array
     {
         $api_key = $this->getPreference('api_key');
 
-        if ($api_key === '') {
-            $message = I18N::translate('This service requires an API key.');
-
-            if (Auth::isAdmin()) {
-                $message = '<a href="' . e($this->getConfigLink()) . '">' . $message . '</a>';
-            }
-
-            throw new HttpServerErrorException($message);
-        }
-
         return [
             (object) [
                 'GM_API_KEY'  => $api_key,

app/Module/HereMaps.php

@@ -19,15 +19,12 @@
 
 namespace Fisharebest\Webtrees\Module;
 
-use Fisharebest\Webtrees\Auth;
 use Fisharebest\Webtrees\FlashMessages;
-use Fisharebest\Webtrees\Http\Exceptions\HttpServerErrorException;
 use Fisharebest\Webtrees\I18N;
 use Fisharebest\Webtrees\Validator;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
 
-use function e;
 use function redirect;
 
 /**
@@ -70,16 +67,6 @@ public function getAdminAction(): ResponseInterface
 
         $api_key = $this->getPreference('api_key');
 
-        if ($api_key === '') {
-            $message = I18N::translate('This service requires an API key.');
-
-            if (Auth::isAdmin()) {
-                $message = '<a href="' . e($this->getConfigLink()) . '">' . $message . '</a>';
-            }
-
-            throw new HttpServerErrorException($message);
-        }
-
         return $this->viewResponse('modules/here-maps/config', [
             'api_key' => $api_key,
             'title'   => $this->title(),

app/Module/MapBox.php

@@ -19,15 +19,12 @@
 
 namespace Fisharebest\Webtrees\Module;
 
-use Fisharebest\Webtrees\Auth;
 use Fisharebest\Webtrees\FlashMessages;
-use Fisharebest\Webtrees\Http\Exceptions\HttpServerErrorException;
 use Fisharebest\Webtrees\I18N;
 use Fisharebest\Webtrees\Validator;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
 
-use function e;
 use function redirect;
 
 /**
@@ -70,16 +67,6 @@ public function getAdminAction(): ResponseInterface
 
         $api_key = $this->getPreference('api_key');
 
-        if ($api_key === '') {
-            $message = I18N::translate('This service requires an API key.');
-
-            if (Auth::isAdmin()) {
-                $message = '<a href="' . e($this->getConfigLink()) . '">' . $message . '</a>';
-            }
-
-            throw new HttpServerErrorException($message);
-        }
-
         return $this->viewResponse('modules/map-box/config', [
             'api_key' => $api_key,
             'title'   => $this->title(),

app/Module/ModuleMapProviderInterface.php

@@ -30,4 +30,11 @@ interface ModuleMapProviderInterface extends ModuleInterface
      * @return array<object>
      */
     public function leafletJsTileLayers(): array;
+
+    /**
+     * Check if provider has valid api key
+     *
+     * @return bool
+     */
+    public function hasApiKey(): bool;
 }

app/Module/ModuleMapProviderTrait.php

@@ -19,11 +19,19 @@
 
 namespace Fisharebest\Webtrees\Module;
 
+use Fisharebest\Webtrees\Auth;
+use Fisharebest\Webtrees\Http\Exceptions\HttpServerErrorException;
+use Fisharebest\Webtrees\I18N;
+
+use function e;
+
 /**
  * Trait ModuleMapProviderTrait - default implementation of ModuleMapProviderInterface
  */
 trait ModuleMapProviderTrait
 {
+    use ModuleConfigTrait;
+
     /**
      * Parameters to create a TileLayer in LeafletJs.
      *
@@ -33,4 +41,23 @@ public function leafletJsTileLayers(): array
     {
         return [];
     }
+
+    /**
+     *  Check if Module contains the functions for a config page,
+     *  If so then an api key is required so check if it is empty
+     *
+     * @return bool
+     * @throws HttpServerErrorException
+     */
+    public function hasApiKey(): bool
+    {
+        $error = in_array("getAdminAction", get_class_methods($this)) && $this->getPreference('api_key') === '';
+        if ($error && Auth::isAdmin()) {
+            $message = I18N::translate('<a href="%s">The %s service requires an API key.', e($this->getConfigLink()), $this->title());
+
+            throw new HttpServerErrorException($message);
+        }
+
+        return !$error;
+    }
 }

app/Services/LeafletJsService.php

@@ -23,6 +23,7 @@
 use Fisharebest\Webtrees\Http\Exceptions\HttpServiceUnavailableException;
 use Fisharebest\Webtrees\Http\RequestHandlers\ModulesMapProvidersPage;
 use Fisharebest\Webtrees\I18N;
+use Fisharebest\Webtrees\Log;
 use Fisharebest\Webtrees\Module\ModuleMapProviderInterface;
 
 /**
@@ -51,6 +52,14 @@ public function config(): object
 
         $map_providers = $this->module_service
             ->findByInterface(ModuleMapProviderInterface::class)
+            ->filter(function ($item) {
+                $hasApiKey = $item->hasApiKey();
+                if (!$hasApiKey) {
+                    Log::addErrorLog('Map provider "' . $item->title() . '" does not have an api key');
+                }
+
+                return $hasApiKey;
+            })
             ->map(static function (ModuleMapProviderInterface $map_provider) use ($default): object {
                 return (object) [
                     'children'  => $map_provider->leafletJsTileLayers(),