OXDEV-9885 Change exception structure after merge with facebook

TitaKoleva · TitaKoleva · commit 55d931646054 · 2025-11-18T14:28:58.000+02:00
diff --git a/metadata.php b/metadata.php
@@ -139,25 +139,25 @@
             'value' => ''
         ],
         [
-            'group' => 'oauth2',
+            'group' => 'oauth',
             'name'  => OAuthModuleSettings::GOOGLE_ACTIVE,
             'type'  => 'bool',
             'value' => true
         ],
         [
-            'group' => 'oauth2',
+            'group' => 'oauth',
             'name'  => OAuthModuleSettings::GOOGLE_CLIENT_ID,
             'type'  => 'str',
             'value' => ''
         ],
         [
-            'group' => 'oauth2',
+            'group' => 'oauth',
             'name'  => OAuthModuleSettings::GOOGLE_CLIENT_SECRET,
             'type'  => 'str',
             'value' => ''
         ],
         [
-            'group' => 'oauth2',
+            'group' => 'oauth',
             'name'  => OAuthModuleSettings::GOOGLE_REDIRECT_URL,
             'type'  => 'str',
             'value' => ''
diff --git a/src/Authentication/OAuth2/Controller/OAuthController.php b/src/Authentication/OAuth2/Controller/OAuthController.php
@@ -1,5 +1,10 @@
 <?php
 
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
 namespace OxidEsales\SecurityModule\Authentication\OAuth2\Controller;
 
 use OxidEsales\Eshop\Application\Controller\FrontendController;
@@ -21,14 +26,13 @@ public function login(): void
 
     public function redirect(): void
     {
+        //todo: get provider dynamically
         $provider = $this
             ->getService(ProviderCollectorInterface::class)
-            ->getProvider('facebook');
+            ->getProvider('google');
 
         $provider->getClient();
-
         $accessToken = $provider->getAccessToken($_GET['code']);
-
         $userDTO = $provider->getUserInfo($accessToken);
 
         $this
diff --git a/src/Authentication/OAuth2/DataType/UserDataType.php b/src/Authentication/OAuth2/DataType/UserDataType.php
diff --git a/src/Authentication/OAuth2/DataType/UserDataTypeInterface.php b/src/Authentication/OAuth2/DataType/UserDataTypeInterface.php
diff --git a/src/Authentication/OAuth2/Service/Exception/ProviderNotActive.php b/src/Authentication/OAuth2/Service/Exception/ProviderNotActive.php
@@ -7,8 +7,8 @@
 
 declare(strict_types=1);
 
-namespace OxidEsales\SecurityModule\Authentication\OAuth2\Service\Provider;
+namespace OxidEsales\SecurityModule\Authentication\OAuth2\Service\Exception;
 
-class ProviderNotFound extends \Exception
+class ProviderNotActive extends \Exception
 {
 }
diff --git a/src/Authentication/OAuth2/Service/Exception/UserBlockedException.php b/src/Authentication/OAuth2/Service/Exception/UserBlockedException.php
@@ -7,7 +7,7 @@
 
 declare(strict_types=1);
 
-namespace OxidEsales\SecurityModule\Authentication\OAuth2\Exception;
+namespace OxidEsales\SecurityModule\Authentication\OAuth2\Service\Exception;
 
 class UserBlockedException extends \Exception
 {
diff --git a/src/Authentication/OAuth2/Service/Exception/UserNotFoundException.php b/src/Authentication/OAuth2/Service/Exception/UserNotFoundException.php
@@ -7,7 +7,7 @@
 
 declare(strict_types=1);
 
-namespace OxidEsales\SecurityModule\Authentication\OAuth2\Exception;
+namespace OxidEsales\SecurityModule\Authentication\OAuth2\Service\Exception;
 
 class UserNotFoundException extends \Exception
 {
diff --git a/src/Authentication/OAuth2/Service/Provider/Facebook/Facebook.php b/src/Authentication/OAuth2/Service/Provider/Facebook/Facebook.php
@@ -44,6 +44,11 @@ public function getClient(): AbstractProvider
         return $this->facebookProvider;
     }
 
+    public function isActive(): bool
+    {
+        return $this->moduleSettings->isFacebookActive();
+    }
+
     public function getAuthorizationUrl(array $options = []): string
     {
         return $this->facebookProvider->getAuthorizationUrl($options);
@@ -65,9 +70,4 @@ public function getUserInfo(AccessTokenInterface $token): UserDTOInterface
             $user->getEmail(),
         );
     }
-
-    public function validateToken(AccessTokenInterface $token): bool
-    {
-        return true;
-    }
 }
diff --git a/src/Authentication/OAuth2/Service/Provider/Google/Google.php b/src/Authentication/OAuth2/Service/Provider/Google/Google.php
@@ -1,12 +1,20 @@
 <?php
 
-namespace OxidEsales\SecurityModule\Authentication\OAuth2\Service\Provider;
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\SecurityModule\Authentication\OAuth2\Service\Provider\Google;
 
 use League\OAuth2\Client\Provider\Google as GoogleProvider;
 use League\OAuth2\Client\Token\AccessTokenInterface;
-use OxidEsales\SecurityModule\Authentication\OAuth2\DataType\UserDataType;
-use OxidEsales\SecurityModule\Authentication\OAuth2\DataType\UserDataTypeInterface;
+use OxidEsales\SecurityModule\Authentication\OAuth2\DTO\UserDTO;
+use OxidEsales\SecurityModule\Authentication\OAuth2\DTO\UserDTOInterface;
 use OxidEsales\SecurityModule\Authentication\OAuth2\Service\ModuleSettingsServiceInterface;
+use OxidEsales\SecurityModule\Authentication\OAuth2\Service\Provider\ProviderInterface;
 
 class Google implements ProviderInterface
 {
@@ -36,12 +44,9 @@ public function isActive(): bool
         return $this->moduleSettings->isGoogleActive();
     }
 
-    public function getAuthorizationUrl(string $state): string
+    public function getAuthorizationUrl(array $options = []): string
     {
-        return $this->client->getAuthorizationUrl([
-            'scope' => ['openid', 'email', 'profile'],
-            'state' => $state,
-        ]);
+        return $this->client->getAuthorizationUrl($options);
     }
 
     public function getAccessToken(string $code): AccessTokenInterface
@@ -51,19 +56,14 @@ public function getAccessToken(string $code): AccessTokenInterface
         ]);
     }
 
