REST: Add X-Temporary-User-Redirect response header

Bug: T376260 Change-Id: I7c7def3e5064db335a9069eec98cbaca96197f76
wikimedia · Oct 14, 2024 · be1fc95 · be1fc95
1 parent 3f84973
commit be1fc95
Show file tree

Hide file tree

Showing 35 changed files with 156 additions and 41 deletions.
diff --git a/repo/rest-api/src/RouteHandlers/AddItemAliasesInLanguageRouteHandler.php b/repo/rest-api/src/RouteHandlers/AddItemAliasesInLanguageRouteHandler.php
@@ -2,6 +2,7 @@
 
 namespace Wikibase\Repo\RestApi\RouteHandlers;
 
+use MediaWiki\HookContainer\HookRunner;
 use MediaWiki\MediaWikiServices;
 use MediaWiki\Rest\Handler;
 use MediaWiki\Rest\RequestInterface;
@@ -65,7 +66,7 @@ public static function factory(): Handler {
 				WbRestApi::getPreconditionMiddlewareFactory()->newPreconditionMiddleware(
 					fn( RequestInterface $request ): string => $request->getPathParam( self::ITEM_ID_PATH_PARAM )
 				),
-				new TempUserCreationResponseHeaderMiddleware(),
+				new TempUserCreationResponseHeaderMiddleware( new HookRunner( MediaWikiServices::getInstance()->getHookContainer() ) ),
 			] )
 		);
 	}

diff --git a/repo/rest-api/src/RouteHandlers/AddItemStatementRouteHandler.php b/repo/rest-api/src/RouteHandlers/AddItemStatementRouteHandler.php
@@ -3,6 +3,7 @@
 namespace Wikibase\Repo\RestApi\RouteHandlers;
 
 use Exception;
+use MediaWiki\HookContainer\HookRunner;
 use MediaWiki\MediaWikiServices;
 use MediaWiki\Rest\Handler;
 use MediaWiki\Rest\RequestInterface;
@@ -68,7 +69,7 @@ public static function factory(): Handler {
 				WbRestApi::getPreconditionMiddlewareFactory()->newPreconditionMiddleware(
 					fn( RequestInterface $request ): string => $request->getPathParam( self::ITEM_ID_PATH_PARAM )
 				),
-				new TempUserCreationResponseHeaderMiddleware(),
+				new TempUserCreationResponseHeaderMiddleware( new HookRunner( MediaWikiServices::getInstance()->getHookContainer() ) ),
 			] )
 		);
 	}

diff --git a/repo/rest-api/src/RouteHandlers/AddPropertyAliasesInLanguageRouteHandler.php b/repo/rest-api/src/RouteHandlers/AddPropertyAliasesInLanguageRouteHandler.php
@@ -2,6 +2,7 @@
 
 namespace Wikibase\Repo\RestApi\RouteHandlers;
 
+use MediaWiki\HookContainer\HookRunner;
 use MediaWiki\MediaWikiServices;
 use MediaWiki\Rest\Handler;
 use MediaWiki\Rest\RequestInterface;
@@ -64,7 +65,7 @@ public static function factory(): Handler {
 				WbRestApi::getPreconditionMiddlewareFactory()->newPreconditionMiddleware(
 					fn( RequestInterface $request ): string => $request->getPathParam( self::PROPERTY_ID_PATH_PARAM )
 				),
-				new TempUserCreationResponseHeaderMiddleware(),
+				new TempUserCreationResponseHeaderMiddleware( new HookRunner( MediaWikiServices::getInstance()->getHookContainer() ) ),
 			] ),
 			$responseFactory
 		);

diff --git a/repo/rest-api/src/RouteHandlers/AddPropertyStatementRouteHandler.php b/repo/rest-api/src/RouteHandlers/AddPropertyStatementRouteHandler.php
@@ -2,6 +2,7 @@
 
 namespace Wikibase\Repo\RestApi\RouteHandlers;
 
+use MediaWiki\HookContainer\HookRunner;
 use MediaWiki\MediaWikiServices;
 use MediaWiki\Rest\RequestInterface;
 use MediaWiki\Rest\Response;
