includes/parser/ParserOptions.php

   1 <?php
   2 /**
   3  * Options for the PHP parser
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup Parser
  22  */
  23
  24 /**
  25  * \brief Set options of the Parser
  26  *
  27  * All member variables are supposed to be private in theory, although in practise this is not the case.
  28  *
  29  * @ingroup Parser
  30  */
  31 class ParserOptions {
  32
  33         /**
  34          * Interlanguage links are removed and returned in an array
  35          */
  36         var $mInterwikiMagic;
  37
  38         /**
  39          * Allow external images inline?
  40          */
  41         var $mAllowExternalImages;
  42
  43         /**
  44          * If not, any exception?
  45          */
  46         var $mAllowExternalImagesFrom;
  47
  48         /**
  49          * If not or it doesn't match, should we check an on-wiki whitelist?
  50          */
  51         var $mEnableImageWhitelist;
  52
  53         /**
  54          * Date format index
  55          */
  56         var $mDateFormat = null;
  57
  58         /**
  59          * Create "edit section" links?
  60          */
  61         var $mEditSection = true;
  62
  63         /**
  64          * Allow inclusion of special pages?
  65          */
  66         var $mAllowSpecialInclusion;
  67
  68         /**
  69          * Use tidy to cleanup output HTML?
  70          */
  71         var $mTidy = false;
  72
  73         /**
  74          * Which lang to call for PLURAL and GRAMMAR
  75          */
  76         var $mInterfaceMessage = false;
  77
  78         /**
  79          * Overrides $mInterfaceMessage with arbitrary language
  80          */
  81         var $mTargetLanguage = null;
  82
  83         /**
  84          * Maximum size of template expansions, in bytes
  85          */
  86         var $mMaxIncludeSize;
  87
  88         /**
  89          * Maximum number of nodes touched by PPFrame::expand()
  90          */
  91         var $mMaxPPNodeCount;
  92
  93         /**
  94          * Maximum number of nodes generated by Preprocessor::preprocessToObj()
  95          */
  96         var $mMaxGeneratedPPNodeCount;
  97
  98         /**
  99          * Maximum recursion depth in PPFrame::expand()
 100          */
 101         var $mMaxPPExpandDepth;
 102
 103         /**
 104          * Maximum recursion depth for templates within templates
 105          */
 106         var $mMaxTemplateDepth;
 107
 108         /**
 109          * Maximum number of calls per parse to expensive parser functions
 110          */
 111         var $mExpensiveParserFunctionLimit;
 112
 113         /**
 114          * Remove HTML comments. ONLY APPLIES TO PREPROCESS OPERATIONS
 115          */
 116         var $mRemoveComments = true;
 117
 118         /**
 119          * Callback for template fetching. Used as first argument to call_user_func().
 120          */
 121         var $mTemplateCallback =
 122                 array( 'Parser', 'statelessFetchTemplate' );
 123
 124         /**
 125          * Enable limit report in an HTML comment on output
 126          */
 127         var $mEnableLimitReport = false;
 128
 129         /**
 130          * Timestamp used for {{CURRENTDAY}} etc.
 131          */
 132         var $mTimestamp;
 133
 134         /**
 135          * Target attribute for external links
 136          */
 137         var $mExternalLinkTarget;
 138
 139         /**
 140          * Clean up signature texts?
 141          *
 142          * 1) Strip ~~~, ~~~~ and ~~~~~ out of signatures
 143          * 2) Substitute all transclusions
 144          */
 145         var $mCleanSignatures;
 146
 147         /**
 148          * Transform wiki markup when saving the page?
 149          */
 150         var $mPreSaveTransform = true;
 151
 152         /**
 153          * Whether content conversion should be disabled
 154          */
 155         var $mDisableContentConversion;
 156
 157         /**
 158          * Whether title conversion should be disabled
 159          */
 160         var $mDisableTitleConversion;
 161
 162         /**
 163          * Automatically number headings?
 164          */
 165         var $mNumberHeadings;
 166
 167         /**
 168          * User math preference (as integer). Not used (1.19)
 169          */
 170         var $mMath;
 171
 172         /**
 173          * Thumb size preferred by the user.
 174          */
 175         var $mThumbSize;
 176
 177         /**
 178          * Maximum article size of an article to be marked as "stub"
 179          */
 180         private $mStubThreshold;
 181
 182         /**
 183          * Language object of the User language.
 184          */
 185         var $mUserLang;
 186
 187         /**
 188          * @var User
 189          * Stored user object
 190          */
 191         var $mUser;
 192
 193         /**
 194          * Parsing the page for a "preview" operation?
 195          */
 196         var $mIsPreview = false;
 197
 198         /**
 199          * Parsing the page for a "preview" operation on a single section?
 200          */
 201         var $mIsSectionPreview = false;
 202
 203         /**
 204          * Parsing the printable version of the page?
 205          */
 206         var $mIsPrintable = false;
 207
 208         /**
 209          * Extra key that should be present in the caching key.
 210          */
 211         var $mExtraKey = '';
 212
 213         /**
 214          * Function to be called when an option is accessed.
 215          */
 216         protected $onAccessCallback = null;
 217
 218         function getInterwikiMagic()                { return $this->mInterwikiMagic; }
 219         function getAllowExternalImages()           { return $this->mAllowExternalImages; }
 220         function getAllowExternalImagesFrom()       { return $this->mAllowExternalImagesFrom; }
 221         function getEnableImageWhitelist()          { return $this->mEnableImageWhitelist; }
 222         function getEditSection()                   { return $this->mEditSection; }
 223         function getNumberHeadings()                { $this->optionUsed( 'numberheadings' );
 224                                                                                                   return $this->mNumberHeadings; }
 225         function getAllowSpecialInclusion()         { return $this->mAllowSpecialInclusion; }
 226         function getTidy()                          { return $this->mTidy; }
 227         function getInterfaceMessage()              { return $this->mInterfaceMessage; }
 228         function getTargetLanguage()                { return $this->mTargetLanguage; }
 229         function getMaxIncludeSize()                { return $this->mMaxIncludeSize; }
 230         function getMaxPPNodeCount()                { return $this->mMaxPPNodeCount; }
 231         function getMaxGeneratedPPNodeCount()       { return $this->mMaxGeneratedPPNodeCount; }
 232         function getMaxPPExpandDepth()              { return $this->mMaxPPExpandDepth; }
 233         function getMaxTemplateDepth()              { return $this->mMaxTemplateDepth; }
 234         /* @since 1.20 */
 235         function getExpensiveParserFunctionLimit()  { return $this->mExpensiveParserFunctionLimit; }
 236         function getRemoveComments()                { return $this->mRemoveComments; }
 237         function getTemplateCallback()              { return $this->mTemplateCallback; }
 238         function getEnableLimitReport()             { return $this->mEnableLimitReport; }
 239         function getCleanSignatures()               { return $this->mCleanSignatures; }
 240         function getExternalLinkTarget()            { return $this->mExternalLinkTarget; }
 241         function getDisableContentConversion()      { return $this->mDisableContentConversion; }
 242         function getDisableTitleConversion()        { return $this->mDisableTitleConversion; }
 243         function getMath()                          { $this->optionUsed( 'math' );
 244                                                                                                   return $this->mMath; }
 245         function getThumbSize()                     { $this->optionUsed( 'thumbsize' );
 246                                                                                                   return $this->mThumbSize; }
 247         function getStubThreshold()                 { $this->optionUsed( 'stubthreshold' );
 248                                                                                                   return $this->mStubThreshold; }
 249
 250         function getIsPreview()                     { return $this->mIsPreview; }
 251         function getIsSectionPreview()              { return $this->mIsSectionPreview; }
 252         function getIsPrintable()                   { $this->optionUsed( 'printable' );
 253                                                                                                   return $this->mIsPrintable; }
 254         function getUser()                          { return $this->mUser; }
 255         function getPreSaveTransform()              { return $this->mPreSaveTransform; }
 256
 257         /**
 258          * @param $title Title
 259          * @return Skin
 260          * @deprecated since 1.18 Use Linker::* instead
 261          */
 262         function getSkin( $title = null ) {
 263                 wfDeprecated( __METHOD__, '1.18' );
 264                 return new DummyLinker;
 265         }
 266
 267         function getDateFormat() {
 268                 $this->optionUsed( 'dateformat' );
 269                 if ( !isset( $this->mDateFormat ) ) {
 270                         $this->mDateFormat = $this->mUser->getDatePreference();
 271                 }
 272                 return $this->mDateFormat;
 273         }
 274
 275         function getTimestamp() {
 276                 if ( !isset( $this->mTimestamp ) ) {
 277                         $this->mTimestamp = wfTimestampNow();
 278                 }
 279                 return $this->mTimestamp;
 280         }
 281
 282         /**
 283          * Get the user language used by the parser for this page.
 284          *
 285          * You shouldn't use this. Really. $parser->getFunctionLang() is all you need.
 286          *
 287          * To avoid side-effects where the page will be rendered based on the language
 288          * of the user who last saved, this function will triger a cache fragmentation.
 289          * Usage of this method is discouraged for that reason.
 290          *
 291          * When saving, this will return the default language instead of the user's.
 292          *
 293          * {{int: }} uses this which used to produce inconsistent link tables (bug 14404).
 294          *
 295          * @return Language object
 296          * @since 1.19
 297          */
 298         function getUserLangObj() {
 299                 $this->optionUsed( 'userlang' );
 300                 return $this->mUserLang;
 301         }
 302
 303         /**
 304          * Same as getUserLangObj() but returns a string instead.
 305          *
 306          * @return String   Language code
 307          * @since 1.17
 308          */
 309         function getUserLang() {
 310                 return $this->getUserLangObj()->getCode();
 311         }
 312
 313         function setInterwikiMagic( $x )            { return wfSetVar( $this->mInterwikiMagic, $x ); }
 314         function setAllowExternalImages( $x )       { return wfSetVar( $this->mAllowExternalImages, $x ); }
 315         function setAllowExternalImagesFrom( $x )   { return wfSetVar( $this->mAllowExternalImagesFrom, $x ); }
 316         function setEnableImageWhitelist( $x )      { return wfSetVar( $this->mEnableImageWhitelist, $x ); }
 317         function setDateFormat( $x )                { return wfSetVar( $this->mDateFormat, $x ); }
 318         function setEditSection( $x )               { return wfSetVar( $this->mEditSection, $x ); }
 319         function setNumberHeadings( $x )            { return wfSetVar( $this->mNumberHeadings, $x ); }
 320         function setAllowSpecialInclusion( $x )     { return wfSetVar( $this->mAllowSpecialInclusion, $x ); }
 321         function setTidy( $x )                      { return wfSetVar( $this->mTidy, $x ); }
 322
 323         /** @deprecated in 1.19 */
 324         function setSkin( $x )                      { wfDeprecated( __METHOD__, '1.19' ); }
 325         function setInterfaceMessage( $x )          { return wfSetVar( $this->mInterfaceMessage, $x ); }
 326         function setTargetLanguage( $x )            { return wfSetVar( $this->mTargetLanguage, $x, true ); }
 327         function setMaxIncludeSize( $x )            { return wfSetVar( $this->mMaxIncludeSize, $x ); }
 328         function setMaxPPNodeCount( $x )            { return wfSetVar( $this->mMaxPPNodeCount, $x ); }
 329         function setMaxGeneratedPPNodeCount( $x )   { return wfSetVar( $this->mMaxGeneratedPPNodeCount, $x ); }
 330         function setMaxTemplateDepth( $x )          { return wfSetVar( $this->mMaxTemplateDepth, $x ); }
 331         /* @since 1.20 */
 332         function setExpensiveParserFunctionLimit( $x ) { return wfSetVar( $this->mExpensiveParserFunctionLimit, $x ); }
 333         function setRemoveComments( $x )            { return wfSetVar( $this->mRemoveComments, $x ); }
 334         function setTemplateCallback( $x )          { return wfSetVar( $this->mTemplateCallback, $x ); }
 335         function enableLimitReport( $x = true )     { return wfSetVar( $this->mEnableLimitReport, $x ); }
 336         function setTimestamp( $x )                 { return wfSetVar( $this->mTimestamp, $x ); }
 337         function setCleanSignatures( $x )           { return wfSetVar( $this->mCleanSignatures, $x ); }
 338         function setExternalLinkTarget( $x )        { return wfSetVar( $this->mExternalLinkTarget, $x ); }
 339         function disableContentConversion( $x = true ) { return wfSetVar( $this->mDisableContentConversion, $x ); }
 340         function disableTitleConversion( $x = true ) { return wfSetVar( $this->mDisableTitleConversion, $x ); }
 341         function setMath( $x )                      { return wfSetVar( $this->mMath, $x ); }
 342         function setUserLang( $x )                  {
 343                 if ( is_string( $x ) ) {
 344                         $x = Language::factory( $x );
 345                 }
 346                 return wfSetVar( $this->mUserLang, $x );
 347         }
 348         function setThumbSize( $x )                 { return wfSetVar( $this->mThumbSize, $x ); }
 349         function setStubThreshold( $x )             { return wfSetVar( $this->mStubThreshold, $x ); }
 350         function setPreSaveTransform( $x )          { return wfSetVar( $this->mPreSaveTransform, $x ); }
 351
 352         function setIsPreview( $x )                 { return wfSetVar( $this->mIsPreview, $x ); }
 353         function setIsSectionPreview( $x )          { return wfSetVar( $this->mIsSectionPreview, $x ); }
 354         function setIsPrintable( $x )               { return wfSetVar( $this->mIsPrintable, $x ); }
 355
 356         /**
 357          * Extra key that should be present in the parser cache key.
 358          */
 359         function addExtraKey( $key ) {
 360                 $this->mExtraKey .= '!' . $key;
 361         }
 362
 363         /**
 364          * Constructor
 365          * @param $user User object
 366          * @param $lang Language object
 367          */
 368         function __construct( $user = null, $lang = null ) {
 369                 if ( $user === null ) {
 370                         global $wgUser;
 371                         if ( $wgUser === null ) {
 372                                 $user = new User;
 373                         } else {
 374                                 $user = $wgUser;
 375                         }
 376                 }
 377                 if ( $lang === null ) {
 378                         global $wgLang;
 379                         if ( !StubObject::isRealObject( $wgLang ) ) {
 380                                 $wgLang->_unstub();
 381                         }
 382                         $lang = $wgLang;
 383                 }
 384                 $this->initialiseFromUser( $user, $lang );
 385         }
 386
 387         /**
 388          * Get a ParserOptions object from a given user.
 389          * Language will be taken from $wgLang.
 390          *
 391          * @param $user User object
 392          * @return ParserOptions object
 393          */
 394         public static function newFromUser( $user ) {
 395                 return new ParserOptions( $user );
 396         }
 397
 398         /**
 399          * Get a ParserOptions object from a given user and language
 400          *
 401          * @param $user User object
 402          * @param $lang Language object
 403          * @return ParserOptions object
 404          */
 405         public static function newFromUserAndLang( User $user, Language $lang ) {
 406                 return new ParserOptions( $user, $lang );
 407         }
 408
 409         /**
 410          * Get a ParserOptions object from a IContextSource object
 411          *
 412          * @param $context IContextSource object
 413          * @return ParserOptions object
 414          */
 415         public static function newFromContext( IContextSource $context ) {
 416                 return new ParserOptions( $context->getUser(), $context->getLanguage() );
 417         }
 418
 419         /**
 420          * Get user options
 421          *
 422          * @param $user User object
 423          * @param $lang Language object
 424          */
 425         private function initialiseFromUser( $user, $lang ) {
 426                 global $wgInterwikiMagic, $wgAllowExternalImages,
 427                         $wgAllowExternalImagesFrom, $wgEnableImageWhitelist, $wgAllowSpecialInclusion,
 428                         $wgMaxArticleSize, $wgMaxPPNodeCount, $wgMaxTemplateDepth, $wgMaxPPExpandDepth,
 429                         $wgCleanSignatures, $wgExternalLinkTarget, $wgExpensiveParserFunctionLimit,
 430                         $wgMaxGeneratedPPNodeCount, $wgDisableLangConversion, $wgDisableTitleConversion;
 431
 432                 wfProfileIn( __METHOD__ );
 433
 434                 $this->mInterwikiMagic = $wgInterwikiMagic;
 435                 $this->mAllowExternalImages = $wgAllowExternalImages;
 436                 $this->mAllowExternalImagesFrom = $wgAllowExternalImagesFrom;
 437                 $this->mEnableImageWhitelist = $wgEnableImageWhitelist;
 438                 $this->mAllowSpecialInclusion = $wgAllowSpecialInclusion;
 439                 $this->mMaxIncludeSize = $wgMaxArticleSize * 1024;
 440                 $this->mMaxPPNodeCount = $wgMaxPPNodeCount;
 441                 $this->mMaxGeneratedPPNodeCount = $wgMaxGeneratedPPNodeCount;
 442                 $this->mMaxPPExpandDepth = $wgMaxPPExpandDepth;
 443                 $this->mMaxTemplateDepth = $wgMaxTemplateDepth;
 444                 $this->mExpensiveParserFunctionLimit = $wgExpensiveParserFunctionLimit;
 445                 $this->mCleanSignatures = $wgCleanSignatures;
 446                 $this->mExternalLinkTarget = $wgExternalLinkTarget;
 447                 $this->mDisableContentConversion = $wgDisableLangConversion;
 448                 $this->mDisableTitleConversion = $wgDisableLangConversion || $wgDisableTitleConversion;
 449
 450                 $this->mUser = $user;
 451                 $this->mNumberHeadings = $user->getOption( 'numberheadings' );
 452                 $this->mMath = $user->getOption( 'math' );
 453                 $this->mThumbSize = $user->getOption( 'thumbsize' );
 454                 $this->mStubThreshold = $user->getStubThreshold();
 455                 $this->mUserLang = $lang;
 456
 457                 wfProfileOut( __METHOD__ );
 458         }
 459
 460         /**
 461          * Registers a callback for tracking which ParserOptions which are used.
 462          * This is a private API with the parser.
 463          */
 464         function registerWatcher( $callback ) {
 465                 $this->onAccessCallback = $callback;
 466         }
 467
 468         /**
 469          * Called when an option is accessed.
 470          */
 471         protected function optionUsed( $optionName ) {
 472                 if ( $this->onAccessCallback ) {
 473                         call_user_func( $this->onAccessCallback, $optionName );
 474                 }
 475         }
 476
 477         /**
 478          * Returns the full array of options that would have been used by
 479          * in 1.16.
 480          * Used to get the old parser cache entries when available.
 481          * @return array
 482          */
 483         public static function legacyOptions() {
 484                 return array( 'math', 'stubthreshold', 'numberheadings', 'userlang', 'thumbsize', 'editsection', 'printable' );
 485         }
 486
 487         /**
 488          * Generate a hash string with the values set on these ParserOptions
 489          * for the keys given in the array.
 490          * This will be used as part of the hash key for the parser cache,
 491          * so users sharign the options with vary for the same page share
 492          * the same cached data safely.
 493          *
 494          * Replaces User::getPageRenderingHash()
 495          *
 496          * Extensions which require it should install 'PageRenderingHash' hook,
 497          * which will give them a chance to modify this key based on their own
 498          * settings.
 499          *
 500          * @since 1.17
 501          * @param $forOptions Array
 502          * @param $title Title: used to get the content language of the page (since r97636)
 503          * @return string Page rendering hash
 504          */
 505         public function optionsHash( $forOptions, $title = null ) {
 506                 global $wgRenderHashAppend;
 507
 508                 $confstr = '';
 509
 510                 if ( in_array( 'math', $forOptions ) ) {
 511                         $confstr .= $this->mMath;
 512                 } else {
 513                         $confstr .= '*';
 514                 }
 515
 516                 // Space assigned for the stubthreshold but unused
 517                 // since it disables the parser cache, its value will always
 518                 // be 0 when this function is called by parsercache.
 519                 if ( in_array( 'stubthreshold', $forOptions ) ) {
 520                         $confstr .= '!' . $this->mStubThreshold;
 521                 } else {
 522                         $confstr .= '!*';
 523                 }
 524
 525                 if ( in_array( 'dateformat', $forOptions ) ) {
 526                         $confstr .= '!' . $this->getDateFormat();
 527                 }
 528
 529                 if ( in_array( 'numberheadings', $forOptions ) ) {
 530                         $confstr .= '!' . ( $this->mNumberHeadings ? '1' : '' );
 531                 } else {
 532                         $confstr .= '!*';
 533                 }
 534
 535                 if ( in_array( 'userlang', $forOptions ) ) {
 536                         $confstr .= '!' . $this->mUserLang->getCode();
 537                 } else {
 538                         $confstr .= '!*';
 539                 }
 540
 541                 if ( in_array( 'thumbsize', $forOptions ) ) {
 542                         $confstr .= '!' . $this->mThumbSize;
 543                 } else {
 544                         $confstr .= '!*';
 545                 }
 546
 547                 // add in language specific options, if any
 548                 // @todo FIXME: This is just a way of retrieving the url/user preferred variant
 549                 if ( !is_null( $title ) ) {
 550                         $confstr .= $title->getPageLanguage()->getExtraHashOptions();
 551                 } else {
 552                         global $wgContLang;
 553                         $confstr .= $wgContLang->getExtraHashOptions();
 554                 }
 555
 556                 $confstr .= $wgRenderHashAppend;
 557
 558                 if ( !in_array( 'editsection', $forOptions ) ) {
 559                         $confstr .= '!*';
 560                 } elseif ( !$this->mEditSection ) {
 561                         $confstr .= '!edit=0';
 562                 }
 563
 564                 if ( $this->mIsPrintable && in_array( 'printable', $forOptions ) ) {
 565                         $confstr .= '!printable=1';
 566                 }
 567
 568                 if ( $this->mExtraKey != '' ) {
 569                         $confstr .= $this->mExtraKey;
 570                 }
 571
 572                 // Give a chance for extensions to modify the hash, if they have
 573                 // extra options or other effects on the parser cache.
 574                 wfRunHooks( 'PageRenderingHash', array( &$confstr ) );
 575
 576                 // Make it a valid memcached key fragment
 577                 $confstr = str_replace( ' ', '_', $confstr );
 578
 579                 return $confstr;
 580         }
 581 }