1.23.16/php/ParserOutput_8php_source.html

<?php


class ParserOutput extends CacheTime {

    var $mText,                       # The output text

        $mLanguageLinks,              # List of the full text of language links, in the order they appear

        $mCategories,                 # Map of category names to sort keys

        $mTitleText,                  # title text of the chosen language variant

        $mLinks = array(),            # 2-D map of NS/DBK to ID for the links in the document. ID=zero for broken.

        $mTemplates = array(),        # 2-D map of NS/DBK to ID for the template references. ID=zero for broken.

        $mTemplateIds = array(),      # 2-D map of NS/DBK to rev ID for the template references. ID=zero for broken.

        $mImages = array(),           # DB keys of the images used, in the array key only

        $mFileSearchOptions = array(), # DB keys of the images used mapped to sha1 and MW timestamp

        $mExternalLinks = array(),    # External link URLs, in the key only

        $mInterwikiLinks = array(),   # 2-D map of prefix/DBK (in keys only) for the inline interwiki links in the document.

        $mNewSection = false,         # Show a new section link?

        $mHideNewSection = false,     # Hide the new section link?

        $mNoGallery = false,          # No gallery on category page? (__NOGALLERY__)

        $mHeadItems = array(),        # Items to put in the <head> section

        $mModules = array(),          # Modules to be loaded by the resource loader

        $mModuleScripts = array(),    # Modules of which only the JS will be loaded by the resource loader

        $mModuleStyles = array(),     # Modules of which only the CSSS will be loaded by the resource loader

        $mModuleMessages = array(),   # Modules of which only the messages will be loaded by the resource loader

        $mJsConfigVars = array(),     # JavaScript config variable for mw.config combined with this page

        $mOutputHooks = array(),      # Hook tags as per $wgParserOutputHooks

        $mWarnings = array(),         # Warning text to be returned to the user. Wikitext formatted, in the key only

        $mSections = array(),         # Table of contents

        $mEditSectionTokens = false,  # prefix/suffix markers if edit sections were output as tokens

        $mProperties = array(),       # Name/value pairs to be cached in the DB

        $mTOCHTML = '',               # HTML of the TOC

        $mTimestamp,                  # Timestamp of the revision

        $mTOCEnabled = true;          # Whether TOC should be shown, can't override __NOTOC__

        private $mIndexPolicy = '';       # 'index' or 'noindex'?  Any other value will result in no change.

        private $mAccessedOptions = array(); # List of ParserOptions (stored in the keys)

        private $mSecondaryDataUpdates = array(); # List of DataUpdate, used to save info from the page somewhere else.

        private $mExtensionData = array(); # extra data used by extensions

        private $mLimitReportData = array(); # Parser limit report data

        private $mParseStartTime = array(); # Timestamps for getTimeSinceStart()

        private $mPreventClickjacking = false; # Whether to emit X-Frame-Options: DENY


    const EDITSECTION_REGEX = '#<(?:mw:)?editsection page="(.*?)" section="(.*?)"(?:/>|>(.*?)(</(?:mw:)?editsection>))#';


    function __construct( $text = '', $languageLinks = array(), $categoryLinks = array(),

        $containsOldMagic = false, $titletext = ''

    ) {

        $this->mText = $text;

        $this->mLanguageLinks = $languageLinks;

        $this->mCategories = $categoryLinks;

        $this->mContainsOldMagic = $containsOldMagic;

        $this->mTitleText = $titletext;

    }


    function getText() {

        wfProfileIn( __METHOD__ );

        $text = $this->mText;

        if ( $this->mEditSectionTokens ) {

            $text = preg_replace_callback( ParserOutput::EDITSECTION_REGEX,

                array( &$this, 'replaceEditSectionLinksCallback' ), $text );

        } else {

            $text = preg_replace( ParserOutput::EDITSECTION_REGEX, '', $text );

        }


        // If you have an old cached version of this class - sorry, you can't disable the TOC

        if ( isset( $this->mTOCEnabled ) && $this->mTOCEnabled ) {

            $text = str_replace( array( Parser::TOC_START, Parser::TOC_END ), '', $text );

        } else {

            $text = preg_replace(

                '#' . preg_quote( Parser::TOC_START ) . '.*?' . preg_quote( Parser::TOC_END ) . '#s',

                '',

                $text

            );

        }

        wfProfileOut( __METHOD__ );

        return $text;

    }


