Code Coverage
 
Classes and Traits
Functions and Methods
Lines
Total
0.00% covered (danger)
0.00%
0 / 1
38.71% covered (danger)
38.71%
12 / 31
CRAP
39.33% covered (danger)
39.33%
35 / 89
AbstractContent
0.00% covered (danger)
0.00%
0 / 1
38.71% covered (danger)
38.71%
12 / 31
585.29
39.33% covered (danger)
39.33%
35 / 89
 __construct
0.00% covered (danger)
0.00%
0 / 1
2
0.00% covered (danger)
0.00%
0 / 2
 getModel
100.00% covered (success)
100.00%
1 / 1
1
100.00% covered (success)
100.00%
1 / 1
 checkModelID
0.00% covered (danger)
0.00%
0 / 1
6
0.00% covered (danger)
0.00%
0 / 5
 getContentHandler
100.00% covered (success)
100.00%
1 / 1
1
100.00% covered (success)
100.00%
1 / 1
 getContentHandlerFactory
0.00% covered (danger)
0.00%
0 / 1
2
0.00% covered (danger)
0.00%
0 / 1
 getDefaultFormat
0.00% covered (danger)
0.00%
0 / 1
2
0.00% covered (danger)
0.00%
0 / 1
 getSupportedFormats
0.00% covered (danger)
0.00%
0 / 1
2
0.00% covered (danger)
0.00%
0 / 1
 isSupportedFormat
0.00% covered (danger)
0.00%
0 / 1
6
0.00% covered (danger)
0.00%
0 / 3
 checkFormat
0.00% covered (danger)
0.00%
0 / 1
6
0.00% covered (danger)
0.00%
0 / 5
 serialize
0.00% covered (danger)
0.00%
0 / 1
2
0.00% covered (danger)
0.00%
0 / 1
 isEmpty
100.00% covered (success)
100.00%
1 / 1
1
100.00% covered (success)
100.00%
1 / 1
 isValid
0.00% covered (danger)
0.00%
0 / 1
2
0.00% covered (danger)
0.00%
0 / 1
 equals
0.00% covered (danger)
0.00%
0 / 1
5.27
77.78% covered (warning)
77.78%
7 / 9
 equalsInternal
0.00% covered (danger)
0.00%
0 / 1
2
0.00% covered (danger)
0.00%
0 / 1
 getSecondaryDataUpdates
100.00% covered (success)
100.00%
1 / 1
2
100.00% covered (success)
100.00%
5 / 5
 getRedirectChain
0.00% covered (danger)
0.00%
0 / 1
42
0.00% covered (danger)
0.00%
0 / 16
 getRedirectTarget
100.00% covered (success)
100.00%
1 / 1
1
100.00% covered (success)
100.00%
1 / 1
 getUltimateRedirectTarget
0.00% covered (danger)
0.00%
0 / 1
6
0.00% covered (danger)
0.00%
0 / 2
 isRedirect
100.00% covered (success)
100.00%
1 / 1
1
100.00% covered (success)
100.00%
1 / 1
 updateRedirect
0.00% covered (danger)
0.00%
0 / 1
2
0.00% covered (danger)
0.00%
0 / 1
 getSection
0.00% covered (danger)
0.00%
0 / 1
2
0.00% covered (danger)
0.00%
0 / 1
 replaceSection
0.00% covered (danger)
0.00%
0 / 1
2
0.00% covered (danger)
0.00%
0 / 1
 preSaveTransform
100.00% covered (success)
100.00%
1 / 1
1
100.00% covered (success)
100.00%
1 / 1
 addSectionHeader
100.00% covered (success)
100.00%
1 / 1
1
100.00% covered (success)
100.00%
1 / 1
 preloadTransform
100.00% covered (success)
100.00%
1 / 1
1
100.00% covered (success)
100.00%
1 / 1
 prepareSave
