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()                   { return $this->mEditSection; }
  64         function getNumberHeadings()                { $this->optionUsed('numberheadings');
  65                                                                                                   return $this->mNumberHeadings; }
  66         function getAllowSpecialInclusion()         { return $this->mAllowSpecialInclusion; }
  67         function getTidy()                          { return $this->mTidy; }
  68         function getInterfaceMessage()              { return $this->mInterfaceMessage; }
  69         function getTargetLanguage()                { return $this->mTargetLanguage; }
  70         function getMaxIncludeSize()                { return $this->mMaxIncludeSize; }
  71         function getMaxPPNodeCount()                { return $this->mMaxPPNodeCount; }
  72         function getMaxPPExpandDepth()              { return $this->mMaxPPExpandDepth; }
  73         function getMaxTemplateDepth()              { return $this->mMaxTemplateDepth; }
  74         function getRemoveComments()                { return $this->mRemoveComments; }
  75         function getTemplateCallback()              { return $this->mTemplateCallback; }
  76         function getEnableLimitReport()             { return $this->mEnableLimitReport; }
  77         function getCleanSignatures()               { return $this->mCleanSignatures; }
  78         function getExternalLinkTarget()            { return $this->mExternalLinkTarget; }
  79         function getMath()                          { $this->optionUsed('math');
  80                                                                                                   return $this->mMath; }
  81         function getThumbSize()                     { $this->optionUsed('thumbsize');
  82                                                                                                   return $this->mThumbSize; }
  83         function getStubThreshold()                 { $this->optionUsed('stubthreshold');
  84                                                                                                   return $this->mStubThreshold; }
  85
  86         function getIsPreview()                     { return $this->mIsPreview; }
  87         function getIsSectionPreview()              { return $this->mIsSectionPreview; }
  88         function getIsPrintable()                   { $this->optionUsed('printable');
  89                                                                                                   return $this->mIsPrintable; }
  90         function getUser()                          { return $this->mUser; }
  91         function getPreSaveTransform()              { return $this->mPreSaveTransform; }
  92
  93         /**
  94          * @param $title Title
  95          * @return Skin
  96          * @deprecated Use Linker::* instead
  97          */
  98         function getSkin( $title = null ) {
  99                 wfDeprecated( __METHOD__ );
 100                 return new DummyLinker;
 101         }
 102
 103         function getDateFormat() {
 104                 $this->optionUsed('dateformat');
 105                 if ( !isset( $this->mDateFormat ) ) {
 106                         $this->mDateFormat = $this->mUser->getDatePreference();
 107                 }
 108                 return $this->mDateFormat;
 109         }
 110
 111         function getTimestamp() {
 112                 if ( !isset( $this->mTimestamp ) ) {
 113                         $this->mTimestamp = wfTimestampNow();
 114                 }
 115                 return $this->mTimestamp;
 116         }
 117
 118         /**
 119          * You shouldn't use this. Really. $parser->getFunctionLang() is all you need.
 120          * Using this fragments the cache and is discouraged. Yes, {{int: }} uses this,
 121          * producing inconsistent tables (Bug 14404).
 122          */
 123         function getUserLang() {
 124                 $this->optionUsed('userlang');
 125                 return $this->mUserLang;
 126         }
 127
 128         function setUseDynamicDates( $x )           { return wfSetVar( $this->mUseDynamicDates, $x ); }
 129         function setInterwikiMagic( $x )            { return wfSetVar( $this->mInterwikiMagic, $x ); }
 130         function setAllowExternalImages( $x )       { return wfSetVar( $this->mAllowExternalImages, $x ); }
 131         function setAllowExternalImagesFrom( $x )   { return wfSetVar( $this->mAllowExternalImagesFrom, $x ); }
 132         function setEnableImageWhitelist( $x )      { return wfSetVar( $this->mEnableImageWhitelist, $x ); }
 133         function setDateFormat( $x )                { return wfSetVar( $this->mDateFormat, $x ); }
 134         function setEditSection( $x )               { return wfSetVar( $this->mEditSection, $x ); }
 135         function setNumberHeadings( $x )            { return wfSetVar( $this->mNumberHeadings, $x ); }
 136         function setAllowSpecialInclusion( $x )     { return wfSetVar( $this->mAllowSpecialInclusion, $x ); }
 137         function setTidy( $x )                      { return wfSetVar( $this->mTidy, $x); }
 138         function setSkin( $x )                      { $this->mSkin = $x; }
 139         function setInterfaceMessage( $x )          { return wfSetVar( $this->mInterfaceMessage, $x); }
 140         function setTargetLanguage( $x )            { return wfSetVar( $this->mTargetLanguage, $x); }
 141         function setMaxIncludeSize( $x )            { return wfSetVar( $this->mMaxIncludeSize, $x ); }
 142         function setMaxPPNodeCount( $x )            { return wfSetVar( $this->mMaxPPNodeCount, $x ); }
 143         function setMaxTemplateDepth( $x )          { return wfSetVar( $this->mMaxTemplateDepth, $x ); }
 144         function setRemoveComments( $x )            { return wfSetVar( $this->mRemoveComments, $x ); }
 145         function setTemplateCallback( $x )          { return wfSetVar( $this->mTemplateCallback, $x ); }
 146         function enableLimitReport( $x = true )     { return wfSetVar( $this->mEnableLimitReport, $x ); }
 147         function setTimestamp( $x )                 { return wfSetVar( $this->mTimestamp, $x ); }
 148         function setCleanSignatures( $x )           { return wfSetVar( $this->mCleanSignatures, $x ); }
 149         function setExternalLinkTarget( $x )        { return wfSetVar( $this->mExternalLinkTarget, $x ); }
 150         function setMath( $x )                      { return wfSetVar( $this->mMath, $x ); }
 151         function setUserLang( $x )                  { return wfSetVar( $this->mUserLang, $x ); }
 152         function setThumbSize( $x )                 { return wfSetVar( $this->mThumbSize, $x ); }
 153         function setStubThreshold( $x )             { return wfSetVar( $this->mStubThreshold, $x ); }
 154         function setPreSaveTransform( $x )          { return wfSetVar( $this->mPreSaveTransform, $x ); }
 155
 156         function setIsPreview( $x )                 { return wfSetVar( $this->mIsPreview, $x ); }
 157         function setIsSectionPreview( $x )          { return wfSetVar( $this->mIsSectionPreview, $x ); }
 158         function setIsPrintable( $x )               { return wfSetVar( $this->mIsPrintable, $x ); }
 159
 160         /**
 161          * Extra key that should be present in the parser cache key.
 162          */
 163         function addExtraKey( $key ) {
 164                 $this->mExtraKey .= '!' . $key;
 165         }
 166
 167         function __construct( $user = null ) {
 168                 $this->initialiseFromUser( $user );
 169         }
 170
 171         /**
 172          * Get parser options
 173          *
 174          * @param $user User object
 175          * @return ParserOptions object
 176          */
 177         static function newFromUser( $user ) {
 178                 return new ParserOptions( $user );
 179         }
 180
 181         /** Get user options */
 182         function initialiseFromUser( $userInput ) {
 183                 global $wgUseDynamicDates, $wgInterwikiMagic, $wgAllowExternalImages;
 184                 global $wgAllowExternalImagesFrom, $wgEnableImageWhitelist, $wgAllowSpecialInclusion, $wgMaxArticleSize;
 185                 global $wgMaxPPNodeCount, $wgMaxTemplateDepth, $wgMaxPPExpandDepth, $wgCleanSignatures;
 186                 global $wgExternalLinkTarget, $wgLang;
 187
 188                 wfProfileIn( __METHOD__ );
 189
 190                 if ( !$userInput ) {
 191                         global $wgUser;
 192                         if ( isset( $wgUser ) ) {
 193                                 $user = $wgUser;
 194                         } else {
 195                                 $user = new User;
 196                         }
 197                 } else {
 198                         $user =& $userInput;
 199                 }
 200
 201                 $this->mUser = $user;
 202
 203                 $this->mUseDynamicDates = $wgUseDynamicDates;
 204                 $this->mInterwikiMagic = $wgInterwikiMagic;
 205                 $this->mAllowExternalImages = $wgAllowExternalImages;
 206                 $this->mAllowExternalImagesFrom = $wgAllowExternalImagesFrom;
 207                 $this->mEnableImageWhitelist = $wgEnableImageWhitelist;
 208                 $this->mAllowSpecialInclusion = $wgAllowSpecialInclusion;
 209                 $this->mMaxIncludeSize = $wgMaxArticleSize * 1024;
 210                 $this->mMaxPPNodeCount = $wgMaxPPNodeCount;
 211                 $this->mMaxPPExpandDepth = $wgMaxPPExpandDepth;
 212                 $this->mMaxTemplateDepth = $wgMaxTemplateDepth;
 213                 $this->mCleanSignatures = $wgCleanSignatures;
 214                 $this->mExternalLinkTarget = $wgExternalLinkTarget;
 215
 216                 $this->mNumberHeadings = $user->getOption( 'numberheadings' );
 217                 $this->mMath = $user->getOption( 'math' );
 218                 $this->mThumbSize = $user->getOption( 'thumbsize' );
 219                 $this->mStubThreshold = $user->getStubThreshold();
 220                 $this->mUserLang = $wgLang->getCode();
 221
 222                 wfProfileOut( __METHOD__ );
 223         }
 224
 225         /**
 226          * Registers a callback for tracking which ParserOptions which are used.
 227          * This is a private API with the parser.
 228          */
 229         function registerWatcher( $callback ) {
 230                 $this->onAccessCallback = $callback;
 231         }
 232
 233         /**
 234          * Called when an option is accessed.
 235          */
 236         protected function optionUsed( $optionName ) {
 237                 if ( $this->onAccessCallback ) {
 238                         call_user_func( $this->onAccessCallback, $optionName );
 239                 }
 240         }
 241
 242         /**
 243          * Returns the full array of options that would have been used by
 244          * in 1.16.
 245          * Used to get the old parser cache entries when available.
 246          */
 247         public static function legacyOptions() {
 248                 global $wgUseDynamicDates;
 249                 $legacyOpts = array( 'math', 'stubthreshold', 'numberheadings', 'userlang', 'thumbsize', 'editsection', 'printable' );
 250                 if ( $wgUseDynamicDates ) {
 251                         $legacyOpts[] = 'dateformat';
 252                 }
 253                 return $legacyOpts;
 254         }
 255
 256         /**
 257          * Generate a hash string with the values set on these ParserOptions
 258          * for the keys given in the array.
 259          * This will be used as part of the hash key for the parser cache,
 260          * so users sharign the options with vary for the same page share
 261          * the same cached data safely.
 262          *
 263          * Replaces User::getPageRenderingHash()
 264          *
 265          * Extensions which require it should install 'PageRenderingHash' hook,
 266          * which will give them a chance to modify this key based on their own
 267          * settings.
 268          *
 269          * @since 1.17
 270          * @return \string Page rendering hash
 271          */
 272         public function optionsHash( $forOptions ) {
 273                 global $wgContLang, $wgRenderHashAppend;
 274
 275                 $confstr = '';
 276
 277                 if ( in_array( 'math', $forOptions ) )
 278                         $confstr .= $this->mMath;
 279                 else
 280                         $confstr .= '*';
 281
 282
 283                 // Space assigned for the stubthreshold but unused
 284                 // since it disables the parser cache, its value will always
 285                 // be 0 when this function is called by parsercache.
 286                 if ( in_array( 'stubthreshold', $forOptions ) )
 287                         $confstr .= '!' . $this->mStubThreshold;
 288                 else
 289                         $confstr .= '!*' ;
 290
 291                 if ( in_array( 'dateformat', $forOptions ) )
 292                         $confstr .= '!' . $this->getDateFormat();
 293
 294                 if ( in_array( 'numberheadings', $forOptions ) )
 295                         $confstr .= '!' . ( $this->mNumberHeadings ? '1' : '' );
 296                 else
 297                         $confstr .= '!*';
 298
 299                 if ( in_array( 'userlang', $forOptions ) )
 300                         $confstr .= '!' . $this->mUserLang;
 301                 else
 302                         $confstr .= '!*';
 303
 304                 if ( in_array( 'thumbsize', $forOptions ) )
 305                         $confstr .= '!' . $this->mThumbSize;
 306                 else
 307                         $confstr .= '!*';
 308
 309                 // add in language specific options, if any
 310                 // FIXME: This is just a way of retrieving the url/user preferred variant
 311                 $confstr .= $wgContLang->getExtraHashOptions();
 312
 313                 $confstr .= $wgRenderHashAppend;
 314
 315                 if ( !in_array( 'editsection', $forOptions ) ) {
 316                         $confstr .= '!*';
 317                 } elseif ( !$this->mEditSection ) {
 318                         $confstr .= '!edit=0';
 319                 }
 320
 321                 if (  $this->mIsPrintable && in_array( 'printable', $forOptions ) )
 322                         $confstr .= '!printable=1';
 323
 324                 if ( $this->mExtraKey != '' )
 325                         $confstr .= $this->mExtraKey;
 326
 327                 // Give a chance for extensions to modify the hash, if they have
 328                 // extra options or other effects on the parser cache.
 329                 wfRunHooks( 'PageRenderingHash', array( &$confstr ) );
 330
 331                 // Make it a valid memcached key fragment
 332                 $confstr = str_replace( ' ', '_', $confstr );
 333
 334                 return $confstr;
 335         }
 336 }