includes/parser/ParserOptions.php

   1 <?php
   2 /**
   3  * Options for the PHP parser
   4  *
   5  * @file
   6  * @ingroup Parser
   7  */
   8
   9 /**
  10  * Set options of the Parser
  11  * @todo document
  12  * @ingroup Parser
  13  */
  14 class ParserOptions {
  15         # All variables are supposed to be private in theory, although in practise this is not the case.
  16         var $mUseDynamicDates;           # Use DateFormatter to format dates
  17         var $mInterwikiMagic;            # Interlanguage links are removed and returned in an array
  18         var $mAllowExternalImages;       # Allow external images inline
  19         var $mAllowExternalImagesFrom;   # If not, any exception?
  20         var $mEnableImageWhitelist;      # If not or it doesn't match, should we check an on-wiki whitelist?
  21         var $mDateFormat = null;         # Date format index
  22         var $mEditSection = true;        # Create "edit section" links
  23         var $mAllowSpecialInclusion;     # Allow inclusion of special pages
  24         var $mTidy = false;              # Ask for tidy cleanup
  25         var $mInterfaceMessage = false;  # Which lang to call for PLURAL and GRAMMAR
  26         var $mTargetLanguage = null;     # Overrides above setting with arbitrary language
  27         var $mMaxIncludeSize;            # Maximum size of template expansions, in bytes
  28         var $mMaxPPNodeCount;            # Maximum number of nodes touched by PPFrame::expand()
  29         var $mMaxPPExpandDepth;          # Maximum recursion depth in PPFrame::expand()
  30         var $mMaxTemplateDepth;          # Maximum recursion depth for templates within templates
  31         var $mRemoveComments = true;     # Remove HTML comments. ONLY APPLIES TO PREPROCESS OPERATIONS
  32         var $mTemplateCallback =         # Callback for template fetching
  33                 array( 'Parser', 'statelessFetchTemplate' );
  34         var $mEnableLimitReport = false; # Enable limit report in an HTML comment on output
  35         var $mTimestamp;                 # Timestamp used for {{CURRENTDAY}} etc.
  36         var $mExternalLinkTarget;        # Target attribute for external links
  37         var $mCleanSignatures;           #
  38         var $mPreSaveTransform = true;   # Transform wiki markup when saving the page.
  39
  40         var $mNumberHeadings;            # Automatically number headings
  41         var $mMath;                      # User math preference (as integer)
  42         var $mThumbSize;                 # Thumb size preferred by the user.
  43         private $mStubThreshold;         # Maximum article size of an article to be marked as "stub"
  44         var $mUserLang;                  # Language code of the User language.
  45
  46         /**
  47          * @var User
  48          */
  49         var $mUser;                      # Stored user object
  50         var $mIsPreview = false;         # Parsing the page for a "preview" operation
  51         var $mIsSectionPreview = false;  # Parsing the page for a "preview" operation on a single section
  52         var $mIsPrintable = false;       # Parsing the printable version of the page
  53
  54         var $mExtraKey = '';             # Extra key that should be present in the caching key.
  55
  56         protected $onAccessCallback = null;
  57
  58         function getUseDynamicDates()               { return $this->mUseDynamicDates; }
  59         function getInterwikiMagic()                { return $this->mInterwikiMagic; }
  60         function getAllowExternalImages()           { return $this->mAllowExternalImages; }
  61         function getAllowExternalImagesFrom()       { return $this->mAllowExternalImagesFrom; }
  62         function getEnableImageWhitelist()          { return $this->mEnableImageWhitelist; }
  63         function getEditSection()                   { $this->optionUsed('editsection'); return $this->mEditSection; }
  64         function getNumberHeadings()                { $this->optionUsed('numberheadings'); return $this->mNumberHeadings; }
  65         function getAllowSpecialInclusion()         { return $this->mAllowSpecialInclusion; }
  66         function getTidy()                          { return $this->mTidy; }
  67         function getInterfaceMessage()              { return $this->mInterfaceMessage; }
  68         function getTargetLanguage()                { return $this->mTargetLanguage; }
  69         function getMaxIncludeSize()                { return $this->mMaxIncludeSize; }
  70         function getMaxPPNodeCount()                { return $this->mMaxPPNodeCount; }
  71         function getMaxPPExpandDepth()              { return $this->mMaxPPExpandDepth; }
  72         function getMaxTemplateDepth()              { return $this->mMaxTemplateDepth; }
  73         function getRemoveComments()                { return $this->mRemoveComments; }
  74         function getTemplateCallback()              { return $this->mTemplateCallback; }
  75         function getEnableLimitReport()             { return $this->mEnableLimitReport; }
  76         function getCleanSignatures()               { return $this->mCleanSignatures; }
  77         function getExternalLinkTarget()            { return $this->mExternalLinkTarget; }
  78         function getMath()                          { $this->optionUsed('math'); return $this->mMath; }
  79         function getThumbSize()                     { $this->optionUsed('thumbsize'); return $this->mThumbSize; }
  80         function getStubThreshold()                 { $this->optionUsed('stubthreshold'); return $this->mStubThreshold; }
  81
  82         function getIsPreview()                     { return $this->mIsPreview; }
  83         function getIsSectionPreview()              { return $this->mIsSectionPreview; }
  84         function getIsPrintable()                   { $this->optionUsed('printable'); return $this->mIsPrintable; }
  85         function getUser()                          { return $this->mUser; }
  86         function getPreSaveTransform()              { return $this->mPreSaveTransform; }
  87
  88         /**
  89          * @param $title Title
  90          * @return Skin
  91          * @deprecated since 1.18 Use Linker::* instead
  92          */
  93         function getSkin( $title = null ) {
  94                 wfDeprecated( __METHOD__ );
  95                 return new DummyLinker;
  96         }
  97
  98         function getDateFormat() {
  99                 $this->optionUsed('dateformat');
 100                 if ( !isset( $this->mDateFormat ) ) {
 101                         $this->mDateFormat = $this->mUser->getDatePreference();
 102                 }
 103                 return $this->mDateFormat;
 104         }
 105
 106         function getTimestamp() {
 107                 if ( !isset( $this->mTimestamp ) ) {
 108                         $this->mTimestamp = wfTimestampNow();
 109                 }
 110                 return $this->mTimestamp;
 111         }
 112
 113         /**
 114          * You shouldn't use this. Really. $parser->getFunctionLang() is all you need.
 115          * Using this fragments the cache and is discouraged. Yes, {{int: }} uses this,
 116          * producing inconsistent tables (Bug 14404).
 117          */
 118         function getUserLang() {
 119                 $this->optionUsed('userlang');
 120                 return $this->mUserLang;
 121         }
 122
 123         function setUseDynamicDates( $x )           { return wfSetVar( $this->mUseDynamicDates, $x ); }
 124         function setInterwikiMagic( $x )            { return wfSetVar( $this->mInterwikiMagic, $x ); }
 125         function setAllowExternalImages( $x )       { return wfSetVar( $this->mAllowExternalImages, $x ); }
 126         function setAllowExternalImagesFrom( $x )   { return wfSetVar( $this->mAllowExternalImagesFrom, $x ); }
 127         function setEnableImageWhitelist( $x )      { return wfSetVar( $this->mEnableImageWhitelist, $x ); }
 128         function setDateFormat( $x )                { return wfSetVar( $this->mDateFormat, $x ); }
 129         function setEditSection( $x )               { return wfSetVar( $this->mEditSection, $x ); }
 130         function setNumberHeadings( $x )            { return wfSetVar( $this->mNumberHeadings, $x ); }
 131         function setAllowSpecialInclusion( $x )     { return wfSetVar( $this->mAllowSpecialInclusion, $x ); }
 132         function setTidy( $x )                      { return wfSetVar( $this->mTidy, $x); }
 133         function setSkin( $x )                      { $this->mSkin = $x; }
 134         function setInterfaceMessage( $x )          { return wfSetVar( $this->mInterfaceMessage, $x); }
 135         function setTargetLanguage( $x )            { return wfSetVar( $this->mTargetLanguage, $x, true ); }
 136         function setMaxIncludeSize( $x )            { return wfSetVar( $this->mMaxIncludeSize, $x ); }
 137         function setMaxPPNodeCount( $x )            { return wfSetVar( $this->mMaxPPNodeCount, $x ); }
 138         function setMaxTemplateDepth( $x )          { return wfSetVar( $this->mMaxTemplateDepth, $x ); }
 139         function setRemoveComments( $x )            { return wfSetVar( $this->mRemoveComments, $x ); }
 140         function setTemplateCallback( $x )          { return wfSetVar( $this->mTemplateCallback, $x ); }
 141         function enableLimitReport( $x = true )     { return wfSetVar( $this->mEnableLimitReport, $x ); }
 142         function setTimestamp( $x )                 { return wfSetVar( $this->mTimestamp, $x ); }
 143         function setCleanSignatures( $x )           { return wfSetVar( $this->mCleanSignatures, $x ); }
 144         function setExternalLinkTarget( $x )        { return wfSetVar( $this->mExternalLinkTarget, $x ); }
 145         function setMath( $x )                      { return wfSetVar( $this->mMath, $x ); }
 146         function setUserLang( $x )                  { return wfSetVar( $this->mUserLang, $x ); }
 147         function setThumbSize( $x )                 { return wfSetVar( $this->mThumbSize, $x ); }
 148         function setStubThreshold( $x )             { return wfSetVar( $this->mStubThreshold, $x ); }
 149         function setPreSaveTransform( $x )          { return wfSetVar( $this->mPreSaveTransform, $x ); }
 150
 151         function setIsPreview( $x )                 { return wfSetVar( $this->mIsPreview, $x ); }
 152         function setIsSectionPreview( $x )          { return wfSetVar( $this->mIsSectionPreview, $x ); }
 153         function setIsPrintable( $x )               { return wfSetVar( $this->mIsPrintable, $x ); }
 154
 155         /**
 156          * Extra key that should be present in the parser cache key.
 157          */
 158         function addExtraKey( $key ) {
 159                 $this->mExtraKey .= '!' . $key;
 160         }
 161
 162         function __construct( $user = null ) {
 163                 $this->initialiseFromUser( $user );
 164         }
 165
 166         /**
 167          * Get parser options
 168          *
 169          * @param $user User object
 170          * @return ParserOptions object
 171          */
 172         static function newFromUser( $user ) {
 173                 return new ParserOptions( $user );
 174         }
 175
 176         /** Get user options */
 177         function initialiseFromUser( $userInput ) {
 178                 global $wgUseDynamicDates, $wgInterwikiMagic, $wgAllowExternalImages;
 179                 global $wgAllowExternalImagesFrom, $wgEnableImageWhitelist, $wgAllowSpecialInclusion, $wgMaxArticleSize;
 180                 global $wgMaxPPNodeCount, $wgMaxTemplateDepth, $wgMaxPPExpandDepth, $wgCleanSignatures;
 181                 global $wgExternalLinkTarget, $wgLang;
 182
 183                 wfProfileIn( __METHOD__ );
 184
 185                 if ( !$userInput ) {
 186                         global $wgUser;
 187                         if ( isset( $wgUser ) ) {
 188                                 $user = $wgUser;
 189                         } else {
 190                                 $user = new User;
 191                         }
 192                 } else {
 193                         $user =& $userInput;
 194                 }
 195
 196                 $this->mUser = $user;
 197
 198                 $this->mUseDynamicDates = $wgUseDynamicDates;
 199                 $this->mInterwikiMagic = $wgInterwikiMagic;
 200                 $this->mAllowExternalImages = $wgAllowExternalImages;
 201                 $this->mAllowExternalImagesFrom = $wgAllowExternalImagesFrom;
 202                 $this->mEnableImageWhitelist = $wgEnableImageWhitelist;
 203                 $this->mAllowSpecialInclusion = $wgAllowSpecialInclusion;
 204                 $this->mMaxIncludeSize = $wgMaxArticleSize * 1024;
 205                 $this->mMaxPPNodeCount = $wgMaxPPNodeCount;
 206                 $this->mMaxPPExpandDepth = $wgMaxPPExpandDepth;
 207                 $this->mMaxTemplateDepth = $wgMaxTemplateDepth;
 208                 $this->mCleanSignatures = $wgCleanSignatures;
 209                 $this->mExternalLinkTarget = $wgExternalLinkTarget;
 210
 211                 $this->mNumberHeadings = $user->getOption( 'numberheadings' );
 212                 $this->mMath = $user->getOption( 'math' );
 213                 $this->mThumbSize = $user->getOption( 'thumbsize' );
 214                 $this->mStubThreshold = $user->getStubThreshold();
 215                 $this->mUserLang = $wgLang->getCode();
 216
 217                 wfProfileOut( __METHOD__ );
 218         }
 219
 220         /**
 221          * Registers a callback for tracking which ParserOptions which are used.
 222          * This is a private API with the parser.
 223          */
 224         function registerWatcher( $callback ) {
 225                 $this->onAccessCallback = $callback;
 226         }
 227
 228         /**
 229          * Called when an option is accessed.
 230          */
 231         protected function optionUsed( $optionName ) {
 232                 if ( $this->onAccessCallback ) {
 233                         call_user_func( $this->onAccessCallback, $optionName );
 234                 }
 235         }
 236
 237         /**
 238          * Returns the full array of options that would have been used by
 239          * in 1.16.
 240          * Used to get the old parser cache entries when available.
 241          */
 242         public static function legacyOptions() {
 243                 global $wgUseDynamicDates;
 244                 $legacyOpts = array( 'math', 'stubthreshold', 'numberheadings', 'userlang', 'thumbsize', 'editsection', 'printable' );
 245                 if ( $wgUseDynamicDates ) {
 246                         $legacyOpts[] = 'dateformat';
 247                 }
 248                 return $legacyOpts;
 249         }
 250
 251         /**
 252          * Generate a hash string with the values set on these ParserOptions
 253          * for the keys given in the array.
 254          * This will be used as part of the hash key for the parser cache,
 255          * so users sharign the options with vary for the same page share
 256          * the same cached data safely.
 257          *
 258          * Replaces User::getPageRenderingHash()
 259          *
 260          * Extensions which require it should install 'PageRenderingHash' hook,
 261          * which will give them a chance to modify this key based on their own
 262          * settings.
 263          *
 264          * @since 1.17
 265          * @return \string Page rendering hash
 266          */
 267         public function optionsHash( $forOptions ) {
 268                 global $wgContLang, $wgRenderHashAppend;
 269
 270                 $confstr = '';
 271
 272                 if ( in_array( 'math', $forOptions ) )
 273                         $confstr .= $this->mMath;
 274                 else
 275                         $confstr .= '*';
 276
 277
 278                 // Space assigned for the stubthreshold but unused
 279                 // since it disables the parser cache, its value will always
 280                 // be 0 when this function is called by parsercache.
 281                 if ( in_array( 'stubthreshold', $forOptions ) )
 282                         $confstr .= '!' . $this->mStubThreshold;
 283                 else
 284                         $confstr .= '!*' ;
 285
 286                 if ( in_array( 'dateformat', $forOptions ) )
 287                         $confstr .= '!' . $this->getDateFormat();
 288
 289                 if ( in_array( 'numberheadings', $forOptions ) )
 290                         $confstr .= '!' . ( $this->mNumberHeadings ? '1' : '' );
 291                 else
 292                         $confstr .= '!*';
 293
 294                 if ( in_array( 'userlang', $forOptions ) )
 295                         $confstr .= '!' . $this->mUserLang;
 296                 else
 297                         $confstr .= '!*';
 298
 299                 if ( in_array( 'thumbsize', $forOptions ) )
 300                         $confstr .= '!' . $this->mThumbSize;
 301                 else
 302                         $confstr .= '!*';
 303
 304                 // add in language specific options, if any
 305                 // @todo FIXME: This is just a way of retrieving the url/user preferred variant
 306                 $confstr .= $wgContLang->getExtraHashOptions();
 307
 308                 $confstr .= $wgRenderHashAppend;
 309
 310                 if ( !in_array( 'editsection', $forOptions ) ) {
 311                         $confstr .= '!*';
 312                 } elseif ( !$this->mEditSection ) {
 313                         $confstr .= '!edit=0';
 314                 }
 315
 316                 if (  $this->mIsPrintable && in_array( 'printable', $forOptions ) )
 317                         $confstr .= '!printable=1';
 318
 319                 if ( $this->mExtraKey != '' )
 320                         $confstr .= $this->mExtraKey;
 321
 322                 // Give a chance for extensions to modify the hash, if they have
 323                 // extra options or other effects on the parser cache.
 324                 wfRunHooks( 'PageRenderingHash', array( &$confstr ) );
 325
 326                 // Make it a valid memcached key fragment
 327                 $confstr = str_replace( ' ', '_', $confstr );
 328
 329                 return $confstr;
 330         }
 331 }