@@ -66,7 +67,7 @@ public static function factory(): self {
 				WbRestApi::getPreconditionMiddlewareFactory()->newPreconditionMiddleware(
 					fn( RequestInterface $request ): string => $request->getPathParam( self::PROPERTY_ID_PATH_PARAM )
 				),
-				new TempUserCreationResponseHeaderMiddleware(),
+				new TempUserCreationResponseHeaderMiddleware( new HookRunner( MediaWikiServices::getInstance()->getHookContainer() ) ),
 			] )
 		);
 	}

diff --git a/repo/rest-api/src/RouteHandlers/CreateItemRouteHandler.php b/repo/rest-api/src/RouteHandlers/CreateItemRouteHandler.php
@@ -2,6 +2,7 @@
 
 namespace Wikibase\Repo\RestApi\RouteHandlers;
 
+use MediaWiki\HookContainer\HookRunner;
 use MediaWiki\MediaWikiServices;
 use MediaWiki\Rest\Handler;
 use MediaWiki\Rest\Response;
@@ -74,7 +75,7 @@ public static function factory(): Handler {
 				new UserAgentCheckMiddleware(),
 				new AuthenticationMiddleware( MediaWikiServices::getInstance()->getUserIdentityUtils() ),
 				new BotRightCheckMiddleware( MediaWikiServices::getInstance()->getPermissionManager(), $responseFactory ),
-				new TempUserCreationResponseHeaderMiddleware(),
+				new TempUserCreationResponseHeaderMiddleware( new HookRunner( MediaWikiServices::getInstance()->getHookContainer() ) ),
 			] )
 		);
 	}

diff --git a/repo/rest-api/src/RouteHandlers/Middleware/TempUserCreationResponseHeaderMiddleware.php b/repo/rest-api/src/RouteHandlers/Middleware/TempUserCreationResponseHeaderMiddleware.php
@@ -2,6 +2,7 @@
 
 namespace Wikibase\Repo\RestApi\RouteHandlers\Middleware;
 
+use MediaWiki\Hook\TempUserCreatedRedirectHook;
 use MediaWiki\Rest\Handler;
 use MediaWiki\Rest\Response;
 