-    public function getUserInfo(AccessTokenInterface $token): UserDataTypeInterface
+    public function getUserInfo(AccessTokenInterface $token): UserDTOInterface
     {
         $user = $this->client->getResourceOwner($token);
 
-        return new UserDataType(
+        return new UserDTO(
             $user->getFirstName(),
             $user->getLastName(),
             $user->getEmail(),
         );
     }
-
-    public function validateToken(AccessTokenInterface $token): bool
-    {
-        return true;
-    }
 }
diff --git a/src/Authentication/OAuth2/Service/Provider/ProviderInterface.php b/src/Authentication/OAuth2/Service/Provider/ProviderInterface.php
@@ -1,5 +1,10 @@
 <?php
 
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
 namespace OxidEsales\SecurityModule\Authentication\OAuth2\Service\Provider;
 
 use League\OAuth2\Client\Provider\AbstractProvider;
@@ -38,9 +43,4 @@ public function getAccessToken(string $code): AccessTokenInterface;
      * Should return standardized data: id, email, name, avatar, etc.
      */
     public function getUserInfo(AccessTokenInterface $token): UserDTOInterface;
-
-    /**
-     * Validate the provider response.
-     */
-    public function validateToken(AccessTokenInterface $token): bool;
 }
diff --git a/src/Authentication/OAuth2/Service/Provider/services.yaml b/src/Authentication/OAuth2/Service/Provider/services.yaml
@@ -5,3 +5,6 @@ services:
 
   OxidEsales\SecurityModule\Authentication\OAuth2\Service\Provider\Facebook\Facebook:
     tags: [ 'security.oauth.tag.provider' ]
+
+  OxidEsales\SecurityModule\Authentication\OAuth2\Service\Provider\Google\Google:
+    tags: [ 'security.oauth.tag.provider' ]
diff --git a/src/Authentication/OAuth2/Service/ProviderCollector.php b/src/Authentication/OAuth2/Service/ProviderCollector.php
@@ -9,8 +9,9 @@
 
 namespace OxidEsales\SecurityModule\Authentication\OAuth2\Service;
 
+use OxidEsales\SecurityModule\Authentication\OAuth2\Service\Exception\ProviderNotActive;
+use OxidEsales\SecurityModule\Authentication\OAuth2\Service\Exception\ProviderNotFound;
 use OxidEsales\SecurityModule\Authentication\OAuth2\Service\Provider\ProviderInterface;
