Add env support / improve settings load

Closes #241
ethercreative · Feb 27, 2020 · 58c1c5e · 58c1c5e
1 parent b342e77
commit 58c1c5e
Show file tree

Hide file tree

Showing 12 changed files with 259 additions and 93 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,10 @@
+## 3.8.1 - 2020-02-27
+### Added
+- Add env support to settings (Closes #241)
+
+### Improved
+- Improve settings page appearance during load
+
 ## 3.8.0 - 2020-02-25
 ### Added
 - Add What3Words support (Closes #236)

diff --git a/composer.json b/composer.json
@@ -1,7 +1,7 @@
 {
   "name": "ether/simplemap",
   "description": "A beautifully simple Map field type for Craft CMS 3",
-  "version": "3.8.0",
+  "version": "3.8.1",
   "type": "craft-plugin",
   "license": "proprietary",
   "minimum-stability": "dev",

diff --git a/src/SimpleMap.php b/src/SimpleMap.php
@@ -166,7 +166,7 @@ protected function createSettingsModel ()
 	}
 
 	/**
-	 * @return Settings
+	 * @return bool|\craft\base\Model|Settings
 	 */
 	public function getSettings ()
 	{
@@ -230,6 +230,9 @@ public function onRegisterGqlTypes (RegisterGqlTypesEvent $event)
 		$event->types[] = MapPartsType::class;
 	}
 
+	/**
+	 * @throws \Exception
+	 */
 	public function onApplicationInit ()
 	{
 		if ($this->getSettings()->geoLocationAutoRedirect)

diff --git a/src/fields/MapField.php b/src/fields/MapField.php
@@ -508,13 +508,13 @@ private function _renderMap ($value, $isSettings = false)
 
 				'mapTiles' => $settings->mapTiles,
 				'mapToken' => GeoService::getToken(
-					$settings->mapToken,
+					$settings->getMapToken(),
 					$settings->mapTiles
 				),
 
 				'geoService' => $settings->geoService,
 				'geoToken'   => GeoService::getToken(
-					$settings->geoToken,
+					$settings->getGeoToken(),
 					$settings->geoService
 				),
 
@@ -549,11 +549,11 @@ private function _renderMap ($value, $isSettings = false)
 
 		if (strpos($settings->mapTiles, 'google') !== false)
 		{
-			if ($settings->mapToken !== $settings->geoToken)
+			if ($settings->getMapToken() !== $settings->getGeoToken())
 			{
 				$view->registerJsFile(
 					'https://maps.googleapis.com/maps/api/js?key=' .
-					$settings->mapToken
+					$settings->getMapToken()
 				);
 			}
 		}
@@ -571,7 +571,7 @@ private function _renderMap ($value, $isSettings = false)
 		{
 			$view->registerJsFile(
 				'https://maps.googleapis.com/maps/api/js?libraries=places&key=' .
-				$settings->geoToken
+				$settings->getGeoToken()
 			);
 		}
 		elseif ($settings->geoService === GeoEnum::AppleMapKit)
@@ -584,11 +584,11 @@ private function _renderMap ($value, $isSettings = false)
 		// what3words
 		// ---------------------------------------------------------------------
 
-		if ($settings->w3wEnabled && !empty($settings->w3wToken))
+		if ($settings->w3wEnabled && !empty($settings->getW3WToken()))
 		{
 			$view->registerJsFile(
 				'https://assets.what3words.com/sdk/v3/what3words.js?key=' .
-				$settings->w3wToken
+				$settings->getW3WToken()
 			);
 		}
 

diff --git a/src/models/Settings.php b/src/models/Settings.php
@@ -119,4 +119,40 @@ public function isW3WEnabled ()
 		return $this->w3wEnabled && SimpleMap::v(SimpleMap::EDITION_PRO);
 	}
 
+	// Getters
+	// =========================================================================
+
+	public function getMapToken ()
+	{
+		return $this->_parseEnv($this->mapToken);
+	}
+
+	public function getGeoToken ()
+	{
+		return $this->_parseEnv($this->geoToken);
+	}
+
+	public function getW3WToken ()
+	{
+		return $this->_parseEnv($this->w3wToken);
+	}
+
+	public function getGeoLocationToken ()
+	{
+		return $this->_parseEnv($this->geoLocationToken);
+	}
+
+	// Helpers
+	// =========================================================================
+
+	private function _parseEnv ($value)
+	{
+		if (is_string($value))
+			return Craft::parseEnv($value);
+
+		return array_map(function ($v) {
+			return Craft::parseEnv($v);
+		}, $value);
+	}
+
 }
diff --git a/src/services/EmbedService.php b/src/services/EmbedService.php
@@ -145,7 +145,7 @@ private function _embedGoogle (EmbedOptions $options, Settings $settings)
 		);
 
 		$params = http_build_query([
-			'key' => $settings->mapToken,
+			'key' => $settings->getMapToken(),
 			'callback' => $callbackName,
 		]);
 