@@ -10,15 +11,44 @@
  */
 class TempUserCreationResponseHeaderMiddleware implements Middleware {
 
+	private TempUserCreatedRedirectHook $hookRunner;
+
+	public function __construct( TempUserCreatedRedirectHook $hookRunner ) {
+		$this->hookRunner = $hookRunner;
+	}
+
 	public function run( Handler $routeHandler, callable $runNext ): Response {
 		$response = $runNext();
 
-		$user = $routeHandler->getSession()->getUser();
+		$session = $routeHandler->getSession();
+		$user = $session->getUser();
+		$authorityUser = $routeHandler->getAuthority()->getUser();
 
 		// If the user is a temporary user and is not the same as the current authority user,
-		// it means a new temporary user has been created. In this case, add a header to the response
-		// to indicate that the temporary user was created, using the temporary user's name.
-		if ( $user->isTemp() && !$routeHandler->getAuthority()->getUser()->equals( $user ) ) {
+		// it means a new temporary user has been created.
+		if ( $user->isTemp() && !$authorityUser->equals( $user ) ) {
+			// Hook parameters
+			$returnTo = '';
+			$returnToQuery = '';
+			$returnToAnchor = '';
+			$redirectUrl = '';
+
+			// Call the hook
+			$this->hookRunner->onTempUserCreatedRedirect(
+				$session,
+				$user,
+				$returnTo,
+				$returnToQuery,
+				$returnToAnchor,
+				$redirectUrl
+			);
+
+			// If redirectUrl is set, add it to the response header
+			if ( $redirectUrl !== '' ) {
+				$response->setHeader( 'X-Temporary-User-Redirect', $redirectUrl );
+			}
+
+			// Also add the newly created temporary user's name in the response header
 			$response->setHeader( 'X-Temporary-User-Created', $user->getName() );
 		}
 

diff --git a/repo/rest-api/src/RouteHandlers/PatchItemAliasesRouteHandler.php b/repo/rest-api/src/RouteHandlers/PatchItemAliasesRouteHandler.php
@@ -2,6 +2,7 @@
 
 namespace Wikibase\Repo\RestApi\RouteHandlers;
 
+use MediaWiki\HookContainer\HookRunner;
 use MediaWiki\MediaWikiServices;
 use MediaWiki\Rest\Handler;
 use MediaWiki\Rest\RequestInterface;
@@ -66,7 +67,7 @@ public static function factory(): Handler {
 				WbRestApi::getPreconditionMiddlewareFactory()->newPreconditionMiddleware(
 					fn( RequestInterface $request ): string => $request->getPathParam( self::ITEM_ID_PATH_PARAM )
 				),
-				new TempUserCreationResponseHeaderMiddleware(),
+				new TempUserCreationResponseHeaderMiddleware( new HookRunner( MediaWikiServices::getInstance()->getHookContainer() ) ),
 			] ),
 			WbRestApi::getPatchItemAliases(),
 			new AliasesSerializer(),

diff --git a/repo/rest-api/src/RouteHandlers/PatchItemDescriptionsRouteHandler.php b/repo/rest-api/src/RouteHandlers/PatchItemDescriptionsRouteHandler.php
@@ -2,6 +2,7 @@
 
 namespace Wikibase\Repo\RestApi\RouteHandlers;
 
+use MediaWiki\HookContainer\HookRunner;
 use MediaWiki\MediaWikiServices;
 use MediaWiki\Rest\Handler;
 use MediaWiki\Rest\RequestInterface;
@@ -66,7 +67,7 @@ public static function factory(): Handler {
 				WbRestApi::getPreconditionMiddlewareFactory()->newPreconditionMiddleware(
 					fn( RequestInterface $request ): string => $request->getPathParam( self::ITEM_ID_PATH_PARAM )
 				),
-				new TempUserCreationResponseHeaderMiddleware(),
+				new TempUserCreationResponseHeaderMiddleware( new HookRunner( MediaWikiServices::getInstance()->getHookContainer() ) ),
 			] ),
 			WbRestApi::getPatchItemDescriptions(),
 			new DescriptionsSerializer(),

diff --git a/repo/rest-api/src/RouteHandlers/PatchItemLabelsRouteHandler.php b/repo/rest-api/src/RouteHandlers/PatchItemLabelsRouteHandler.php
@@ -2,6 +2,7 @@
 
 namespace Wikibase\Repo\RestApi\RouteHandlers;
 
+use MediaWiki\HookContainer\HookRunner;
 use MediaWiki\MediaWikiServices;
 use MediaWiki\Rest\Handler;
 use MediaWiki\Rest\RequestInterface;
@@ -69,7 +70,7 @@ public static function factory(): Handler {
 				WbRestApi::getPreconditionMiddlewareFactory()->newPreconditionMiddleware(
 					fn( RequestInterface $request ): string => $request->getPathParam( self::ITEM_ID_PATH_PARAM )
 				),
-				new TempUserCreationResponseHeaderMiddleware(),
+				new TempUserCreationResponseHeaderMiddleware( new HookRunner( MediaWikiServices::getInstance()->getHookContainer() ) ),
 			] ),
 			$responseFactory
 		);

diff --git a/repo/rest-api/src/RouteHandlers/PatchItemRouteHandler.php b/repo/rest-api/src/RouteHandlers/PatchItemRouteHandler.php
@@ -2,6 +2,7 @@
 
 namespace Wikibase\Repo\RestApi\RouteHandlers;
 
+use MediaWiki\HookContainer\HookRunner;
 use MediaWiki\MediaWikiServices;
 use MediaWiki\Rest\Handler;
 use MediaWiki\Rest\RequestInterface;
