Drop connetion between Skin and Linker and turn Linker into a staticly usable class.
[lhc/web/wiklou.git] / includes / parser / ParserOutput.php
index ac89cc9..a0224ac 100644 (file)
@@ -100,8 +100,7 @@ class CacheTime {
        }               
 }
  
-class ParserOutput extends CacheTime
-{
+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
@@ -110,19 +109,24 @@ class ParserOutput extends CacheTime
                $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
+               $mImageTimeKeys = 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
+               $mModules = array(),          # Modules to be loaded by the resource loader
                $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
        private $mIndexPolicy = '';           # 'index' or 'noindex'?  Any other value will result in no change.
+       private $mAccessedOptions = array(); # List of ParserOptions (stored in the keys)
+
+       const EDITSECTION_REGEX = '#<(?:mw:)?editsection page="(.*?)" section="(.*?)"(?:/>|>(.*?)(</(?:mw:)?editsection>))#';
 
        function __construct( $text = '', $languageLinks = array(), $categoryLinks = array(),
                $containsOldMagic = false, $titletext = '' )
@@ -134,21 +138,50 @@ class ParserOutput extends CacheTime
                $this->mTitleText = $titletext;
        }
 
-       function getText()                   { return $this->mText; }
+       function getText() {
+               if ( $this->mEditSectionTokens ) {
+                       return preg_replace_callback( ParserOutput::EDITSECTION_REGEX,
+                               array( &$this, 'replaceEditSectionLinksCallback' ), $this->mText );
+               }
+               return $this->mText;
+       }
+       
+       /**
+        * callback used by getText to replace editsection tokens
+        * @private
+        */
+       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 &getImageTimeKeys()         { return $this->mImageTimeKeys; }
        function &getExternalLinks()         { return $this->mExternalLinks; }
        function getNoGallery()              { return $this->mNoGallery; }
        function getHeadItems()              { return $this->mHeadItems; }
-       function getModules()                    { return $this->mModules; }
-       function getSubtitle()               { return $this->mSubtitle; }
+       function getModules()                { return $this->mModules; }
        function getOutputHooks()            { return (array)$this->mOutputHooks; }
        function getWarnings()               { return array_keys( $this->mWarnings ); }
        function getIndexPolicy()            { return $this->mIndexPolicy; }
@@ -160,6 +193,7 @@ class ParserOutput extends CacheTime
 
        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 ); }
 
@@ -225,10 +259,23 @@ class ParserOutput extends CacheTime
                $this->mLinks[$ns][$dbk] = $id;
        }
 
-       function addImage( $name ) {
+       /**
+        * @param $name string Title dbKey
+        * @param $timestamp string MW timestamp of file creation
+        * @param $sha string base 36 SHA-1 of file
+        * @return void
+        */
+       function addImage( $name, $timestamp = null, $sha1 = null ) {
                $this->mImages[$name] = 1;
+               $this->mImageTimeKeys[$name] = array( 'time' => $timestamp, 'sha1' => $sha1 );
        }
 
+       /**
+        * @param $title Title
+        * @param $page_id
+        * @param $rev_id
+        * @return void
+        */
        function addTemplate( $title, $page_id, $rev_id ) {
                $ns = $title->getNamespace();
                $dbk = $title->getDBkey();
@@ -292,7 +339,7 @@ class ParserOutput extends CacheTime
         * @return String
         */
        public function getDisplayTitle() {
-               $t = $this->getTitleText( );
+               $t = $this->getTitleText();
                if( $t === '' ) {
                        return false;
                }
@@ -327,4 +374,25 @@ class ParserOutput extends CacheTime
                }
                return $this->mProperties;
        }
+       
+       
+       /**
+        * Returns the options from its ParserOptions which have been taken 
+        * into account to produce this output or false if not available.
+        * @return mixed Array/false
+        */
+        public function getUsedOptions() {
+               if ( !isset( $this->mAccessedOptions ) ) {
+                       return false;
+               }
+               return array_keys( $this->mAccessedOptions );
+        }
+        
+        /**
+         * Callback passed by the Parser to the ParserOptions to keep track of which options are used.
+         * @access private
+         */
+        function recordOption( $option ) {
+                $this->mAccessedOptions[$option] = true;
+        }
 }