    function replaceEditSectionLinksCallback( $m ) {

        global $wgOut, $wgLang;

        $args = array(

            htmlspecialchars_decode( $m[1] ),

            htmlspecialchars_decode( $m[2] ),

            isset( $m[4] ) ? $m[3] : null,

        );

        $args[0] = Title::newFromText( $args[0] );

        if ( !is_object( $args[0] ) ) {

            throw new MWException( "Bad parser output text." );

        }

        $args[] = $wgLang->getCode();

        $skin = $wgOut->getSkin();

        return call_user_func_array( array( $skin, 'doEditSectionLink' ), $args );

    }


    function &getLanguageLinks()         { return $this->mLanguageLinks; }

    function getInterwikiLinks()         { return $this->mInterwikiLinks; }

    function getCategoryLinks()          { return array_keys( $this->mCategories ); }

    function &getCategories()            { return $this->mCategories; }

    function getTitleText()              { return $this->mTitleText; }

    function getSections()               { return $this->mSections; }

    function getEditSectionTokens()      { return $this->mEditSectionTokens; }

    function &getLinks()                 { return $this->mLinks; }

    function &getTemplates()             { return $this->mTemplates; }

    function &getTemplateIds()           { return $this->mTemplateIds; }

    function &getImages()                { return $this->mImages; }

    function &getFileSearchOptions()     { return $this->mFileSearchOptions; }

    function &getExternalLinks()         { return $this->mExternalLinks; }

    function getNoGallery()              { return $this->mNoGallery; }

    function getHeadItems()              { return $this->mHeadItems; }

    function getModules()                { return $this->mModules; }

    function getModuleScripts()          { return $this->mModuleScripts; }

    function getModuleStyles()           { return $this->mModuleStyles; }

    function getModuleMessages()         { return $this->mModuleMessages; }

    function getJsConfigVars()           { return $this->mJsConfigVars; }

    function getOutputHooks()            { return (array)$this->mOutputHooks; }

    function getWarnings()               { return array_keys( $this->mWarnings ); }

    function getIndexPolicy()            { return $this->mIndexPolicy; }

    function getTOCHTML()                { return $this->mTOCHTML; }

    function getTimestamp()              { return $this->mTimestamp; }

    function getLimitReportData()        { return $this->mLimitReportData; }

    function getTOCEnabled()             { return $this->mTOCEnabled; }


    function setText( $text )            { return wfSetVar( $this->mText, $text ); }

    function setLanguageLinks( $ll )     { return wfSetVar( $this->mLanguageLinks, $ll ); }

    function setCategoryLinks( $cl )     { return wfSetVar( $this->mCategories, $cl ); }


    function setTitleText( $t )          { return wfSetVar( $this->mTitleText, $t ); }

    function setSections( $toc )         { return wfSetVar( $this->mSections, $toc ); }

    function setEditSectionTokens( $t )  { return wfSetVar( $this->mEditSectionTokens, $t ); }

    function setIndexPolicy( $policy )   { return wfSetVar( $this->mIndexPolicy, $policy ); }

    function setTOCHTML( $tochtml )      { return wfSetVar( $this->mTOCHTML, $tochtml ); }

    function setTimestamp( $timestamp )  { return wfSetVar( $this->mTimestamp, $timestamp ); }

    function setTOCEnabled( $flag )      { return wfSetVar( $this->mTOCEnabled, $flag ); }


    function addCategory( $c, $sort )    { $this->mCategories[$c] = $sort; }

    function addLanguageLink( $t )       { $this->mLanguageLinks[] = $t; }

    function addWarning( $s )            { $this->mWarnings[$s] = 1; }


    function addOutputHook( $hook, $data = false ) {

        $this->mOutputHooks[] = array( $hook, $data );

    }


    function setNewSection( $value ) {

        $this->mNewSection = (bool)$value;

    }

    function hideNewSection( $value ) {

        $this->mHideNewSection = (bool)$value;

    }