-use OxidEsales\SecurityModule\Authentication\OAuth2\Service\Provider\ProviderNotFound;
 
 class ProviderCollector implements ProviderCollectorInterface
 {
@@ -43,6 +44,10 @@ public function getProvider(string $name): ProviderInterface
             throw new ProviderNotFound();
         }
 
+        if (!$providers[$name]->isActive()) {
+            throw new ProviderNotActive();
+        }
+
         return $providers[$name];
     }
 }
diff --git a/src/Authentication/OAuth2/Service/UserService.php b/src/Authentication/OAuth2/Service/UserService.php
@@ -12,8 +12,8 @@
 use OxidEsales\Eshop\Application\Model\User;
 use OxidEsales\EshopCommunity\Internal\Framework\Session\SessionInterface;
 use OxidEsales\SecurityModule\Authentication\OAuth2\DTO\UserDTOInterface;
-use OxidEsales\SecurityModule\Authentication\OAuth2\Exception\UserBlockedException;
-use OxidEsales\SecurityModule\Authentication\OAuth2\Exception\UserNotFoundException;
+use OxidEsales\SecurityModule\Authentication\OAuth2\Service\Exception\UserBlockedException;
+use OxidEsales\SecurityModule\Authentication\OAuth2\Service\Exception\UserNotFoundException;
 use OxidEsales\SecurityModule\Authentication\OAuth2\Factory\UserFactoryInterface;
 
 readonly class UserService implements UserServiceInterface
diff --git a/tests/Integration/Authentication/OAuth2/Service/UserServiceTest.php b/tests/Integration/Authentication/OAuth2/Service/UserServiceTest.php
@@ -14,8 +14,8 @@
 use OxidEsales\EshopCommunity\Internal\Framework\Session\SessionInterface;
 use OxidEsales\EshopCommunity\Tests\Integration\IntegrationTestCase;
 use OxidEsales\SecurityModule\Authentication\OAuth2\DTO\UserDTOInterface;
-use OxidEsales\SecurityModule\Authentication\OAuth2\Exception\UserBlockedException;
-use OxidEsales\SecurityModule\Authentication\OAuth2\Exception\UserNotFoundException;
+use OxidEsales\SecurityModule\Authentication\OAuth2\Service\Exception\UserBlockedException;
+use OxidEsales\SecurityModule\Authentication\OAuth2\Service\Exception\UserNotFoundException;
 use OxidEsales\SecurityModule\Authentication\OAuth2\Factory\UserFactoryInterface;
 use OxidEsales\SecurityModule\Authentication\OAuth2\Service\UserService;
 
diff --git a/tests/Unit/Authentication/OAuth2/Exception/UserBlockedExceptionTest.php b/tests/Unit/Authentication/OAuth2/Exception/UserBlockedExceptionTest.php
@@ -10,7 +10,7 @@
 namespace OxidEsales\SecurityModule\Tests\Unit\Authentication\OAuth2\Exception;
 
 use Codeception\PHPUnit\TestCase;
