feat: Trigged UserLoggedInEvent when user log in

Co-Authored-By: Malik Mann <github@dermm.io>
Signed-off-by: Carl Schwan <carlschwan@kde.org>

Author: CarlSchwan

lib/Controller/SAMLController.php

@@ -28,6 +28,7 @@
 use OCP\AppFramework\Http\Attribute\PublicPage;
 use OCP\AppFramework\Http\Attribute\UseSession;
 use OCP\AppFramework\Services\IAppConfig;
+use OCP\EventDispatcher\IEventDispatcher;
 use OCP\IConfig;
 use OCP\IL10N;
 use OCP\IRequest;
@@ -37,6 +38,7 @@
 use OCP\Security\ICrypto;
 use OCP\Security\ITrustedDomainHelper;
 use OCP\Server;
+use OCP\User\Events\UserLoggedInEvent;
 use OneLogin\Saml2\Auth;
 use OneLogin\Saml2\Error;
 use OneLogin\Saml2\Settings;
@@ -65,6 +67,7 @@ public function __construct(
 		private ICrypto $crypto,
 		private ITrustedDomainHelper $trustedDomainHelper,
 		private SessionService $sessionService,
+		private IEventDispatcher $eventDispatcher
 	) {
 		parent::__construct($appName, $request);
 	}
@@ -250,6 +253,7 @@ public function login(int $idp = 1): Http\RedirectResponse|Http\TemplateResponse
 					if ($firstLogin) {
 						$this->userBackend->initializeHomeDir($user->getUID());
 					}
+					$this->eventDispatcher->dispatchTyped(new UserLoggedInEvent($user, $user->getUID(), null, false));
 				} catch (NoUserFoundException $e) {
 					if ($e->getMessage()) {
 						$this->logger->warning('Error while trying to login using sso environment variable: ' . $e->getMessage(), ['app' => 'user_saml']);
@@ -400,6 +404,7 @@ public function assertionConsumerService(): Http\RedirectResponse {
 			if ($firstLogin) {
 				$this->userBackend->initializeHomeDir($user->getUID());
 			}
+			$this->eventDispatcher->dispatchTyped(new UserLoggedInEvent($user, $user->getUID(), null, false));
 		} catch (NoUserFoundException) {
 			throw new \InvalidArgumentException('User "' . $this->userBackend->getCurrentUserId() . '" is not valid');
 		} catch (Exception $e) {

tests/unit/Controller/SAMLControllerTest.php

@@ -19,6 +19,7 @@
 use OCP\AppFramework\Http\RedirectResponse;
 use OCP\AppFramework\Http\TemplateResponse;
 use OCP\AppFramework\Services\IAppConfig;
+use OCP\EventDispatcher\IEventDispatcher;
 use OCP\IConfig;
 use OCP\IL10N;
 use OCP\IRequest;
@@ -28,6 +29,7 @@
 use OCP\IUserSession;
 use OCP\Security\ICrypto;
 use OCP\Security\ITrustedDomainHelper;
+use OCP\User\Events\UserLoggedInEvent;
 use Override;
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\MockObject\MockObject;
@@ -51,6 +53,7 @@ class SAMLControllerTest extends TestCase {
 	private SAMLController $samlController;
 	private ITrustedDomainHelper|MockObject $trustedDomainController;
 	private SessionService|MockObject $sessionService;
+	private IEventDispatcher|MockObject $eventDispatcher;
 
 	#[Override]
 	protected function setUp(): void {
@@ -71,6 +74,7 @@ protected function setUp(): void {
 		$this->crypto = $this->createMock(ICrypto::class);
 		$this->trustedDomainController = $this->createMock(ITrustedDomainHelper::class);
 		$this->sessionService = $this->createMock(SessionService::class);
+		$this->eventDispatcher = $this->createMock(IEventDispatcher::class);
 
 		$this->l->expects($this->any())->method('t')->willReturnCallback(
 			static fn (string $param): string => $param
@@ -95,7 +99,8 @@ protected function setUp(): void {
 			$this->userData,
 			$this->crypto,
 			$this->trustedDomainController,
-			$this->sessionService
+			$this->sessionService,
+			$this->eventDispatcher,
 		);
 	}
 
@@ -304,6 +309,11 @@ public function testLoginWithEnvVariable(array $samlUserData, string $redirect,
 			->method('createUserIfNotExists')
 			->with('MyUid');
 
+		$this->eventDispatcher
+			->expects($this->once())
+			->method('dispatchTyped')
+			->with(new UserLoggedInEvent($user, 'MyUid', null, false));
+
 		$expected = new RedirectResponse($redirect);
 		$result = $this->samlController->login(1);
 		$this->assertEquals($expected, $result);