    function getHideNewSection() {

        return (bool)$this->mHideNewSection;

    }

    function getNewSection() {

        return (bool)$this->mNewSection;

    }


    static function isLinkInternal( $internal, $url ) {

        return (bool)preg_match( '/^' .

            # If server is proto relative, check also for http/https links

            ( substr( $internal, 0, 2 ) === '//' ? '(?:https?:)?' : '' ) .

            preg_quote( $internal, '/' ) .

            # check for query/path/anchor or end of link in each case

            '(?:[\?\/\#]|$)/i',

            $url

        );

    }


    function addExternalLink( $url ) {

        # We don't register links pointing to our own server, unless... :-)

        global $wgServer, $wgRegisterInternalExternals;


        # Replace unnecessary URL escape codes with the referenced character

        # This prevents spammers from hiding links from the filters

        $url = Parser::replaceUnusualEscapes( $url );


        $registerExternalLink = true;

        if ( !$wgRegisterInternalExternals ) {

            $registerExternalLink = !self::isLinkInternal( $wgServer, $url );

        }

        if ( $registerExternalLink ) {

            $this->mExternalLinks[$url] = 1;

        }

    }


    function addLink( Title $title, $id = null ) {

        if ( $title->isExternal() ) {

            // Don't record interwikis in pagelinks

            $this->addInterwikiLink( $title );

            return;

        }

        $ns = $title->getNamespace();

        $dbk = $title->getDBkey();

        if ( $ns == NS_MEDIA ) {

            // Normalize this pseudo-alias if it makes it down here...

            $ns = NS_FILE;

        } elseif ( $ns == NS_SPECIAL ) {

            // We don't record Special: links currently

            // It might actually be wise to, but we'd need to do some normalization.

            return;

        } elseif ( $dbk === '' ) {

            // Don't record self links -  [[#Foo]]

            return;

        }

        if ( !isset( $this->mLinks[$ns] ) ) {

            $this->mLinks[$ns] = array();

        }

        if ( is_null( $id ) ) {

            $id = $title->getArticleID();

        }

        $this->mLinks[$ns][$dbk] = $id;

    }


    function addImage( $name, $timestamp = null, $sha1 = null ) {

        $this->mImages[$name] = 1;

        if ( $timestamp !== null && $sha1 !== null ) {

            $this->mFileSearchOptions[$name] = array( 'time' => $timestamp, 'sha1' => $sha1 );

        }

    }


    function addTemplate( $title, $page_id, $rev_id ) {

        $ns = $title->getNamespace();

        $dbk = $title->getDBkey();

        if ( !isset( $this->mTemplates[$ns] ) ) {

            $this->mTemplates[$ns] = array();

        }

        $this->mTemplates[$ns][$dbk] = $page_id;

        if ( !isset( $this->mTemplateIds[$ns] ) ) {

            $this->mTemplateIds[$ns] = array();

        }

        $this->mTemplateIds[$ns][$dbk] = $rev_id; // For versioning

    }


    function addInterwikiLink( $title ) {

        if ( !$title->isExternal() ) {

            throw new MWException( 'Non-interwiki link passed, internal parser error.' );

        }

        $prefix = $title->getInterwiki();

        if ( !isset( $this->mInterwikiLinks[$prefix] ) ) {

            $this->mInterwikiLinks[$prefix] = array();

        }

        $this->mInterwikiLinks[$prefix][$title->getDBkey()] = 1;

    }


    function addHeadItem( $section, $tag = false ) {

        if ( $tag !== false ) {

            $this->mHeadItems[$tag] = $section;

        } else {

            $this->mHeadItems[] = $section;

        }

    }


    public function addModules( $modules ) {

        $this->mModules = array_merge( $this->mModules, (array)$modules );

    }


    public function addModuleScripts( $modules ) {

        $this->mModuleScripts = array_merge( $this->mModuleScripts, (array)$modules );

    }


    public function addModuleStyles( $modules ) {

        $this->mModuleStyles = array_merge( $this->mModuleStyles, (array)$modules );

    }


    public function addModuleMessages( $modules ) {

        $this->mModuleMessages = array_merge( $this->mModuleMessages, (array)$modules );

    }


