wikimedia/mediawiki-extensions-Wikibase

<?php declare( strict_types=1 );

namespace Wikibase\Repo\RestApi\RouteHandlers;

use HttpStatus;
use MediaWiki\Rest\Response;
use MediaWiki\Rest\StringStream;
use Wikibase\Repo\RestApi\Application\UseCases\UseCaseError;

/**
 * @license GPL-2.0-or-later
 */
class ResponseFactory {

    public function newErrorResponseFromException( UseCaseError $e ): Response {
        return $this->newErrorResponse( $e->getErrorCode(), $e->getErrorMessage(), $e->getErrorContext() );
    }

    public function newErrorResponse( string $code, string $message, array $context = null ): Response {
        // respond with framework error, when user cannot edit the Item for an unknown reason
        if ( $code === UseCaseError::PERMISSION_DENIED_UNKNOWN_REASON ) {
            return $this->newFrameworkAlikePermissionDeniedResponse();
        }

        $httpResponse = new Response();
        $httpResponse->setHeader( 'Content-Type', 'application/json' );
        $httpResponse->setHeader( 'Content-Language', 'en' );
        $httpResponse->setStatus( ErrorResponseToHttpStatus::lookup( $code ) );
        $httpResponse->setBody( new StringStream( json_encode(
            // use array_filter to remove 'context' from array if $context is NULL
            array_filter( [ 'code' => $code, 'message' => $message, 'context' => $context ] ),
            JSON_UNESCAPED_SLASHES
        ) ) );

        return $httpResponse;
    }

    private function newFrameworkAlikePermissionDeniedResponse(): Response {
        $httpResponse = new Response();
        $httpResponse->setHeader( 'Content-Type', 'application/json' );
        $httpResponse->setStatus( 403 );
        $httpResponse->setBody( new StringStream( json_encode( [
            'error' => 'rest-write-denied',
            'httpCode' => 403,
            'httpReason' => HttpStatus::getMessage( 403 ),
        ] ) ) );

        return $httpResponse;
    }

}