@@ -72,7 +73,7 @@ public static function factory(): Handler {
 				WbRestApi::getPreconditionMiddlewareFactory()->newPreconditionMiddleware(
 					fn( RequestInterface $request ): string => $request->getPathParam( self::ITEM_ID_PATH_PARAM )
 				),
-				new TempUserCreationResponseHeaderMiddleware(),
+				new TempUserCreationResponseHeaderMiddleware( new HookRunner( MediaWikiServices::getInstance()->getHookContainer() ) ),
 			] ),
 			WbRestApi::getPatchItem(),
 			new ItemSerializer(

diff --git a/repo/rest-api/src/RouteHandlers/PatchItemStatementRouteHandler.php b/repo/rest-api/src/RouteHandlers/PatchItemStatementRouteHandler.php
@@ -2,6 +2,7 @@
 
 namespace Wikibase\Repo\RestApi\RouteHandlers;
 
+use MediaWiki\HookContainer\HookRunner;
 use MediaWiki\MediaWikiServices;
 use MediaWiki\Rest\Handler;
 use MediaWiki\Rest\RequestInterface;
@@ -72,7 +73,7 @@ public static function factory(): Handler {
 					self::STATEMENT_ID_PATH_PARAM,
 					self::ITEM_ID_PATH_PARAM
 				),
-				new TempUserCreationResponseHeaderMiddleware(),
+				new TempUserCreationResponseHeaderMiddleware( new HookRunner( MediaWikiServices::getInstance()->getHookContainer() ) ),
 			] ),
 			WbRestApi::getStatementSerializer(),
 			$responseFactory

diff --git a/repo/rest-api/src/RouteHandlers/PatchPropertyAliasesRouteHandler.php b/repo/rest-api/src/RouteHandlers/PatchPropertyAliasesRouteHandler.php
@@ -2,6 +2,7 @@
 
 namespace Wikibase\Repo\RestApi\RouteHandlers;
 
+use MediaWiki\HookContainer\HookRunner;
 use MediaWiki\MediaWikiServices;
 use MediaWiki\Rest\Handler;
 use MediaWiki\Rest\RequestInterface;
@@ -66,7 +67,7 @@ public static function factory(): Handler {
 				WbRestApi::getPreconditionMiddlewareFactory()->newPreconditionMiddleware(
 					fn( RequestInterface $request ): string => $request->getPathParam( self::PROPERTY_ID_PATH_PARAM )
 				),
-				new TempUserCreationResponseHeaderMiddleware(),
+				new TempUserCreationResponseHeaderMiddleware( new HookRunner( MediaWikiServices::getInstance()->getHookContainer() ) ),
 			] ),
 			new AliasesSerializer(),
 			$responseFactory

diff --git a/repo/rest-api/src/RouteHandlers/PatchPropertyDescriptionsRouteHandler.php b/repo/rest-api/src/RouteHandlers/PatchPropertyDescriptionsRouteHandler.php
@@ -2,6 +2,7 @@
 
 namespace Wikibase\Repo\RestApi\RouteHandlers;
 
+use MediaWiki\HookContainer\HookRunner;
 use MediaWiki\MediaWikiServices;
 use MediaWiki\Rest\Handler;
 use MediaWiki\Rest\RequestInterface;
@@ -64,7 +65,7 @@ public static function factory(): Handler {
 				WbRestApi::getPreconditionMiddlewareFactory()->newPreconditionMiddleware(
 					fn( RequestInterface $request ): string => $request->getPathParam( self::PROPERTY_ID_PATH_PARAM )
 				),
-				new TempUserCreationResponseHeaderMiddleware(),
+				new TempUserCreationResponseHeaderMiddleware( new HookRunner( MediaWikiServices::getInstance()->getHookContainer() ) ),
 			] ),
 			WbRestApi::getPatchPropertyDescriptions(),
 			new DescriptionsSerializer(),

diff --git a/repo/rest-api/src/RouteHandlers/PatchPropertyLabelsRouteHandler.php b/repo/rest-api/src/RouteHandlers/PatchPropertyLabelsRouteHandler.php
@@ -2,6 +2,7 @@
 
 namespace Wikibase\Repo\RestApi\RouteHandlers;
 