-use OxidEsales\SecurityModule\Authentication\OAuth2\Exception\UserBlockedException;
+use OxidEsales\SecurityModule\Authentication\OAuth2\Service\Exception\UserBlockedException;
 
 class UserBlockedExceptionTest extends TestCase
 {
diff --git a/tests/Unit/Authentication/OAuth2/Exception/UserNotFoundExceptionTest.php b/tests/Unit/Authentication/OAuth2/Exception/UserNotFoundExceptionTest.php
@@ -10,8 +10,7 @@
 namespace OxidEsales\SecurityModule\Tests\Unit\Authentication\OAuth2\Exception;
 
 use Codeception\PHPUnit\TestCase;
-use OxidEsales\SecurityModule\Authentication\OAuth2\Exception\UserBlockedException;
-use OxidEsales\SecurityModule\Authentication\OAuth2\Exception\UserNotFoundException;
+use OxidEsales\SecurityModule\Authentication\OAuth2\Service\Exception\UserNotFoundException;
 
 class UserNotFoundExceptionTest extends TestCase
 {
diff --git a/tests/Unit/Authentication/OAuth2/Provider/FacebookProviderTest.php b/tests/Unit/Authentication/OAuth2/Provider/FacebookProviderTest.php
@@ -0,0 +1,51 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+use OxidEsales\SecurityModule\Authentication\OAuth2\Service\Provider\Facebook\Facebook as FacebookProvider;
+use PHPUnit\Framework\TestCase;
+use League\OAuth2\Client\Provider\Facebook;
+use OxidEsales\SecurityModule\Authentication\OAuth2\Service\ModuleSettingsServiceInterface;
+use OxidEsales\SecurityModule\Authentication\OAuth2\Service\UserDataType;
+
+class FacebookProviderTest extends TestCase
+{
+    public function testGetNameReturnsFacebook(): void
+    {
+        $settings = $this->createMock(ModuleSettingsServiceInterface::class);
+        $provider = new FacebookProvider($settings);
+        $this->assertSame('facebook', $provider->getName());
+    }
+
+    public function testGetClientCreatesFacebookProvider(): void
+    {
+        $settings = $this->createMock(ModuleSettingsServiceInterface::class);
+        $settings->method('getFacebookClientId')->willReturn('id123');
+        $settings->method('getFacebookClientSecret')->willReturn('secret123');
+        $settings->method('getFacebookRedirectUrl')->willReturn('http://redirect');
+
+        $provider = new FacebookProvider($settings);
+        $google = new Facebook([
+            'clientId'     => 'id123',
+            'clientSecret' => 'secret123',
+            'redirectUri'  => 'http://redirect',
+            'graphApiVersion' => 'v2.10'
+        ]);
+
+        $client = $provider->getClient();
+        $this->assertEquals($google, $client);
+    }
+
+    public function testIsActiveDelegatesToSettings(): void
+    {
+        $settings = $this->createMock(ModuleSettingsServiceInterface::class);
+        $settings->method('isFacebookActive')->willReturn(true);
+        $provider = new FacebookProvider($settings);
+        $this->assertTrue($provider->isActive());
+    }
+}
diff --git a/tests/Unit/Authentication/OAuth2/Provider/GoogleProviderTest.php b/tests/Unit/Authentication/OAuth2/Provider/GoogleProviderTest.php
diff --git a/tests/Unit/Authentication/OAuth2/Service/ProviderCollectorTest.php b/tests/Unit/Authentication/OAuth2/Service/ProviderCollectorTest.php
diff --git a/views/admin_twig/de/oesecuritymodule_lang.php b/views/admin_twig/de/oesecuritymodule_lang.php
diff --git a/views/admin_twig/en/oesecuritymodule_lang.php b/views/admin_twig/en/oesecuritymodule_lang.php
diff --git a/views/twig/extensions/themes/default/form/login_account.html.twig b/views/twig/extensions/themes/default/form/login_account.html.twig

Original file line number	Diff line number	Diff line change
`@@ -7,8 +7,8 @@`
`7`	`7`
`8`	`8`	`declare(strict_types=1);`
`9`	`9`
`10`		`-namespace OxidEsales\SecurityModule\Authentication\OAuth2\Service\Provider;`
	`10`	`+namespace OxidEsales\SecurityModule\Authentication\OAuth2\Service\Exception;`
`11`	`11`
`12`		`-class ProviderNotFound extends \Exception`
	`12`	`+class ProviderNotActive extends \Exception`
`13`	`13`	`{`
`14`	`14`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@`
`7`	`7`
`8`	`8`	`declare(strict_types=1);`
`9`	`9`
`10`		`-namespace OxidEsales\SecurityModule\Authentication\OAuth2\Exception;`
	`10`	`+namespace OxidEsales\SecurityModule\Authentication\OAuth2\Service\Exception;`
`11`	`11`
`12`	`12`	`class UserBlockedException extends \Exception`
`13`	`13`	`{`
Original file line number	Diff line number	Diff line change
`@@ -44,6 +44,11 @@ public function getClient(): AbstractProvider`
`44`	`44`	`return $this->facebookProvider;`
`45`	`45`	`}`
`46`	`46`
	`47`	`+ public function isActive(): bool`
	`48`	`+ {`
	`49`	`+ return $this->moduleSettings->isFacebookActive();`
	`50`	`+ }`
	`51`	`+`
`47`	`52`	`public function getAuthorizationUrl(array $options = []): string`
`48`	`53`	`{`
`49`	`54`	`return $this->facebookProvider->getAuthorizationUrl($options);`
`@@ -65,9 +70,4 @@ public function getUserInfo(AccessTokenInterface $token): UserDTOInterface`
`65`	`70`	`$user->getEmail(),`
`66`	`71`	`);`
`67`	`72`	`}`
`68`		`-`
`69`		`- public function validateToken(AccessTokenInterface $token): bool`
`70`		`- {`
`71`		`- return true;`
`72`		`- }`
`73`	`73`	`}`