SpecialPageExecutor.php

Go to the documentation of this file.

<?php

class SpecialPageExecutor {

    public function executeSpecialPage(
        SpecialPage $page,
        $subPage = '',
        WebRequest $request = null,
        $language = null,
        User $user = null
    ) {
        $context = $this->newContext( $request, $language, $user );

        $output = new OutputPage( $context );
        $context->setOutput( $output );

        $page->setContext( $context );
        $output->setTitle( $page->getPageTitle() );

        $html = $this->getHTMLFromSpecialPage( $page, $subPage );
        $response = $context->getRequest()->response();

        if ( $response instanceof FauxResponse ) {
            $code = $response->getStatusCode();

            if ( $code > 0 ) {
                $response->header( 'Status: ' . $code . ' ' . HttpStatus::getMessage( $code ) );
            }
        }

        return [ $html, $response ];
    }

    private function newContext(
        WebRequest $request = null,
        $language = null,
        User $user = null
    ) {
        $context = new DerivativeContext( RequestContext::getMain() );

        $context->setRequest( $request ?: new FauxRequest() );

        if ( $language !== null ) {
            $context->setLanguage( $language );
        }

        if ( $user !== null ) {
            $context->setUser( $user );
        }

        $this->setEditTokenFromUser( $context );

        return $context;
    }

    private function setEditTokenFromUser( DerivativeContext $context ) {
        $request = $context->getRequest();

        // Edits via GET are a security issue and should not succeed. On the other hand, not all
        // POST requests are edits, but should ignore unused parameters.
        if ( !$request->getCheck( 'wpEditToken' ) && $request->wasPosted() ) {
            $request->setVal( 'wpEditToken', $context->getUser()->getEditToken() );
        }
    }

    private function getHTMLFromSpecialPage( SpecialPage $page, $subPage ) {
        ob_start();

        try {
            $page->execute( $subPage );

            $output = $page->getOutput();

            if ( $output->getRedirect() !== '' ) {
                $output->output();
                $html = ob_get_contents();
            } elseif ( $output->isDisabled() ) {
                $html = ob_get_contents();
            } else {
                $html = $output->getHTML();
            }
        } catch ( Exception $ex ) {
            ob_end_clean();

            // Re-throw exception after "finally" handling because PHP 5.3 doesn't have "finally".
            throw $ex;
        }

        ob_end_clean();

        return $html;
    }

}