+use MediaWiki\HookContainer\HookRunner;
 use MediaWiki\MediaWikiServices;
 use MediaWiki\Rest\Handler;
 use MediaWiki\Rest\RequestInterface;
@@ -67,7 +68,7 @@ public static function factory(): Handler {
 				WbRestApi::getPreconditionMiddlewareFactory()->newPreconditionMiddleware(
 					fn( RequestInterface $request ): string => $request->getPathParam( self::PROPERTY_ID_PATH_PARAM )
 				),
-				new TempUserCreationResponseHeaderMiddleware(),
+				new TempUserCreationResponseHeaderMiddleware( new HookRunner( MediaWikiServices::getInstance()->getHookContainer() ) ),
 			] ),
 		);
 	}

diff --git a/repo/rest-api/src/RouteHandlers/PatchPropertyRouteHandler.php b/repo/rest-api/src/RouteHandlers/PatchPropertyRouteHandler.php
@@ -2,6 +2,7 @@
 
 namespace Wikibase\Repo\RestApi\RouteHandlers;
 
+use MediaWiki\HookContainer\HookRunner;
 use MediaWiki\MediaWikiServices;
 use MediaWiki\Rest\Handler;
 use MediaWiki\Rest\RequestInterface;
@@ -68,7 +69,7 @@ public static function factory(): Handler {
 				WbRestApi::getPreconditionMiddlewareFactory()->newPreconditionMiddleware(
 					fn( RequestInterface $request ): string => $request->getPathParam( self::PROPERTY_ID_PATH_PARAM )
 				),
-				new TempUserCreationResponseHeaderMiddleware(),
+				new TempUserCreationResponseHeaderMiddleware( new HookRunner( MediaWikiServices::getInstance()->getHookContainer() ) ),
 			] ),
 			WbRestApi::getPatchProperty(),
 			new PropertySerializer(

diff --git a/repo/rest-api/src/RouteHandlers/PatchPropertyStatementRouteHandler.php b/repo/rest-api/src/RouteHandlers/PatchPropertyStatementRouteHandler.php
@@ -2,6 +2,7 @@
 
 namespace Wikibase\Repo\RestApi\RouteHandlers;
 
+use MediaWiki\HookContainer\HookRunner;
 use MediaWiki\MediaWikiServices;
 use MediaWiki\Rest\Handler;
 use MediaWiki\Rest\RequestInterface;
@@ -71,7 +72,7 @@ public static function factory(): Handler {
 					self::STATEMENT_ID_PATH_PARAM,
 					self::PROPERTY_ID_PATH_PARAM
 				),
-				new TempUserCreationResponseHeaderMiddleware(),
+				new TempUserCreationResponseHeaderMiddleware( new HookRunner( MediaWikiServices::getInstance()->getHookContainer() ) ),
 			] ),
 			WbRestApi::getStatementSerializer(),
 			$responseFactory

diff --git a/repo/rest-api/src/RouteHandlers/PatchSitelinksRouteHandler.php b/repo/rest-api/src/RouteHandlers/PatchSitelinksRouteHandler.php
@@ -2,6 +2,7 @@
 
 namespace Wikibase\Repo\RestApi\RouteHandlers;
 
+use MediaWiki\HookContainer\HookRunner;
 use MediaWiki\MediaWikiServices;
 use MediaWiki\Rest\Handler;
 use MediaWiki\Rest\RequestInterface;
@@ -70,7 +71,7 @@ public static function factory(): Handler {
 				WbRestApi::getPreconditionMiddlewareFactory()->newPreconditionMiddleware(
 					fn( RequestInterface $request ): string => $request->getPathParam( self::ITEM_ID_PATH_PARAM )
 				),
-				new TempUserCreationResponseHeaderMiddleware(),
+				new TempUserCreationResponseHeaderMiddleware( new HookRunner( MediaWikiServices::getInstance()->getHookContainer() ) ),
 			] )
 		);
 	}