@@ -159,7 +159,7 @@ private function _embedGoogle (EmbedOptions $options, Settings $settings)
 
 function {$callbackName} () {
 	{$options->id} = new google.maps.Map(document.getElementById('{$options->id}'), $formattedOptions);
-	
+
 	{$options->id}._markers = [];
 	{$formattedMarkers}.forEach(function (marker) {
 		marker.map = {$options->id};
@@ -189,7 +189,7 @@ private function _embedApple (EmbedOptions $options, Settings $settings)
 		$view = Craft::$app->getView();
 
 		$token = GeoService::getToken(
-			$settings->mapToken,
+			$settings->getMapToken(),
 			$settings->mapTiles
 		);
 		$latLng = implode(', ', array_values($options->getCenter()));
@@ -258,7 +258,7 @@ private function _embedApple (EmbedOptions $options, Settings $settings)
 {$formattedMarkers}.forEach(function (marker) {
 	marker.position.unshift(null);
 	const m = new mapkit.MarkerAnnotation(
-		new (mapkit.Coordinate.bind.apply(mapkit.Coordinate, marker.position)), 
+		new (mapkit.Coordinate.bind.apply(mapkit.Coordinate, marker.position)),
 		{
 			glyphText: marker.label || '',
 			color: marker.color || '',
@@ -335,7 +335,7 @@ private function _embedMapbox (EmbedOptions $options, Settings $settings)
 		);
 
 		$initJs = <<<JS
-mapboxgl.accessToken = '{$settings->mapToken}';
+mapboxgl.accessToken = '{$settings->getMapToken()}';
 JS;
 
 
@@ -371,7 +371,7 @@ private function _embedMapbox (EmbedOptions $options, Settings $settings)
 	 */
 	private function _embedHere (EmbedOptions $options, Settings $settings)
 	{
-		if (!array_key_exists('apiKey', $settings->mapToken) || !$settings->mapToken['apiKey'])
+		if (!array_key_exists('apiKey', $settings->getMapToken()) || !$settings->getMapToken()['apiKey'])
 			throw new InvalidConfigException('Missing HERE API Key');
 
 		$view = Craft::$app->getView();
@@ -433,7 +433,7 @@ private function _embedHere (EmbedOptions $options, Settings $settings)
 		);
 
 		$initJs = <<<JS
-const HERE_platform = new H.service.Platform({ apikey: '{$settings->mapToken['apiKey']}' });
+const HERE_platform = new H.service.Platform({ apikey: '{$settings->getMapToken()['apiKey']}' });
 window.HERE_defaultLayers = HERE_platform.createDefaultLayers();
 JS;
 
@@ -450,7 +450,7 @@ private function _embedHere (EmbedOptions $options, Settings $settings)
 
 {$formattedMarkers}.forEach(function (marker) {
 	const m = new H.map.Marker(
-		marker.position, 
+		marker.position,
 		{
 			icon: new H.map.Icon('{$markerIcon}'.replace('##FILL##', marker.color).replace('##LABEL##', marker.label)),
 		}
@@ -549,7 +549,7 @@ className: '',
 {$options->id}._markers = [];
 {$formattedMarkers}.forEach(function (marker) {
 	const m = L.marker(
-		marker.position, 
+		marker.position,
 		{ icon: window.LMapMarkerIcon(marker) }
 	);
 	{$options->id}._markers.push(m);

diff --git a/src/services/GeoLocationService.php b/src/services/GeoLocationService.php
@@ -75,10 +75,10 @@ public function lookup ($ip = null)
 		switch ($settings->geoLocationService)
 		{
 			case self::IpStack:
-				$userLocation = $this->_lookup_IpStack($settings->geoLocationToken, $ip);
+				$userLocation = $this->_lookup_IpStack($settings->getGeoLocationToken(), $ip);
 				break;
 			case self::MaxMind:
-				$userLocation = $this->_lookup_MaxMind($settings->geoLocationToken, $ip);
+				$userLocation = $this->_lookup_MaxMind($settings->getGeoLocationToken(), $ip);
 				break;
 			case self::MaxMindLite:
 				$userLocation = $this->_lookup_MaxMindLite($ip);

diff --git a/src/services/GeoService.php b/src/services/GeoService.php
@@ -582,7 +582,7 @@ public static function latLngFromAddress ($address, $country = null)
 	{
 		/** @var Settings $settings */
 		$settings = SimpleMap::getInstance()->getSettings();
-		$token = static::getToken($settings->geoToken, $settings->geoService);
+		$token = static::getToken($settings->getGeoToken(), $settings->geoService);
 
 		switch ($settings->geoService)
 		{
@@ -626,7 +626,7 @@ public static function addressFromLatLng ($lat, $lng)
 		/** @var Settings $settings */
 		$settings = SimpleMap::getInstance()->getSettings();
 		$token    =
-			static::getToken($settings->geoToken, $settings->geoService);
+			static::getToken($settings->getGeoToken(), $settings->geoService);
 
 		switch ($settings->geoService)
 		{

diff --git a/src/services/StaticService.php b/src/services/StaticService.php
@@ -93,7 +93,7 @@ private function _generateGoogle ($options, $settings)
 			'language' => Craft::$app->getLocale()->getLanguageID(),
 			'region' => $this->_getTld(),
 			'key' => GeoService::getToken(
-				$settings->mapToken,
+				$settings->getMapToken(),
 				$settings->mapTiles
 			),
 		];
@@ -152,8 +152,8 @@ private function _generateApple ($options, $settings)
 			'size' => $options->getSize(),
 			'scale' => $options->scale,
 			'lang' => Craft::$app->getLocale()->getLanguageID(),
-			'teamId' => $settings->mapToken['teamId'],
-			'keyId' => $settings->mapToken['keyId'],
+			'teamId' => $settings->getMapToken()['teamId'],
+			'keyId' => $settings->getMapToken()['keyId'],
 		];
 
 		if (!empty($options->markers))
@@ -189,7 +189,7 @@ private function _generateApple ($options, $settings)
 		}
 
 		$path = '/api/v1/snapshot?' . http_build_query($params);
-		openssl_sign($path, $signature, $settings->mapToken['privateKey'], OPENSSL_ALGO_SHA256);
+		openssl_sign($path, $signature, $settings->getMapToken()['privateKey'], OPENSSL_ALGO_SHA256);
 		$signature = $this->_encode($signature);
 
 		return 'https://snapshot.apple-mapkit.com' . $path . '&signature=' . $signature;
@@ -251,7 +251,7 @@ private function _generateMapbox ($options, $settings)
 		if ($options->scale > 1)
 			$url .= '@2x';
 
-		return $url . '?access_token=' . $settings->mapToken;
+		return $url . '?access_token=' . $settings->getMapToken();
 	}
 
 	/**
@@ -264,8 +264,8 @@ private function _generateMapbox ($options, $settings)
 	private function _generateHere ($options, $settings)
 	{
 		$params = [
-			'app_id' => $settings->mapToken['appId'],
-			'app_code' => $settings->mapToken['appCode'],
+			'app_id' => $settings->getMapToken()['appId'],
+			'app_code' => $settings->getMapToken()['appCode'],
 			'nodot' => true,
 			'c' => implode(',', $options->getCenter()),
 			'z' => $options->zoom,

diff --git a/src/services/What3WordsService.php b/src/services/What3WordsService.php
@@ -32,7 +32,7 @@ private static function _geocoder ()
 		if ($geocoder)
 			return $geocoder;
 
-		return $geocoder = new Geocoder(SimpleMap::getInstance()->getSettings()->w3wToken);
+		return $geocoder = new Geocoder(SimpleMap::getInstance()->getSettings()->getW3WToken());
 	}
 
 }