0.00% covered (danger)
0.00%
0 / 1
6
0.00% covered (danger)
0.00%
0 / 3
 getDeletionUpdates
100.00% covered (success)
100.00%
1 / 1
1
100.00% covered (success)
100.00%
1 / 1
 matchMagicWord
100.00% covered (success)
100.00%
1 / 1
1
100.00% covered (success)
100.00%
1 / 1
 convert
0.00% covered (danger)
0.00%
0 / 1
6
0.00% covered (danger)
0.00%
0 / 6
 getParserOutput
100.00% covered (success)
100.00%
1 / 1
3
100.00% covered (success)
100.00%
13 / 13
 fillParserOutput
0.00% covered (danger)
0.00%
0 / 1
2
0.00% covered (danger)
0.00%
0 / 1
<?php
/**
 * A content object represents page content, e.g. the text to show on a page.
 * Content objects have no knowledge about how they relate to Wiki pages.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @since 1.21
 *
 * @file
 * @ingroup Content
 *
 * @author Daniel Kinzler
 */
use MediaWiki\Content\IContentHandlerFactory;
use MediaWiki\MediaWikiServices;
/**
 * Base implementation for content objects.
 *
 * @stable to extend
 *
 * @ingroup Content
 */
abstract class AbstractContent implements Content {
    /**
     * Name of the content model this Content object represents.
     * Use with CONTENT_MODEL_XXX constants
     *
     * @since 1.21
     *
     * @var string
     */
    protected $model_id;
    /**
     * @stable to call
     *
     * @param string|null $modelId
     *
     * @since 1.21
     */
    public function __construct( $modelId = null ) {
        $this->model_id = $modelId;
    }
    /**
     * @since 1.21
     *
     * @see Content::getModel
     * @return string
     */
    public function getModel() {
        return $this->model_id;
    }
    /**
     * @since 1.21
     *
     * @param string $modelId The model to check
     *
     * @throws MWException If the provided ID is not the ID of the content model supported by this
     * Content object.
     */
    protected function checkModelID( $modelId ) {
        if ( $modelId !== $this->model_id ) {
            throw new MWException(
                "Bad content model: " .
                "expected {$this->model_id} " .
                "but got $modelId."
            );
        }
    }
    /**
     * @since 1.21
     *
     * @see Content::getContentHandler
     * @return ContentHandler
     */
    public function getContentHandler() {
        return $this->getContentHandlerFactory()->getContentHandler( $this->getModel() );
    }
    /**
     * @return IContentHandlerFactory
     */
    protected function getContentHandlerFactory(): IContentHandlerFactory {
        return MediaWikiServices::getInstance()->getContentHandlerFactory();
    }
    /**
     * @since 1.21
     *
     * @see Content::getDefaultFormat
     * @return string
     */
    public function getDefaultFormat() {
        return $this->getContentHandler()->getDefaultFormat();
    }
    /**
     * @since 1.21
     *
     * @see Content::getSupportedFormats
     * @return string[]
     */
    public function getSupportedFormats() {
        return $this->getContentHandler()->getSupportedFormats();
    }
    /**
     * @since 1.21
     *
     * @param string $format
     *
     * @return bool
     *
     * @see Content::isSupportedFormat
     */
    public function isSupportedFormat( $format ) {
        if ( !$format ) {
            return true; // this means "use the default"
        }
        return $this->getContentHandler()->isSupportedFormat( $format );
    }
    /**
     * @since 1.21
     *
     * @param string $format The serialization format to check.
     *
     * @throws MWException If the format is not supported by this content handler.
     */
    protected function checkFormat( $format ) {
        if ( !$this->isSupportedFormat( $format ) ) {
            throw new MWException(
                "Format $format is not supported for content model " .
                $this->getModel()
            );
        }
    }
    /**
     * @stable to override
     * @since 1.21
     *
     * @param string|null $format
     *
     * @return string
     *
     * @see Content::serialize
     */
    public function serialize( $format = null ) {
        return $this->getContentHandler()->serializeContent( $this, $format );
    }
    /**
     * @stable to override
     * @since 1.21
     *
     * @return bool
     *
     * @see Content::isEmpty
     */
    public function isEmpty() {
        return $this->getSize() === 0;
    }
    /**
     * Subclasses may override this to implement (light weight) validation.
     *
     * @stable to override
     * @since 1.21
     *
     * @return bool Always true.
     *
     * @see Content::isValid
     */
    public function isValid() {
        return true;
    }
    /**
     * Decides whether two Content objects are equal.
     * Two Content objects MUST not be considered equal if they do not share the same content model.
     * Two Content objects that are equal SHOULD have the same serialization.
     *
     * This default implementation relies on equalsInternal() to determin whether the
     * Content objects are logically equivalent. Subclasses that need to implement a custom
     * equality check should consider overriding equalsInternal(). Subclasses that override
     * equals() itself MUST make sure that the implementation returns false for $that === null,
     * and true for $that === this. It MUST also return false if $that does not have the same
     * content model.
     *
     * @stable to override
     * @since 1.21
     *
     * @param Content|null $that
     *
     * @return bool
     *
     * @see Content::equals
     */
    public function equals( Content $that = null ) {
        if ( $that === null ) {
            return false;
        }
        if ( $that === $this ) {
            return true;
        }
        if ( $that->getModel() !== $this->getModel() ) {
            return false;
        }
        // For type safety. Needed for odd cases like MessageContent using CONTENT_MODEL_WIKITEXT
        if ( get_class( $that ) !== get_class( $this ) ) {
            return false;
        }
        return $this->equalsInternal( $that );
    }
    /**
     * Checks whether $that is logically equal to this Content object.
     *
     * This method can be overwritten by subclasses that need to implement custom
     * equality checks.
     *
     * This default implementation checks whether the serializations
     * of $this and $that are the same: $this->serialize() === $that->serialize()
     *
     * Implementors can assume that $that is an instance of the same class
     * as the present Content object, as long as equalsInternal() is only called
     * by the standard implementation of equals().
     *
     * @note Do not call this method directly, call equals() instead.
     *
     * @stable to override
     *
     * @param Content $that
     * @return bool
     */
    protected function equalsInternal( Content $that ) {
        return $this->serialize() === $that->serialize();
    }
    /**
     * Returns a list of DataUpdate objects for recording information about this
     * Content in some secondary data store.
     *
     * This default implementation returns a LinksUpdate object and calls the
     * SecondaryDataUpdates hook.
     *
     * Subclasses may override this to determine the secondary data updates more
     * efficiently, preferably without the need to generate a parser output object.
     * They should however make sure to call SecondaryDataUpdates to give extensions
     * a chance to inject additional updates.
     *
     * @stable to override
     * @since 1.21
     *
     * @param Title $title
     * @param Content|null $old
     * @param bool $recursive
     * @param ParserOutput|null $parserOutput
     *
     * @return DataUpdate[]
     *
     * @see Content::getSecondaryDataUpdates()
     */
    public function getSecondaryDataUpdates( Title $title, Content $old = null,
        $recursive = true, ParserOutput $parserOutput = null
    ) {
        if ( $parserOutput === null ) {
            $parserOutput = $this->getParserOutput( $title, null, null, false );
        }
        $updates = [
            new LinksUpdate( $title, $parserOutput, $recursive )
        ];
        Hooks::runner()->onSecondaryDataUpdates( $title, $old, $recursive, $parserOutput, $updates );
        return $updates;
    }
    /**
     * @since 1.21
     *
     * @return Title[]|null
     *
     * @see Content::getRedirectChain
     */
    public function getRedirectChain() {
        global $wgMaxRedirects;
        $title = $this->getRedirectTarget();
        if ( $title === null ) {
            return null;
        }
        // recursive check to follow double redirects
        $recurse = $wgMaxRedirects;
        $titles = [ $title ];
        while ( --$recurse > 0 ) {
            if ( $title->isRedirect() ) {
                $page = WikiPage::factory( $title );
                $newtitle = $page->getRedirectTarget();
            } else {
                break;
            }
            // Redirects to some special pages are not permitted
            if ( $newtitle instanceof Title && $newtitle->isValidRedirectTarget() ) {
                // The new title passes the checks, so make that our current
                // title so that further recursion can be checked
                $title = $newtitle;
                $titles[] = $newtitle;
            } else {
                break;
            }
        }
        return $titles;
    }
    /**
     * Subclasses that implement redirects should override this.
     *
     * @stable to override
     * @since 1.21
     *
     * @return Title|null
     *
     * @see Content::getRedirectTarget
     */
    public function getRedirectTarget() {
        return null;
    }
    /**
     * @note Migrated here from Title::newFromRedirectRecurse.
     *
     * @since 1.21
     *
     * @return Title|null
     *
     * @see Content::getUltimateRedirectTarget
     */
    public function getUltimateRedirectTarget() {
        $titles = $this->getRedirectChain();
        return $titles ? array_pop( $titles ) : null;
    }
    /**
     * @since 1.21
     *
     * @return bool
     *
     * @see Content::isRedirect
     */
    public function isRedirect() {
        return $this->getRedirectTarget() !== null;
    }
    /**
     * This default implementation always returns $this.
     * Subclasses that implement redirects should override this.
     *
     * @stable to override
     * @since 1.21
     *
     * @param Title $target
     *
     * @return Content $this
     *
     * @see Content::updateRedirect
     */
    public function updateRedirect( Title $target ) {
        return $this;
    }
    /**
     * @stable to override
     * @since 1.21
     *
     * @param string|int $sectionId
     * @return null
     *
     * @see Content::getSection
     */
    public function getSection( $sectionId ) {
        return null;
    }
    /**
     * @stable to override
     * @since 1.21
     *
     * @param string|int|null|bool $sectionId
     * @param Content $with
     * @param string $sectionTitle
     * @return null
     *
     * @see Content::replaceSection
     */
    public function replaceSection( $sectionId, Content $with, $sectionTitle = '' ) {
        return null;
    }
    /**
     * @stable to override
     * @since 1.21
     *
     * @param Title $title
     * @param User $user
     * @param ParserOptions $popts
     * @return Content $this
     *
     * @see Content::preSaveTransform
     */
    public function preSaveTransform( Title $title, User $user, ParserOptions $popts ) {
        return $this;
    }
    /**
     * @stable to override
     * @since 1.21
     *
     * @param string $header
     * @return Content $this
     *
     * @see Content::addSectionHeader
     */
    public function addSectionHeader( $header ) {
        return $this;
    }
    /**
     * @stable to override
     * @since 1.21
     *
     * @param Title $title
     * @param ParserOptions $popts
     * @param array $params
     * @return Content $this
     *
     * @see Content::preloadTransform
     */
    public function preloadTransform( Title $title, ParserOptions $popts, $params = [] ) {
        return $this;
    }
    /**
     * @stable to override
     * @since 1.21
     *
     * @param WikiPage $page
     * @param int $flags
     * @param int $parentRevId
     * @param User $user
     * @return Status
     *
     * @see Content::prepareSave
     */
    public function prepareSave( WikiPage $page, $flags, $parentRevId, User $user ) {
        if ( $this->isValid() ) {
            return Status::newGood();
        } else {
            return Status::newFatal( "invalid-content-data" );
        }
    }
    /**
     * @stable to override
     * @since 1.21
     *
     * @param WikiPage $page
     * @param ParserOutput|null $parserOutput
     *
     * @return DeferrableUpdate[]
     *
     * @see Content::getDeletionUpdates
     */
    public function getDeletionUpdates( WikiPage $page, ParserOutput $parserOutput = null ) {
        return [
            new LinksDeletionUpdate( $page ),
        ];
    }
    /**
     * This default implementation always returns false. Subclasses may override
     * this to supply matching logic.
     *
     * @stable to override
     * @since 1.21
     *
     * @param MagicWord $word
     *
     * @return bool Always false.
     *
     * @see Content::matchMagicWord
     */
    public function matchMagicWord( MagicWord $word ) {
        return false;
    }
    /**
     * This base implementation calls the hook ConvertContent to enable custom conversions.
     * Subclasses may override this to implement conversion for "their" content model.
     *
     * @stable to override
     *
     * @param string $toModel
     * @param string $lossy
     *
     * @return Content|bool
     *
     * @see Content::convert()
     */
    public function convert( $toModel, $lossy = '' ) {
        if ( $this->getModel() === $toModel ) {
            // nothing to do, shorten out.
            return $this;
        }
        $lossy = ( $lossy === 'lossy' ); // string flag, convert to boolean for convenience
        $result = false;
        Hooks::runner()->onConvertContent( $this, $toModel, $lossy, $result );
        return $result;
    }
    /**
     * Returns a ParserOutput object containing information derived from this content.
     * Most importantly, unless $generateHtml was false, the return value contains an
     * HTML representation of the content.
     *
     * Subclasses that want to control the parser output may override this, but it is
     * preferred to override fillParserOutput() instead.
     *
     * Subclasses that override getParserOutput() itself should take care to call the
     * ContentGetParserOutput hook.
     *
     * @stable to override
     *
     * @since 1.24
     *
     * @param Title $title Context title for parsing
     * @param int|null $revId Revision ID being rendered
     * @param ParserOptions|null $options
     * @param bool $generateHtml Whether or not to generate HTML
     *
     * @return ParserOutput Containing information derived from this content.
     */
    public function getParserOutput( Title $title, $revId = null,
        ParserOptions $options = null, $generateHtml = true
    ) {
        if ( $options === null ) {
            $options = ParserOptions::newCanonical( 'canonical' );
        }
        $po = new ParserOutput();
        $options->registerWatcher( [ $po, 'recordOption' ] );
        if ( Hooks::runner()->onContentGetParserOutput(
            $this, $title, $revId, $options, $generateHtml, $po )
        ) {
            // Save and restore the old value, just in case something is reusing
            // the ParserOptions object in some weird way.
            $oldRedir = $options->getRedirectTarget();
            $options->setRedirectTarget( $this->getRedirectTarget() );
            $this->fillParserOutput( $title, $revId, $options, $generateHtml, $po );
            $options->setRedirectTarget( $oldRedir );
        }
        Hooks::runner()->onContentAlterParserOutput( $this, $title, $po );
        $options->registerWatcher( null );
        return $po;
    }
    /**
     * Fills the provided ParserOutput with information derived from the content.
     * Unless $generateHtml was false, this includes an HTML representation of the content.
     *
     * This is called by getParserOutput() after consulting the ContentGetParserOutput hook.
     * Subclasses are expected to override this method (or getParserOutput(), if need be).
     * Subclasses of TextContent should generally override getHtml() instead.
     *
     * This placeholder implementation always throws an exception.
     *
     * @stable to override
     *
     * @since 1.24
     *
     * @param Title $title Context title for parsing
     * @param int|null $revId ID of the revision being rendered.
     *  See Parser::parse() for the ramifications.
     * @param ParserOptions $options
     * @param bool $generateHtml Whether or not to generate HTML
     * @param ParserOutput &$output The output object to fill (reference).
     *
     * @throws MWException
     */
    protected function fillParserOutput( Title $title, $revId,
        ParserOptions $options, $generateHtml, ParserOutput &$output
    ) {
        // Don't make abstract, so subclasses that override getParserOutput() directly don't fail.
        throw new MWException( 'Subclasses of AbstractContent must override fillParserOutput!' );
    }
}