diff --git a/repo/rest-api/src/RouteHandlers/PatchStatementRouteHandler.php b/repo/rest-api/src/RouteHandlers/PatchStatementRouteHandler.php
@@ -2,6 +2,7 @@
 
 namespace Wikibase\Repo\RestApi\RouteHandlers;
 
+use MediaWiki\HookContainer\HookRunner;
 use MediaWiki\MediaWikiServices;
 use MediaWiki\Rest\Handler;
 use MediaWiki\Rest\RequestInterface;
@@ -73,7 +74,7 @@ public static function factory(): Handler {
 				WbRestApi::getStatementRedirectMiddlewareFactory()->newStatementRedirectMiddleware(
 					self::STATEMENT_ID_PATH_PARAM
 				),
-				new TempUserCreationResponseHeaderMiddleware(),
+				new TempUserCreationResponseHeaderMiddleware( new HookRunner( MediaWikiServices::getInstance()->getHookContainer() ) ),
 			] ),
 			WbRestApi::getStatementSerializer(),
 			$responseFactory

diff --git a/repo/rest-api/src/RouteHandlers/RemoveItemDescriptionRouteHandler.php b/repo/rest-api/src/RouteHandlers/RemoveItemDescriptionRouteHandler.php
@@ -2,6 +2,7 @@
 
 namespace Wikibase\Repo\RestApi\RouteHandlers;
 
+use MediaWiki\HookContainer\HookRunner;
 use MediaWiki\MediaWikiServices;
 use MediaWiki\Rest\Handler;
 use MediaWiki\Rest\RequestInterface;
@@ -64,7 +65,7 @@ public static function factory(): Handler {
 				WbRestApi::getPreconditionMiddlewareFactory()->newPreconditionMiddleware(
 					fn( RequestInterface $request ): string => $request->getPathParam( self::ITEM_ID_PATH_PARAM )
 				),
-				new TempUserCreationResponseHeaderMiddleware(),
+				new TempUserCreationResponseHeaderMiddleware( new HookRunner( MediaWikiServices::getInstance()->getHookContainer() ) ),
 			] ),
 			WbRestApi::getRemoveItemDescription(),
 			$responseFactory

diff --git a/repo/rest-api/src/RouteHandlers/RemoveItemLabelRouteHandler.php b/repo/rest-api/src/RouteHandlers/RemoveItemLabelRouteHandler.php
@@ -2,6 +2,7 @@
 
 namespace Wikibase\Repo\RestApi\RouteHandlers;
 
+use MediaWiki\HookContainer\HookRunner;
 use MediaWiki\MediaWikiServices;
 use MediaWiki\Rest\Handler;
 use MediaWiki\Rest\RequestInterface;
@@ -65,7 +66,7 @@ public static function factory(): Handler {
 				WbRestApi::getPreconditionMiddlewareFactory()->newPreconditionMiddleware(
 					fn( RequestInterface $request ): string => $request->getPathParam( self::ITEM_ID_PATH_PARAM )
 				),
-				new TempUserCreationResponseHeaderMiddleware(),
+				new TempUserCreationResponseHeaderMiddleware( new HookRunner( MediaWikiServices::getInstance()->getHookContainer() ) ),
 			] ),
 			$responseFactory
 		);

diff --git a/repo/rest-api/src/RouteHandlers/RemoveItemStatementRouteHandler.php b/repo/rest-api/src/RouteHandlers/RemoveItemStatementRouteHandler.php
@@ -2,6 +2,7 @@
 
 namespace Wikibase\Repo\RestApi\RouteHandlers;
 
+use MediaWiki\HookContainer\HookRunner;
 use MediaWiki\MediaWikiServices;
 use MediaWiki\Rest\Handler;
 use MediaWiki\Rest\RequestInterface;
@@ -69,7 +70,7 @@ public static function factory(): Handler {
 					self::STATEMENT_ID_PATH_PARAM,
 					self::ITEM_ID_PATH_PARAM
 				),
-				new TempUserCreationResponseHeaderMiddleware(),
+				new TempUserCreationResponseHeaderMiddleware( new HookRunner( MediaWikiServices::getInstance()->getHookContainer() ) ),
 			] )
 		);
 	}