    public function addJsConfigVars( $keys, $value = null ) {

        if ( is_array( $keys ) ) {

            foreach ( $keys as $key => $value ) {

                $this->mJsConfigVars[$key] = $value;

            }

            return;

        }


        $this->mJsConfigVars[$keys] = $value;

    }


    public function addOutputPageMetadata( OutputPage $out ) {

        $this->addModules( $out->getModules() );

        $this->addModuleScripts( $out->getModuleScripts() );

        $this->addModuleStyles( $out->getModuleStyles() );

        $this->addModuleMessages( $out->getModuleMessages() );

        $this->addJsConfigVars( $out->getJsConfigVars() );


        $this->mHeadItems = array_merge( $this->mHeadItems, $out->getHeadItemsArray() );

        $this->mPreventClickjacking = $this->mPreventClickjacking || $out->getPreventClickjacking();

    }


    public function setDisplayTitle( $text ) {

        $this->setTitleText( $text );

        $this->setProperty( 'displaytitle', $text );

    }


    public function getDisplayTitle() {

        $t = $this->getTitleText();

        if ( $t === '' ) {

            return false;

        }

        return $t;

    }


    public function setFlag( $flag ) {

        $this->mFlags[$flag] = true;

    }


    public function getFlag( $flag ) {

        return isset( $this->mFlags[$flag] );

    }


    public function setProperty( $name, $value ) {

        $this->mProperties[$name] = $value;

    }


    public function getProperty( $name ) {

        return isset( $this->mProperties[$name] ) ? $this->mProperties[$name] : false;

    }


    public function getProperties() {

        if ( !isset( $this->mProperties ) ) {

            $this->mProperties = array();

        }

        return $this->mProperties;

    }


    public function getUsedOptions() {

        if ( !isset( $this->mAccessedOptions ) ) {

            return array();

        }

        return array_keys( $this->mAccessedOptions );

    }


    public function recordOption( $option ) {

        $this->mAccessedOptions[$option] = true;

    }


    public function addSecondaryDataUpdate( DataUpdate $update ) {

        $this->mSecondaryDataUpdates[] = $update;

    }


    public function getSecondaryDataUpdates( Title $title = null, $recursive = true ) {

        if ( is_null( $title ) ) {

            $title = Title::newFromText( $this->getTitleText() );

        }


        $linksUpdate = new LinksUpdate( $title, $this, $recursive );


        return array_merge( $this->mSecondaryDataUpdates, array( $linksUpdate ) );

    }


    public function setExtensionData( $key, $value ) {

        if ( $value === null ) {

            unset( $this->mExtensionData[$key] );

        } else {

            $this->mExtensionData[$key] = $value;

        }

    }


    public function getExtensionData( $key ) {

        if ( isset( $this->mExtensionData[$key] ) ) {

            return $this->mExtensionData[$key];

        }


        return null;

    }


    private static function getTimes( $clock = null ) {

        $ret = array();

        if ( !$clock || $clock === 'wall' ) {

            $ret['wall'] = microtime( true );

        }

        if ( ( !$clock || $clock === 'cpu' ) && function_exists( 'getrusage' ) ) {

            $ru = getrusage();

            $ret['cpu'] = $ru['ru_utime.tv_sec'] + $ru['ru_utime.tv_usec'] / 1e6;

            $ret['cpu'] += $ru['ru_stime.tv_sec'] + $ru['ru_stime.tv_usec'] / 1e6;

        }

        return $ret;

    }


    function resetParseStartTime() {

        $this->mParseStartTime = self::getTimes();

    }


    function getTimeSinceStart( $clock ) {

        if ( !isset( $this->mParseStartTime[$clock] ) ) {

            return null;

        }


        $end = self::getTimes( $clock );

        return $end[$clock] - $this->mParseStartTime[$clock];

    }


    function setLimitReportData( $key, $value ) {

        $this->mLimitReportData[$key] = $value;

    }


    public function preventClickjacking( $flag = null ) {

        return wfSetVar( $this->mPreventClickjacking, $flag );

    }


    function __sleep() {

        return array_diff(

            array_keys( get_object_vars( $this ) ),

            array( 'mSecondaryDataUpdates', 'mParseStartTime' )

        );

    }

}