Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like OutputPage often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use OutputPage, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 43 | class OutputPage extends ContextSource { |
||
| 44 | /** @var array Should be private. Used with addMeta() which adds "<meta>" */ |
||
| 45 | protected $mMetatags = []; |
||
| 46 | |||
| 47 | /** @var array */ |
||
| 48 | protected $mLinktags = []; |
||
| 49 | |||
| 50 | /** @var bool */ |
||
| 51 | protected $mCanonicalUrl = false; |
||
| 52 | |||
| 53 | /** |
||
| 54 | * @var array Additional stylesheets. Looks like this is for extensions. |
||
| 55 | * Might be replaced by ResourceLoader. |
||
| 56 | */ |
||
| 57 | protected $mExtStyles = []; |
||
| 58 | |||
| 59 | /** |
||
| 60 | * @var string Should be private - has getter and setter. Contains |
||
| 61 | * the HTML title */ |
||
| 62 | public $mPagetitle = ''; |
||
| 63 | |||
| 64 | /** |
||
| 65 | * @var string Contains all of the "<body>" content. Should be private we |
||
| 66 | * got set/get accessors and the append() method. |
||
| 67 | */ |
||
| 68 | public $mBodytext = ''; |
||
| 69 | |||
| 70 | /** @var string Stores contents of "<title>" tag */ |
||
| 71 | private $mHTMLtitle = ''; |
||
| 72 | |||
| 73 | /** |
||
| 74 | * @var bool Is the displayed content related to the source of the |
||
| 75 | * corresponding wiki article. |
||
| 76 | */ |
||
| 77 | private $mIsarticle = false; |
||
| 78 | |||
| 79 | /** @var bool Stores "article flag" toggle. */ |
||
| 80 | private $mIsArticleRelated = true; |
||
| 81 | |||
| 82 | /** |
||
| 83 | * @var bool We have to set isPrintable(). Some pages should |
||
| 84 | * never be printed (ex: redirections). |
||
| 85 | */ |
||
| 86 | private $mPrintable = false; |
||
| 87 | |||
| 88 | /** |
||
| 89 | * @var array Contains the page subtitle. Special pages usually have some |
||
| 90 | * links here. Don't confuse with site subtitle added by skins. |
||
| 91 | */ |
||
| 92 | private $mSubtitle = []; |
||
| 93 | |||
| 94 | /** @var string */ |
||
| 95 | public $mRedirect = ''; |
||
| 96 | |||
| 97 | /** @var int */ |
||
| 98 | protected $mStatusCode; |
||
| 99 | |||
| 100 | /** |
||
| 101 | * @var string Used for sending cache control. |
||
| 102 | * The whole caching system should probably be moved into its own class. |
||
| 103 | */ |
||
| 104 | protected $mLastModified = ''; |
||
| 105 | |||
| 106 | /** @var array */ |
||
| 107 | protected $mCategoryLinks = []; |
||
| 108 | |||
| 109 | /** @var array */ |
||
| 110 | protected $mCategories = []; |
||
| 111 | |||
| 112 | /** @var array */ |
||
| 113 | protected $mIndicators = []; |
||
| 114 | |||
| 115 | /** @var array Array of Interwiki Prefixed (non DB key) Titles (e.g. 'fr:Test page') */ |
||
| 116 | private $mLanguageLinks = []; |
||
| 117 | |||
| 118 | /** |
||
| 119 | * Used for JavaScript (predates ResourceLoader) |
||
| 120 | * @todo We should split JS / CSS. |
||
| 121 | * mScripts content is inserted as is in "<head>" by Skin. This might |
||
| 122 | * contain either a link to a stylesheet or inline CSS. |
||
| 123 | */ |
||
| 124 | private $mScripts = ''; |
||
| 125 | |||
| 126 | /** @var string Inline CSS styles. Use addInlineStyle() sparingly */ |
||
| 127 | protected $mInlineStyles = ''; |
||
| 128 | |||
| 129 | /** |
||
| 130 | * @var string Used by skin template. |
||
| 131 | * Example: $tpl->set( 'displaytitle', $out->mPageLinkTitle ); |
||
| 132 | */ |
||
| 133 | public $mPageLinkTitle = ''; |
||
| 134 | |||
| 135 | /** @var array Array of elements in "<head>". Parser might add its own headers! */ |
||
| 136 | protected $mHeadItems = []; |
||
| 137 | |||
| 138 | /** @var array */ |
||
| 139 | protected $mModules = []; |
||
| 140 | |||
| 141 | /** @var array */ |
||
| 142 | protected $mModuleScripts = []; |
||
| 143 | |||
| 144 | /** @var array */ |
||
| 145 | protected $mModuleStyles = []; |
||
| 146 | |||
| 147 | /** @var ResourceLoader */ |
||
| 148 | protected $mResourceLoader; |
||
| 149 | |||
| 150 | /** @var ResourceLoaderClientHtml */ |
||
| 151 | private $rlClient; |
||
| 152 | |||
| 153 | /** @var ResourceLoaderContext */ |
||
| 154 | private $rlClientContext; |
||
| 155 | |||
| 156 | /** @var string */ |
||
| 157 | private $rlUserModuleState; |
||
| 158 | |||
| 159 | /** @var array */ |
||
| 160 | private $rlExemptStyleModules; |
||
| 161 | |||
| 162 | /** @var array */ |
||
| 163 | protected $mJsConfigVars = []; |
||
| 164 | |||
| 165 | /** @var array */ |
||
| 166 | protected $mTemplateIds = []; |
||
| 167 | |||
| 168 | /** @var array */ |
||
| 169 | protected $mImageTimeKeys = []; |
||
| 170 | |||
| 171 | /** @var string */ |
||
| 172 | public $mRedirectCode = ''; |
||
| 173 | |||
| 174 | protected $mFeedLinksAppendQuery = null; |
||
| 175 | |||
| 176 | /** @var array |
||
| 177 | * What level of 'untrustworthiness' is allowed in CSS/JS modules loaded on this page? |
||
| 178 | * @see ResourceLoaderModule::$origin |
||
| 179 | * ResourceLoaderModule::ORIGIN_ALL is assumed unless overridden; |
||
| 180 | */ |
||
| 181 | protected $mAllowedModules = [ |
||
| 182 | ResourceLoaderModule::TYPE_COMBINED => ResourceLoaderModule::ORIGIN_ALL, |
||
| 183 | ]; |
||
| 184 | |||
| 185 | /** @var bool Whether output is disabled. If this is true, the 'output' method will do nothing. */ |
||
| 186 | protected $mDoNothing = false; |
||
| 187 | |||
| 188 | // Parser related. |
||
| 189 | |||
| 190 | /** @var int */ |
||
| 191 | protected $mContainsNewMagic = 0; |
||
| 192 | |||
| 193 | /** |
||
| 194 | * lazy initialised, use parserOptions() |
||
| 195 | * @var ParserOptions |
||
| 196 | */ |
||
| 197 | protected $mParserOptions = null; |
||
| 198 | |||
| 199 | /** |
||
| 200 | * Handles the Atom / RSS links. |
||
| 201 | * We probably only support Atom in 2011. |
||
| 202 | * @see $wgAdvertisedFeedTypes |
||
| 203 | */ |
||
| 204 | private $mFeedLinks = []; |
||
| 205 | |||
| 206 | // Gwicke work on squid caching? Roughly from 2003. |
||
| 207 | protected $mEnableClientCache = true; |
||
| 208 | |||
| 209 | /** @var bool Flag if output should only contain the body of the article. */ |
||
| 210 | private $mArticleBodyOnly = false; |
||
| 211 | |||
| 212 | /** @var bool */ |
||
| 213 | protected $mNewSectionLink = false; |
||
| 214 | |||
| 215 | /** @var bool */ |
||
| 216 | protected $mHideNewSectionLink = false; |
||
| 217 | |||
| 218 | /** |
||
| 219 | * @var bool Comes from the parser. This was probably made to load CSS/JS |
||
| 220 | * only if we had "<gallery>". Used directly in CategoryPage.php. |
||
| 221 | * Looks like ResourceLoader can replace this. |
||
| 222 | */ |
||
| 223 | public $mNoGallery = false; |
||
| 224 | |||
| 225 | /** @var string */ |
||
| 226 | private $mPageTitleActionText = ''; |
||
| 227 | |||
| 228 | /** @var int Cache stuff. Looks like mEnableClientCache */ |
||
| 229 | protected $mCdnMaxage = 0; |
||
| 230 | /** @var int Upper limit on mCdnMaxage */ |
||
| 231 | protected $mCdnMaxageLimit = INF; |
||
| 232 | |||
| 233 | /** |
||
| 234 | * @var bool Controls if anti-clickjacking / frame-breaking headers will |
||
| 235 | * be sent. This should be done for pages where edit actions are possible. |
||
| 236 | * Setters: $this->preventClickjacking() and $this->allowClickjacking(). |
||
| 237 | */ |
||
| 238 | protected $mPreventClickjacking = true; |
||
| 239 | |||
| 240 | /** @var int To include the variable {{REVISIONID}} */ |
||
| 241 | private $mRevisionId = null; |
||
| 242 | |||
| 243 | /** @var string */ |
||
| 244 | private $mRevisionTimestamp = null; |
||
| 245 | |||
| 246 | /** @var array */ |
||
| 247 | protected $mFileVersion = null; |
||
| 248 | |||
| 249 | /** |
||
| 250 | * @var array An array of stylesheet filenames (relative from skins path), |
||
| 251 | * with options for CSS media, IE conditions, and RTL/LTR direction. |
||
| 252 | * For internal use; add settings in the skin via $this->addStyle() |
||
| 253 | * |
||
| 254 | * Style again! This seems like a code duplication since we already have |
||
| 255 | * mStyles. This is what makes Open Source amazing. |
||
| 256 | */ |
||
| 257 | protected $styles = []; |
||
| 258 | |||
| 259 | private $mIndexPolicy = 'index'; |
||
| 260 | private $mFollowPolicy = 'follow'; |
||
| 261 | private $mVaryHeader = [ |
||
| 262 | 'Accept-Encoding' => [ 'match=gzip' ], |
||
| 263 | ]; |
||
| 264 | |||
| 265 | /** |
||
| 266 | * If the current page was reached through a redirect, $mRedirectedFrom contains the Title |
||
| 267 | * of the redirect. |
||
| 268 | * |
||
| 269 | * @var Title |
||
| 270 | */ |
||
| 271 | private $mRedirectedFrom = null; |
||
| 272 | |||
| 273 | /** |
||
| 274 | * Additional key => value data |
||
| 275 | */ |
||
| 276 | private $mProperties = []; |
||
| 277 | |||
| 278 | /** |
||
| 279 | * @var string|null ResourceLoader target for load.php links. If null, will be omitted |
||
| 280 | */ |
||
| 281 | private $mTarget = null; |
||
| 282 | |||
| 283 | /** |
||
| 284 | * @var bool Whether parser output should contain table of contents |
||
| 285 | */ |
||
| 286 | private $mEnableTOC = true; |
||
| 287 | |||
| 288 | /** |
||
| 289 | * @var bool Whether parser output should contain section edit links |
||
| 290 | */ |
||
| 291 | private $mEnableSectionEditLinks = true; |
||
| 292 | |||
| 293 | /** |
||
| 294 | * @var string|null The URL to send in a <link> element with rel=copyright |
||
| 295 | */ |
||
| 296 | private $copyrightUrl; |
||
| 297 | |||
| 298 | /** @var array Profiling data */ |
||
| 299 | private $limitReportData = []; |
||
| 300 | |||
| 301 | /** |
||
| 302 | * Constructor for OutputPage. This should not be called directly. |
||
| 303 | * Instead a new RequestContext should be created and it will implicitly create |
||
| 304 | * a OutputPage tied to that context. |
||
| 305 | * @param IContextSource|null $context |
||
| 306 | */ |
||
| 307 | function __construct( IContextSource $context = null ) { |
||
| 308 | if ( $context === null ) { |
||
| 309 | # Extensions should use `new RequestContext` instead of `new OutputPage` now. |
||
| 310 | wfDeprecated( __METHOD__, '1.18' ); |
||
| 311 | } else { |
||
| 312 | $this->setContext( $context ); |
||
| 313 | } |
||
| 314 | } |
||
| 315 | |||
| 316 | /** |
||
| 317 | * Redirect to $url rather than displaying the normal page |
||
| 318 | * |
||
| 319 | * @param string $url URL |
||
| 320 | * @param string $responsecode HTTP status code |
||
| 321 | */ |
||
| 322 | public function redirect( $url, $responsecode = '302' ) { |
||
| 323 | # Strip newlines as a paranoia check for header injection in PHP<5.1.2 |
||
| 324 | $this->mRedirect = str_replace( "\n", '', $url ); |
||
| 325 | $this->mRedirectCode = $responsecode; |
||
| 326 | } |
||
| 327 | |||
| 328 | /** |
||
| 329 | * Get the URL to redirect to, or an empty string if not redirect URL set |
||
| 330 | * |
||
| 331 | * @return string |
||
| 332 | */ |
||
| 333 | public function getRedirect() { |
||
| 334 | return $this->mRedirect; |
||
| 335 | } |
||
| 336 | |||
| 337 | /** |
||
| 338 | * Set the copyright URL to send with the output. |
||
| 339 | * Empty string to omit, null to reset. |
||
| 340 | * |
||
| 341 | * @since 1.26 |
||
| 342 | * |
||
| 343 | * @param string|null $url |
||
| 344 | */ |
||
| 345 | public function setCopyrightUrl( $url ) { |
||
| 346 | $this->copyrightUrl = $url; |
||
| 347 | } |
||
| 348 | |||
| 349 | /** |
||
| 350 | * Set the HTTP status code to send with the output. |
||
| 351 | * |
||
| 352 | * @param int $statusCode |
||
| 353 | */ |
||
| 354 | public function setStatusCode( $statusCode ) { |
||
| 355 | $this->mStatusCode = $statusCode; |
||
| 356 | } |
||
| 357 | |||
| 358 | /** |
||
| 359 | * Add a new "<meta>" tag |
||
| 360 | * To add an http-equiv meta tag, precede the name with "http:" |
||
| 361 | * |
||
| 362 | * @param string $name Tag name |
||
| 363 | * @param string $val Tag value |
||
| 364 | */ |
||
| 365 | function addMeta( $name, $val ) { |
||
| 366 | array_push( $this->mMetatags, [ $name, $val ] ); |
||
| 367 | } |
||
| 368 | |||
| 369 | /** |
||
| 370 | * Returns the current <meta> tags |
||
| 371 | * |
||
| 372 | * @since 1.25 |
||
| 373 | * @return array |
||
| 374 | */ |
||
| 375 | public function getMetaTags() { |
||
| 376 | return $this->mMetatags; |
||
| 377 | } |
||
| 378 | |||
| 379 | /** |
||
| 380 | * Add a new \<link\> tag to the page header. |
||
| 381 | * |
||
| 382 | * Note: use setCanonicalUrl() for rel=canonical. |
||
| 383 | * |
||
| 384 | * @param array $linkarr Associative array of attributes. |
||
| 385 | */ |
||
| 386 | function addLink( array $linkarr ) { |
||
| 387 | array_push( $this->mLinktags, $linkarr ); |
||
| 388 | } |
||
| 389 | |||
| 390 | /** |
||
| 391 | * Returns the current <link> tags |
||
| 392 | * |
||
| 393 | * @since 1.25 |
||
| 394 | * @return array |
||
| 395 | */ |
||
| 396 | public function getLinkTags() { |
||
| 397 | return $this->mLinktags; |
||
| 398 | } |
||
| 399 | |||
| 400 | /** |
||
| 401 | * Add a new \<link\> with "rel" attribute set to "meta" |
||
| 402 | * |
||
| 403 | * @param array $linkarr Associative array mapping attribute names to their |
||
| 404 | * values, both keys and values will be escaped, and the |
||
| 405 | * "rel" attribute will be automatically added |
||
| 406 | */ |
||
| 407 | function addMetadataLink( array $linkarr ) { |
||
| 408 | $linkarr['rel'] = $this->getMetadataAttribute(); |
||
| 409 | $this->addLink( $linkarr ); |
||
| 410 | } |
||
| 411 | |||
| 412 | /** |
||
| 413 | * Set the URL to be used for the <link rel=canonical>. This should be used |
||
| 414 | * in preference to addLink(), to avoid duplicate link tags. |
||
| 415 | * @param string $url |
||
| 416 | */ |
||
| 417 | function setCanonicalUrl( $url ) { |
||
| 418 | $this->mCanonicalUrl = $url; |
||
|
|
|||
| 419 | } |
||
| 420 | |||
| 421 | /** |
||
| 422 | * Returns the URL to be used for the <link rel=canonical> if |
||
| 423 | * one is set. |
||
| 424 | * |
||
| 425 | * @since 1.25 |
||
| 426 | * @return bool|string |
||
| 427 | */ |
||
| 428 | public function getCanonicalUrl() { |
||
| 429 | return $this->mCanonicalUrl; |
||
| 430 | } |
||
| 431 | |||
| 432 | /** |
||
| 433 | * Get the value of the "rel" attribute for metadata links |
||
| 434 | * |
||
| 435 | * @return string |
||
| 436 | */ |
||
| 437 | public function getMetadataAttribute() { |
||
| 438 | # note: buggy CC software only reads first "meta" link |
||
| 439 | static $haveMeta = false; |
||
| 440 | if ( $haveMeta ) { |
||
| 441 | return 'alternate meta'; |
||
| 442 | } else { |
||
| 443 | $haveMeta = true; |
||
| 444 | return 'meta'; |
||
| 445 | } |
||
| 446 | } |
||
| 447 | |||
| 448 | /** |
||
| 449 | * Add raw HTML to the list of scripts (including \<script\> tag, etc.) |
||
| 450 | * Internal use only. Use OutputPage::addModules() or OutputPage::addJsConfigVars() |
||
| 451 | * if possible. |
||
| 452 | * |
||
| 453 | * @param string $script Raw HTML |
||
| 454 | */ |
||
| 455 | function addScript( $script ) { |
||
| 456 | $this->mScripts .= $script; |
||
| 457 | } |
||
| 458 | |||
| 459 | /** |
||
| 460 | * Register and add a stylesheet from an extension directory. |
||
| 461 | * |
||
| 462 | * @deprecated since 1.27 use addModuleStyles() or addStyle() instead |
||
| 463 | * @param string $url Path to sheet. Provide either a full url (beginning |
||
| 464 | * with 'http', etc) or a relative path from the document root |
||
| 465 | * (beginning with '/'). Otherwise it behaves identically to |
||
| 466 | * addStyle() and draws from the /skins folder. |
||
| 467 | */ |
||
| 468 | public function addExtensionStyle( $url ) { |
||
| 469 | wfDeprecated( __METHOD__, '1.27' ); |
||
| 470 | array_push( $this->mExtStyles, $url ); |
||
| 471 | } |
||
| 472 | |||
| 473 | /** |
||
| 474 | * Get all styles added by extensions |
||
| 475 | * |
||
| 476 | * @deprecated since 1.27 |
||
| 477 | * @return array |
||
| 478 | */ |
||
| 479 | function getExtStyle() { |
||
| 480 | wfDeprecated( __METHOD__, '1.27' ); |
||
| 481 | return $this->mExtStyles; |
||
| 482 | } |
||
| 483 | |||
| 484 | /** |
||
| 485 | * Add a JavaScript file out of skins/common, or a given relative path. |
||
| 486 | * Internal use only. Use OutputPage::addModules() if possible. |
||
| 487 | * |
||
| 488 | * @param string $file Filename in skins/common or complete on-server path |
||
| 489 | * (/foo/bar.js) |
||
| 490 | * @param string $version Style version of the file. Defaults to $wgStyleVersion |
||
| 491 | */ |
||
| 492 | public function addScriptFile( $file, $version = null ) { |
||
| 493 | // See if $file parameter is an absolute URL or begins with a slash |
||
| 494 | if ( substr( $file, 0, 1 ) == '/' || preg_match( '#^[a-z]*://#i', $file ) ) { |
||
| 495 | $path = $file; |
||
| 496 | } else { |
||
| 497 | $path = $this->getConfig()->get( 'StylePath' ) . "/common/{$file}"; |
||
| 498 | } |
||
| 499 | if ( is_null( $version ) ) { |
||
| 500 | $version = $this->getConfig()->get( 'StyleVersion' ); |
||
| 501 | } |
||
| 502 | $this->addScript( Html::linkedScript( wfAppendQuery( $path, $version ) ) ); |
||
| 503 | } |
||
| 504 | |||
| 505 | /** |
||
| 506 | * Add a self-contained script tag with the given contents |
||
| 507 | * Internal use only. Use OutputPage::addModules() if possible. |
||
| 508 | * |
||
| 509 | * @param string $script JavaScript text, no script tags |
||
| 510 | */ |
||
| 511 | public function addInlineScript( $script ) { |
||
| 512 | $this->mScripts .= Html::inlineScript( $script ); |
||
| 513 | } |
||
| 514 | |||
| 515 | /** |
||
| 516 | * Filter an array of modules to remove insufficiently trustworthy members, and modules |
||
| 517 | * which are no longer registered (eg a page is cached before an extension is disabled) |
||
| 518 | * @param array $modules |
||
| 519 | * @param string|null $position If not null, only return modules with this position |
||
| 520 | * @param string $type |
||
| 521 | * @return array |
||
| 522 | */ |
||
| 523 | protected function filterModules( array $modules, $position = null, |
||
| 524 | $type = ResourceLoaderModule::TYPE_COMBINED |
||
| 525 | ) { |
||
| 526 | $resourceLoader = $this->getResourceLoader(); |
||
| 527 | $filteredModules = []; |
||
| 528 | foreach ( $modules as $val ) { |
||
| 529 | $module = $resourceLoader->getModule( $val ); |
||
| 530 | if ( $module instanceof ResourceLoaderModule |
||
| 531 | && $module->getOrigin() <= $this->getAllowedModules( $type ) |
||
| 532 | && ( is_null( $position ) || $module->getPosition() == $position ) |
||
| 533 | && ( !$this->mTarget || in_array( $this->mTarget, $module->getTargets() ) ) |
||
| 534 | ) { |
||
| 535 | $filteredModules[] = $val; |
||
| 536 | } |
||
| 537 | } |
||
| 538 | return $filteredModules; |
||
| 539 | } |
||
| 540 | |||
| 541 | /** |
||
| 542 | * Get the list of modules to include on this page |
||
| 543 | * |
||
| 544 | * @param bool $filter Whether to filter out insufficiently trustworthy modules |
||
| 545 | * @param string|null $position If not null, only return modules with this position |
||
| 546 | * @param string $param |
||
| 547 | * @return array Array of module names |
||
| 548 | */ |
||
| 549 | public function getModules( $filter = false, $position = null, $param = 'mModules', |
||
| 550 | $type = ResourceLoaderModule::TYPE_COMBINED |
||
| 551 | ) { |
||
| 552 | $modules = array_values( array_unique( $this->$param ) ); |
||
| 553 | return $filter |
||
| 554 | ? $this->filterModules( $modules, $position, $type ) |
||
| 555 | : $modules; |
||
| 556 | } |
||
| 557 | |||
| 558 | /** |
||
| 559 | * Add one or more modules recognized by ResourceLoader. Modules added |
||
| 560 | * through this function will be loaded by ResourceLoader when the |
||
| 561 | * page loads. |
||
| 562 | * |
||
| 563 | * @param string|array $modules Module name (string) or array of module names |
||
| 564 | */ |
||
| 565 | public function addModules( $modules ) { |
||
| 566 | $this->mModules = array_merge( $this->mModules, (array)$modules ); |
||
| 567 | } |
||
| 568 | |||
| 569 | /** |
||
| 570 | * Get the list of module JS to include on this page |
||
| 571 | * |
||
| 572 | * @param bool $filter |
||
| 573 | * @param string|null $position |
||
| 574 | * @return array Array of module names |
||
| 575 | */ |
||
| 576 | public function getModuleScripts( $filter = false, $position = null ) { |
||
| 577 | return $this->getModules( $filter, $position, 'mModuleScripts', |
||
| 578 | ResourceLoaderModule::TYPE_SCRIPTS |
||
| 579 | ); |
||
| 580 | } |
||
| 581 | |||
| 582 | /** |
||
| 583 | * Add only JS of one or more modules recognized by ResourceLoader. Module |
||
| 584 | * scripts added through this function will be loaded by ResourceLoader when |
||
| 585 | * the page loads. |
||
| 586 | * |
||
| 587 | * @param string|array $modules Module name (string) or array of module names |
||
| 588 | */ |
||
| 589 | public function addModuleScripts( $modules ) { |
||
| 590 | $this->mModuleScripts = array_merge( $this->mModuleScripts, (array)$modules ); |
||
| 591 | } |
||
| 592 | |||
| 593 | /** |
||
| 594 | * Get the list of module CSS to include on this page |
||
| 595 | * |
||
| 596 | * @param bool $filter |
||
| 597 | * @param string|null $position |
||
| 598 | * @return array Array of module names |
||
| 599 | */ |
||
| 600 | public function getModuleStyles( $filter = false, $position = null ) { |
||
| 601 | return $this->getModules( $filter, $position, 'mModuleStyles', |
||
| 602 | ResourceLoaderModule::TYPE_STYLES |
||
| 603 | ); |
||
| 604 | } |
||
| 605 | |||
| 606 | /** |
||
| 607 | * Add only CSS of one or more modules recognized by ResourceLoader. |
||
| 608 | * |
||
| 609 | * Module styles added through this function will be added using standard link CSS |
||
| 610 | * tags, rather than as a combined Javascript and CSS package. Thus, they will |
||
| 611 | * load when JavaScript is disabled (unless CSS also happens to be disabled). |
||
| 612 | * |
||
| 613 | * @param string|array $modules Module name (string) or array of module names |
||
| 614 | */ |
||
| 615 | public function addModuleStyles( $modules ) { |
||
| 616 | $this->mModuleStyles = array_merge( $this->mModuleStyles, (array)$modules ); |
||
| 617 | } |
||
| 618 | |||
| 619 | /** |
||
| 620 | * @return null|string ResourceLoader target |
||
| 621 | */ |
||
| 622 | public function getTarget() { |
||
| 623 | return $this->mTarget; |
||
| 624 | } |
||
| 625 | |||
| 626 | /** |
||
| 627 | * Sets ResourceLoader target for load.php links. If null, will be omitted |
||
| 628 | * |
||
| 629 | * @param string|null $target |
||
| 630 | */ |
||
| 631 | public function setTarget( $target ) { |
||
| 632 | $this->mTarget = $target; |
||
| 633 | } |
||
| 634 | |||
| 635 | /** |
||
| 636 | * Get an array of head items |
||
| 637 | * |
||
| 638 | * @return array |
||
| 639 | */ |
||
| 640 | function getHeadItemsArray() { |
||
| 641 | return $this->mHeadItems; |
||
| 642 | } |
||
| 643 | |||
| 644 | /** |
||
| 645 | * Add or replace a head item to the output |
||
| 646 | * |
||
| 647 | * Whenever possible, use more specific options like ResourceLoader modules, |
||
| 648 | * OutputPage::addLink(), OutputPage::addMetaLink() and OutputPage::addFeedLink() |
||
| 649 | * Fallback options for those are: OutputPage::addStyle, OutputPage::addScript(), |
||
| 650 | * OutputPage::addInlineScript() and OutputPage::addInlineStyle() |
||
| 651 | * This would be your very LAST fallback. |
||
| 652 | * |
||
| 653 | * @param string $name Item name |
||
| 654 | * @param string $value Raw HTML |
||
| 655 | */ |
||
| 656 | public function addHeadItem( $name, $value ) { |
||
| 657 | $this->mHeadItems[$name] = $value; |
||
| 658 | } |
||
| 659 | |||
| 660 | /** |
||
| 661 | * Add one or more head items to the output |
||
| 662 | * |
||
| 663 | * @since 1.28 |
||
| 664 | * @param string|string[] $value Raw HTML |
||
| 665 | */ |
||
| 666 | public function addHeadItems( $values ) { |
||
| 667 | $this->mHeadItems = array_merge( $this->mHeadItems, (array)$values ); |
||
| 668 | } |
||
| 669 | |||
| 670 | /** |
||
| 671 | * Check if the header item $name is already set |
||
| 672 | * |
||
| 673 | * @param string $name Item name |
||
| 674 | * @return bool |
||
| 675 | */ |
||
| 676 | public function hasHeadItem( $name ) { |
||
| 677 | return isset( $this->mHeadItems[$name] ); |
||
| 678 | } |
||
| 679 | |||
| 680 | /** |
||
| 681 | * @deprecated since 1.28 Obsolete - wgUseETag experiment was removed. |
||
| 682 | * @param string $tag |
||
| 683 | */ |
||
| 684 | public function setETag( $tag ) { |
||
| 685 | } |
||
| 686 | |||
| 687 | /** |
||
| 688 | * Set whether the output should only contain the body of the article, |
||
| 689 | * without any skin, sidebar, etc. |
||
| 690 | * Used e.g. when calling with "action=render". |
||
| 691 | * |
||
| 692 | * @param bool $only Whether to output only the body of the article |
||
| 693 | */ |
||
| 694 | public function setArticleBodyOnly( $only ) { |
||
| 695 | $this->mArticleBodyOnly = $only; |
||
| 696 | } |
||
| 697 | |||
| 698 | /** |
||
| 699 | * Return whether the output will contain only the body of the article |
||
| 700 | * |
||
| 701 | * @return bool |
||
| 702 | */ |
||
| 703 | public function getArticleBodyOnly() { |
||
| 704 | return $this->mArticleBodyOnly; |
||
| 705 | } |
||
| 706 | |||
| 707 | /** |
||
| 708 | * Set an additional output property |
||
| 709 | * @since 1.21 |
||
| 710 | * |
||
| 711 | * @param string $name |
||
| 712 | * @param mixed $value |
||
| 713 | */ |
||
| 714 | public function setProperty( $name, $value ) { |
||
| 715 | $this->mProperties[$name] = $value; |
||
| 716 | } |
||
| 717 | |||
| 718 | /** |
||
| 719 | * Get an additional output property |
||
| 720 | * @since 1.21 |
||
| 721 | * |
||
| 722 | * @param string $name |
||
| 723 | * @return mixed Property value or null if not found |
||
| 724 | */ |
||
| 725 | public function getProperty( $name ) { |
||
| 726 | if ( isset( $this->mProperties[$name] ) ) { |
||
| 727 | return $this->mProperties[$name]; |
||
| 728 | } else { |
||
| 729 | return null; |
||
| 730 | } |
||
| 731 | } |
||
| 732 | |||
| 733 | /** |
||
| 734 | * checkLastModified tells the client to use the client-cached page if |
||
| 735 | * possible. If successful, the OutputPage is disabled so that |
||
| 736 | * any future call to OutputPage->output() have no effect. |
||
| 737 | * |
||
| 738 | * Side effect: sets mLastModified for Last-Modified header |
||
| 739 | * |
||
| 740 | * @param string $timestamp |
||
| 741 | * |
||
| 742 | * @return bool True if cache-ok headers was sent. |
||
| 743 | */ |
||
| 744 | public function checkLastModified( $timestamp ) { |
||
| 745 | if ( !$timestamp || $timestamp == '19700101000000' ) { |
||
| 746 | wfDebug( __METHOD__ . ": CACHE DISABLED, NO TIMESTAMP\n" ); |
||
| 747 | return false; |
||
| 748 | } |
||
| 749 | $config = $this->getConfig(); |
||
| 750 | if ( !$config->get( 'CachePages' ) ) { |
||
| 751 | wfDebug( __METHOD__ . ": CACHE DISABLED\n" ); |
||
| 752 | return false; |
||
| 753 | } |
||
| 754 | |||
| 755 | $timestamp = wfTimestamp( TS_MW, $timestamp ); |
||
| 756 | $modifiedTimes = [ |
||
| 757 | 'page' => $timestamp, |
||
| 758 | 'user' => $this->getUser()->getTouched(), |
||
| 759 | 'epoch' => $config->get( 'CacheEpoch' ) |
||
| 760 | ]; |
||
| 761 | if ( $config->get( 'UseSquid' ) ) { |
||
| 762 | // bug 44570: the core page itself may not change, but resources might |
||
| 763 | $modifiedTimes['sepoch'] = wfTimestamp( TS_MW, time() - $config->get( 'SquidMaxage' ) ); |
||
| 764 | } |
||
| 765 | Hooks::run( 'OutputPageCheckLastModified', [ &$modifiedTimes, $this ] ); |
||
| 766 | |||
| 767 | $maxModified = max( $modifiedTimes ); |
||
| 768 | $this->mLastModified = wfTimestamp( TS_RFC2822, $maxModified ); |
||
| 769 | |||
| 770 | $clientHeader = $this->getRequest()->getHeader( 'If-Modified-Since' ); |
||
| 771 | if ( $clientHeader === false ) { |
||
| 772 | wfDebug( __METHOD__ . ": client did not send If-Modified-Since header", 'private' ); |
||
| 773 | return false; |
||
| 774 | } |
||
| 775 | |||
| 776 | # IE sends sizes after the date like this: |
||
| 777 | # Wed, 20 Aug 2003 06:51:19 GMT; length=5202 |
||
| 778 | # this breaks strtotime(). |
||
| 779 | $clientHeader = preg_replace( '/;.*$/', '', $clientHeader ); |
||
| 780 | |||
| 781 | MediaWiki\suppressWarnings(); // E_STRICT system time bitching |
||
| 782 | $clientHeaderTime = strtotime( $clientHeader ); |
||
| 783 | MediaWiki\restoreWarnings(); |
||
| 784 | if ( !$clientHeaderTime ) { |
||
| 785 | wfDebug( __METHOD__ |
||
| 786 | . ": unable to parse the client's If-Modified-Since header: $clientHeader\n" ); |
||
| 787 | return false; |
||
| 788 | } |
||
| 789 | $clientHeaderTime = wfTimestamp( TS_MW, $clientHeaderTime ); |
||
| 790 | |||
| 791 | # Make debug info |
||
| 792 | $info = ''; |
||
| 793 | foreach ( $modifiedTimes as $name => $value ) { |
||
| 794 | if ( $info !== '' ) { |
||
| 795 | $info .= ', '; |
||
| 796 | } |
||
| 797 | $info .= "$name=" . wfTimestamp( TS_ISO_8601, $value ); |
||
| 798 | } |
||
| 799 | |||
| 800 | wfDebug( __METHOD__ . ": client sent If-Modified-Since: " . |
||
| 801 | wfTimestamp( TS_ISO_8601, $clientHeaderTime ), 'private' ); |
||
| 802 | wfDebug( __METHOD__ . ": effective Last-Modified: " . |
||
| 803 | wfTimestamp( TS_ISO_8601, $maxModified ), 'private' ); |
||
| 804 | if ( $clientHeaderTime < $maxModified ) { |
||
| 805 | wfDebug( __METHOD__ . ": STALE, $info", 'private' ); |
||
| 806 | return false; |
||
| 807 | } |
||
| 808 | |||
| 809 | # Not modified |
||
| 810 | # Give a 304 Not Modified response code and disable body output |
||
| 811 | wfDebug( __METHOD__ . ": NOT MODIFIED, $info", 'private' ); |
||
| 812 | ini_set( 'zlib.output_compression', 0 ); |
||
| 813 | $this->getRequest()->response()->statusHeader( 304 ); |
||
| 814 | $this->sendCacheControl(); |
||
| 815 | $this->disable(); |
||
| 816 | |||
| 817 | // Don't output a compressed blob when using ob_gzhandler; |
||
| 818 | // it's technically against HTTP spec and seems to confuse |
||
| 819 | // Firefox when the response gets split over two packets. |
||
| 820 | wfClearOutputBuffers(); |
||
| 821 | |||
| 822 | return true; |
||
| 823 | } |
||
| 824 | |||
| 825 | /** |
||
| 826 | * Override the last modified timestamp |
||
| 827 | * |
||
| 828 | * @param string $timestamp New timestamp, in a format readable by |
||
| 829 | * wfTimestamp() |
||
| 830 | */ |
||
| 831 | public function setLastModified( $timestamp ) { |
||
| 832 | $this->mLastModified = wfTimestamp( TS_RFC2822, $timestamp ); |
||
| 833 | } |
||
| 834 | |||
| 835 | /** |
||
| 836 | * Set the robot policy for the page: <http://www.robotstxt.org/meta.html> |
||
| 837 | * |
||
| 838 | * @param string $policy The literal string to output as the contents of |
||
| 839 | * the meta tag. Will be parsed according to the spec and output in |
||
| 840 | * standardized form. |
||
| 841 | * @return null |
||
| 842 | */ |
||
| 843 | public function setRobotPolicy( $policy ) { |
||
| 844 | $policy = Article::formatRobotPolicy( $policy ); |
||
| 845 | |||
| 846 | if ( isset( $policy['index'] ) ) { |
||
| 847 | $this->setIndexPolicy( $policy['index'] ); |
||
| 848 | } |
||
| 849 | if ( isset( $policy['follow'] ) ) { |
||
| 850 | $this->setFollowPolicy( $policy['follow'] ); |
||
| 851 | } |
||
| 852 | } |
||
| 853 | |||
| 854 | /** |
||
| 855 | * Set the index policy for the page, but leave the follow policy un- |
||
| 856 | * touched. |
||
| 857 | * |
||
| 858 | * @param string $policy Either 'index' or 'noindex'. |
||
| 859 | * @return null |
||
| 860 | */ |
||
| 861 | public function setIndexPolicy( $policy ) { |
||
| 862 | $policy = trim( $policy ); |
||
| 863 | if ( in_array( $policy, [ 'index', 'noindex' ] ) ) { |
||
| 864 | $this->mIndexPolicy = $policy; |
||
| 865 | } |
||
| 866 | } |
||
| 867 | |||
| 868 | /** |
||
| 869 | * Set the follow policy for the page, but leave the index policy un- |
||
| 870 | * touched. |
||
| 871 | * |
||
| 872 | * @param string $policy Either 'follow' or 'nofollow'. |
||
| 873 | * @return null |
||
| 874 | */ |
||
| 875 | public function setFollowPolicy( $policy ) { |
||
| 876 | $policy = trim( $policy ); |
||
| 877 | if ( in_array( $policy, [ 'follow', 'nofollow' ] ) ) { |
||
| 878 | $this->mFollowPolicy = $policy; |
||
| 879 | } |
||
| 880 | } |
||
| 881 | |||
| 882 | /** |
||
| 883 | * Set the new value of the "action text", this will be added to the |
||
| 884 | * "HTML title", separated from it with " - ". |
||
| 885 | * |
||
| 886 | * @param string $text New value of the "action text" |
||
| 887 | */ |
||
| 888 | public function setPageTitleActionText( $text ) { |
||
| 889 | $this->mPageTitleActionText = $text; |
||
| 890 | } |
||
| 891 | |||
| 892 | /** |
||
| 893 | * Get the value of the "action text" |
||
| 894 | * |
||
| 895 | * @return string |
||
| 896 | */ |
||
| 897 | public function getPageTitleActionText() { |
||
| 898 | return $this->mPageTitleActionText; |
||
| 899 | } |
||
| 900 | |||
| 901 | /** |
||
| 902 | * "HTML title" means the contents of "<title>". |
||
| 903 | * It is stored as plain, unescaped text and will be run through htmlspecialchars in the skin file. |
||
| 904 | * |
||
| 905 | * @param string|Message $name |
||
| 906 | */ |
||
| 907 | public function setHTMLTitle( $name ) { |
||
| 908 | if ( $name instanceof Message ) { |
||
| 909 | $this->mHTMLtitle = $name->setContext( $this->getContext() )->text(); |
||
| 910 | } else { |
||
| 911 | $this->mHTMLtitle = $name; |
||
| 912 | } |
||
| 913 | } |
||
| 914 | |||
| 915 | /** |
||
| 916 | * Return the "HTML title", i.e. the content of the "<title>" tag. |
||
| 917 | * |
||
| 918 | * @return string |
||
| 919 | */ |
||
| 920 | public function getHTMLTitle() { |
||
| 921 | return $this->mHTMLtitle; |
||
| 922 | } |
||
| 923 | |||
| 924 | /** |
||
| 925 | * Set $mRedirectedFrom, the Title of the page which redirected us to the current page. |
||
| 926 | * |
||
| 927 | * @param Title $t |
||
| 928 | */ |
||
| 929 | public function setRedirectedFrom( $t ) { |
||
| 930 | $this->mRedirectedFrom = $t; |
||
| 931 | } |
||
| 932 | |||
| 933 | /** |
||
| 934 | * "Page title" means the contents of \<h1\>. It is stored as a valid HTML |
||
| 935 | * fragment. This function allows good tags like \<sup\> in the \<h1\> tag, |
||
| 936 | * but not bad tags like \<script\>. This function automatically sets |
||
| 937 | * \<title\> to the same content as \<h1\> but with all tags removed. Bad |
||
| 938 | * tags that were escaped in \<h1\> will still be escaped in \<title\>, and |
||
| 939 | * good tags like \<i\> will be dropped entirely. |
||
| 940 | * |
||
| 941 | * @param string|Message $name |
||
| 942 | */ |
||
| 943 | public function setPageTitle( $name ) { |
||
| 944 | if ( $name instanceof Message ) { |
||
| 945 | $name = $name->setContext( $this->getContext() )->text(); |
||
| 946 | } |
||
| 947 | |||
| 948 | # change "<script>foo&bar</script>" to "<script>foo&bar</script>" |
||
| 949 | # but leave "<i>foobar</i>" alone |
||
| 950 | $nameWithTags = Sanitizer::normalizeCharReferences( Sanitizer::removeHTMLtags( $name ) ); |
||
| 951 | $this->mPagetitle = $nameWithTags; |
||
| 952 | |||
| 953 | # change "<i>foo&bar</i>" to "foo&bar" |
||
| 954 | $this->setHTMLTitle( |
||
| 955 | $this->msg( 'pagetitle' )->rawParams( Sanitizer::stripAllTags( $nameWithTags ) ) |
||
| 956 | ->inContentLanguage() |
||
| 957 | ); |
||
| 958 | } |
||
| 959 | |||
| 960 | /** |
||
| 961 | * Return the "page title", i.e. the content of the \<h1\> tag. |
||
| 962 | * |
||
| 963 | * @return string |
||
| 964 | */ |
||
| 965 | public function getPageTitle() { |
||
| 966 | return $this->mPagetitle; |
||
| 967 | } |
||
| 968 | |||
| 969 | /** |
||
| 970 | * Set the Title object to use |
||
| 971 | * |
||
| 972 | * @param Title $t |
||
| 973 | */ |
||
| 974 | public function setTitle( Title $t ) { |
||
| 975 | $this->getContext()->setTitle( $t ); |
||
| 976 | } |
||
| 977 | |||
| 978 | /** |
||
| 979 | * Replace the subtitle with $str |
||
| 980 | * |
||
| 981 | * @param string|Message $str New value of the subtitle. String should be safe HTML. |
||
| 982 | */ |
||
| 983 | public function setSubtitle( $str ) { |
||
| 984 | $this->clearSubtitle(); |
||
| 985 | $this->addSubtitle( $str ); |
||
| 986 | } |
||
| 987 | |||
| 988 | /** |
||
| 989 | * Add $str to the subtitle |
||
| 990 | * |
||
| 991 | * @param string|Message $str String or Message to add to the subtitle. String should be safe HTML. |
||
| 992 | */ |
||
| 993 | public function addSubtitle( $str ) { |
||
| 994 | if ( $str instanceof Message ) { |
||
| 995 | $this->mSubtitle[] = $str->setContext( $this->getContext() )->parse(); |
||
| 996 | } else { |
||
| 997 | $this->mSubtitle[] = $str; |
||
| 998 | } |
||
| 999 | } |
||
| 1000 | |||
| 1001 | /** |
||
| 1002 | * Build message object for a subtitle containing a backlink to a page |
||
| 1003 | * |
||
| 1004 | * @param Title $title Title to link to |
||
| 1005 | * @param array $query Array of additional parameters to include in the link |
||
| 1006 | * @return Message |
||
| 1007 | * @since 1.25 |
||
| 1008 | */ |
||
| 1009 | public static function buildBacklinkSubtitle( Title $title, $query = [] ) { |
||
| 1010 | if ( $title->isRedirect() ) { |
||
| 1011 | $query['redirect'] = 'no'; |
||
| 1012 | } |
||
| 1013 | return wfMessage( 'backlinksubtitle' ) |
||
| 1014 | ->rawParams( Linker::link( $title, null, [], $query ) ); |
||
| 1015 | } |
||
| 1016 | |||
| 1017 | /** |
||
| 1018 | * Add a subtitle containing a backlink to a page |
||
| 1019 | * |
||
| 1020 | * @param Title $title Title to link to |
||
| 1021 | * @param array $query Array of additional parameters to include in the link |
||
| 1022 | */ |
||
| 1023 | public function addBacklinkSubtitle( Title $title, $query = [] ) { |
||
| 1024 | $this->addSubtitle( self::buildBacklinkSubtitle( $title, $query ) ); |
||
| 1025 | } |
||
| 1026 | |||
| 1027 | /** |
||
| 1028 | * Clear the subtitles |
||
| 1029 | */ |
||
| 1030 | public function clearSubtitle() { |
||
| 1031 | $this->mSubtitle = []; |
||
| 1032 | } |
||
| 1033 | |||
| 1034 | /** |
||
| 1035 | * Get the subtitle |
||
| 1036 | * |
||
| 1037 | * @return string |
||
| 1038 | */ |
||
| 1039 | public function getSubtitle() { |
||
| 1040 | return implode( "<br />\n\t\t\t\t", $this->mSubtitle ); |
||
| 1041 | } |
||
| 1042 | |||
| 1043 | /** |
||
| 1044 | * Set the page as printable, i.e. it'll be displayed with all |
||
| 1045 | * print styles included |
||
| 1046 | */ |
||
| 1047 | public function setPrintable() { |
||
| 1048 | $this->mPrintable = true; |
||
| 1049 | } |
||
| 1050 | |||
| 1051 | /** |
||
| 1052 | * Return whether the page is "printable" |
||
| 1053 | * |
||
| 1054 | * @return bool |
||
| 1055 | */ |
||
| 1056 | public function isPrintable() { |
||
| 1057 | return $this->mPrintable; |
||
| 1058 | } |
||
| 1059 | |||
| 1060 | /** |
||
| 1061 | * Disable output completely, i.e. calling output() will have no effect |
||
| 1062 | */ |
||
| 1063 | public function disable() { |
||
| 1064 | $this->mDoNothing = true; |
||
| 1065 | } |
||
| 1066 | |||
| 1067 | /** |
||
| 1068 | * Return whether the output will be completely disabled |
||
| 1069 | * |
||
| 1070 | * @return bool |
||
| 1071 | */ |
||
| 1072 | public function isDisabled() { |
||
| 1073 | return $this->mDoNothing; |
||
| 1074 | } |
||
| 1075 | |||
| 1076 | /** |
||
| 1077 | * Show an "add new section" link? |
||
| 1078 | * |
||
| 1079 | * @return bool |
||
| 1080 | */ |
||
| 1081 | public function showNewSectionLink() { |
||
| 1082 | return $this->mNewSectionLink; |
||
| 1083 | } |
||
| 1084 | |||
| 1085 | /** |
||
| 1086 | * Forcibly hide the new section link? |
||
| 1087 | * |
||
| 1088 | * @return bool |
||
| 1089 | */ |
||
| 1090 | public function forceHideNewSectionLink() { |
||
| 1091 | return $this->mHideNewSectionLink; |
||
| 1092 | } |
||
| 1093 | |||
| 1094 | /** |
||
| 1095 | * Add or remove feed links in the page header |
||
| 1096 | * This is mainly kept for backward compatibility, see OutputPage::addFeedLink() |
||
| 1097 | * for the new version |
||
| 1098 | * @see addFeedLink() |
||
| 1099 | * |
||
| 1100 | * @param bool $show True: add default feeds, false: remove all feeds |
||
| 1101 | */ |
||
| 1102 | public function setSyndicated( $show = true ) { |
||
| 1103 | if ( $show ) { |
||
| 1104 | $this->setFeedAppendQuery( false ); |
||
| 1105 | } else { |
||
| 1106 | $this->mFeedLinks = []; |
||
| 1107 | } |
||
| 1108 | } |
||
| 1109 | |||
| 1110 | /** |
||
| 1111 | * Add default feeds to the page header |
||
| 1112 | * This is mainly kept for backward compatibility, see OutputPage::addFeedLink() |
||
| 1113 | * for the new version |
||
| 1114 | * @see addFeedLink() |
||
| 1115 | * |
||
| 1116 | * @param string $val Query to append to feed links or false to output |
||
| 1117 | * default links |
||
| 1118 | */ |
||
| 1119 | public function setFeedAppendQuery( $val ) { |
||
| 1120 | $this->mFeedLinks = []; |
||
| 1121 | |||
| 1122 | foreach ( $this->getConfig()->get( 'AdvertisedFeedTypes' ) as $type ) { |
||
| 1123 | $query = "feed=$type"; |
||
| 1124 | if ( is_string( $val ) ) { |
||
| 1125 | $query .= '&' . $val; |
||
| 1126 | } |
||
| 1127 | $this->mFeedLinks[$type] = $this->getTitle()->getLocalURL( $query ); |
||
| 1128 | } |
||
| 1129 | } |
||
| 1130 | |||
| 1131 | /** |
||
| 1132 | * Add a feed link to the page header |
||
| 1133 | * |
||
| 1134 | * @param string $format Feed type, should be a key of $wgFeedClasses |
||
| 1135 | * @param string $href URL |
||
| 1136 | */ |
||
| 1137 | public function addFeedLink( $format, $href ) { |
||
| 1138 | if ( in_array( $format, $this->getConfig()->get( 'AdvertisedFeedTypes' ) ) ) { |
||
| 1139 | $this->mFeedLinks[$format] = $href; |
||
| 1140 | } |
||
| 1141 | } |
||
| 1142 | |||
| 1143 | /** |
||
| 1144 | * Should we output feed links for this page? |
||
| 1145 | * @return bool |
||
| 1146 | */ |
||
| 1147 | public function isSyndicated() { |
||
| 1148 | return count( $this->mFeedLinks ) > 0; |
||
| 1149 | } |
||
| 1150 | |||
| 1151 | /** |
||
| 1152 | * Return URLs for each supported syndication format for this page. |
||
| 1153 | * @return array Associating format keys with URLs |
||
| 1154 | */ |
||
| 1155 | public function getSyndicationLinks() { |
||
| 1156 | return $this->mFeedLinks; |
||
| 1157 | } |
||
| 1158 | |||
| 1159 | /** |
||
| 1160 | * Will currently always return null |
||
| 1161 | * |
||
| 1162 | * @return null |
||
| 1163 | */ |
||
| 1164 | public function getFeedAppendQuery() { |
||
| 1165 | return $this->mFeedLinksAppendQuery; |
||
| 1166 | } |
||
| 1167 | |||
| 1168 | /** |
||
| 1169 | * Set whether the displayed content is related to the source of the |
||
| 1170 | * corresponding article on the wiki |
||
| 1171 | * Setting true will cause the change "article related" toggle to true |
||
| 1172 | * |
||
| 1173 | * @param bool $v |
||
| 1174 | */ |
||
| 1175 | public function setArticleFlag( $v ) { |
||
| 1176 | $this->mIsarticle = $v; |
||
| 1177 | if ( $v ) { |
||
| 1178 | $this->mIsArticleRelated = $v; |
||
| 1179 | } |
||
| 1180 | } |
||
| 1181 | |||
| 1182 | /** |
||
| 1183 | * Return whether the content displayed page is related to the source of |
||
| 1184 | * the corresponding article on the wiki |
||
| 1185 | * |
||
| 1186 | * @return bool |
||
| 1187 | */ |
||
| 1188 | public function isArticle() { |
||
| 1189 | return $this->mIsarticle; |
||
| 1190 | } |
||
| 1191 | |||
| 1192 | /** |
||
| 1193 | * Set whether this page is related an article on the wiki |
||
| 1194 | * Setting false will cause the change of "article flag" toggle to false |
||
| 1195 | * |
||
| 1196 | * @param bool $v |
||
| 1197 | */ |
||
| 1198 | public function setArticleRelated( $v ) { |
||
| 1199 | $this->mIsArticleRelated = $v; |
||
| 1200 | if ( !$v ) { |
||
| 1201 | $this->mIsarticle = false; |
||
| 1202 | } |
||
| 1203 | } |
||
| 1204 | |||
| 1205 | /** |
||
| 1206 | * Return whether this page is related an article on the wiki |
||
| 1207 | * |
||
| 1208 | * @return bool |
||
| 1209 | */ |
||
| 1210 | public function isArticleRelated() { |
||
| 1211 | return $this->mIsArticleRelated; |
||
| 1212 | } |
||
| 1213 | |||
| 1214 | /** |
||
| 1215 | * Add new language links |
||
| 1216 | * |
||
| 1217 | * @param array $newLinkArray Associative array mapping language code to the page |
||
| 1218 | * name |
||
| 1219 | */ |
||
| 1220 | public function addLanguageLinks( array $newLinkArray ) { |
||
| 1221 | $this->mLanguageLinks += $newLinkArray; |
||
| 1222 | } |
||
| 1223 | |||
| 1224 | /** |
||
| 1225 | * Reset the language links and add new language links |
||
| 1226 | * |
||
| 1227 | * @param array $newLinkArray Associative array mapping language code to the page |
||
| 1228 | * name |
||
| 1229 | */ |
||
| 1230 | public function setLanguageLinks( array $newLinkArray ) { |
||
| 1231 | $this->mLanguageLinks = $newLinkArray; |
||
| 1232 | } |
||
| 1233 | |||
| 1234 | /** |
||
| 1235 | * Get the list of language links |
||
| 1236 | * |
||
| 1237 | * @return array Array of Interwiki Prefixed (non DB key) Titles (e.g. 'fr:Test page') |
||
| 1238 | */ |
||
| 1239 | public function getLanguageLinks() { |
||
| 1240 | return $this->mLanguageLinks; |
||
| 1241 | } |
||
| 1242 | |||
| 1243 | /** |
||
| 1244 | * Add an array of categories, with names in the keys |
||
| 1245 | * |
||
| 1246 | * @param array $categories Mapping category name => sort key |
||
| 1247 | */ |
||
| 1248 | public function addCategoryLinks( array $categories ) { |
||
| 1249 | global $wgContLang; |
||
| 1250 | |||
| 1251 | if ( !is_array( $categories ) || count( $categories ) == 0 ) { |
||
| 1252 | return; |
||
| 1253 | } |
||
| 1254 | |||
| 1255 | # Add the links to a LinkBatch |
||
| 1256 | $arr = [ NS_CATEGORY => $categories ]; |
||
| 1257 | $lb = new LinkBatch; |
||
| 1258 | $lb->setArray( $arr ); |
||
| 1259 | |||
| 1260 | # Fetch existence plus the hiddencat property |
||
| 1261 | $dbr = wfGetDB( DB_REPLICA ); |
||
| 1262 | $fields = array_merge( |
||
| 1263 | LinkCache::getSelectFields(), |
||
| 1264 | [ 'page_namespace', 'page_title', 'pp_value' ] |
||
| 1265 | ); |
||
| 1266 | |||
| 1267 | $res = $dbr->select( [ 'page', 'page_props' ], |
||
| 1268 | $fields, |
||
| 1269 | $lb->constructSet( 'page', $dbr ), |
||
| 1270 | __METHOD__, |
||
| 1271 | [], |
||
| 1272 | [ 'page_props' => [ 'LEFT JOIN', [ |
||
| 1273 | 'pp_propname' => 'hiddencat', |
||
| 1274 | 'pp_page = page_id' |
||
| 1275 | ] ] ] |
||
| 1276 | ); |
||
| 1277 | |||
| 1278 | # Add the results to the link cache |
||
| 1279 | $lb->addResultToCache( LinkCache::singleton(), $res ); |
||
| 1280 | |||
| 1281 | # Set all the values to 'normal'. |
||
| 1282 | $categories = array_fill_keys( array_keys( $categories ), 'normal' ); |
||
| 1283 | |||
| 1284 | # Mark hidden categories |
||
| 1285 | foreach ( $res as $row ) { |
||
| 1286 | if ( isset( $row->pp_value ) ) { |
||
| 1287 | $categories[$row->page_title] = 'hidden'; |
||
| 1288 | } |
||
| 1289 | } |
||
| 1290 | |||
| 1291 | # Add the remaining categories to the skin |
||
| 1292 | if ( Hooks::run( |
||
| 1293 | 'OutputPageMakeCategoryLinks', |
||
| 1294 | [ &$this, $categories, &$this->mCategoryLinks ] ) |
||
| 1295 | ) { |
||
| 1296 | foreach ( $categories as $category => $type ) { |
||
| 1297 | // array keys will cast numeric category names to ints, so cast back to string |
||
| 1298 | $category = (string)$category; |
||
| 1299 | $origcategory = $category; |
||
| 1300 | $title = Title::makeTitleSafe( NS_CATEGORY, $category ); |
||
| 1301 | if ( !$title ) { |
||
| 1302 | continue; |
||
| 1303 | } |
||
| 1304 | $wgContLang->findVariantLink( $category, $title, true ); |
||
| 1305 | if ( $category != $origcategory && array_key_exists( $category, $categories ) ) { |
||
| 1306 | continue; |
||
| 1307 | } |
||
| 1308 | $text = $wgContLang->convertHtml( $title->getText() ); |
||
| 1309 | $this->mCategories[] = $title->getText(); |
||
| 1310 | $this->mCategoryLinks[$type][] = Linker::link( $title, $text ); |
||
| 1311 | } |
||
| 1312 | } |
||
| 1313 | } |
||
| 1314 | |||
| 1315 | /** |
||
| 1316 | * Reset the category links (but not the category list) and add $categories |
||
| 1317 | * |
||
| 1318 | * @param array $categories Mapping category name => sort key |
||
| 1319 | */ |
||
| 1320 | public function setCategoryLinks( array $categories ) { |
||
| 1321 | $this->mCategoryLinks = []; |
||
| 1322 | $this->addCategoryLinks( $categories ); |
||
| 1323 | } |
||
| 1324 | |||
| 1325 | /** |
||
| 1326 | * Get the list of category links, in a 2-D array with the following format: |
||
| 1327 | * $arr[$type][] = $link, where $type is either "normal" or "hidden" (for |
||
| 1328 | * hidden categories) and $link a HTML fragment with a link to the category |
||
| 1329 | * page |
||
| 1330 | * |
||
| 1331 | * @return array |
||
| 1332 | */ |
||
| 1333 | public function getCategoryLinks() { |
||
| 1334 | return $this->mCategoryLinks; |
||
| 1335 | } |
||
| 1336 | |||
| 1337 | /** |
||
| 1338 | * Get the list of category names this page belongs to |
||
| 1339 | * |
||
| 1340 | * @return array Array of strings |
||
| 1341 | */ |
||
| 1342 | public function getCategories() { |
||
| 1343 | return $this->mCategories; |
||
| 1344 | } |
||
| 1345 | |||
| 1346 | /** |
||
| 1347 | * Add an array of indicators, with their identifiers as array |
||
| 1348 | * keys and HTML contents as values. |
||
| 1349 | * |
||
| 1350 | * In case of duplicate keys, existing values are overwritten. |
||
| 1351 | * |
||
| 1352 | * @param array $indicators |
||
| 1353 | * @since 1.25 |
||
| 1354 | */ |
||
| 1355 | public function setIndicators( array $indicators ) { |
||
| 1356 | $this->mIndicators = $indicators + $this->mIndicators; |
||
| 1357 | // Keep ordered by key |
||
| 1358 | ksort( $this->mIndicators ); |
||
| 1359 | } |
||
| 1360 | |||
| 1361 | /** |
||
| 1362 | * Get the indicators associated with this page. |
||
| 1363 | * |
||
| 1364 | * The array will be internally ordered by item keys. |
||
| 1365 | * |
||
| 1366 | * @return array Keys: identifiers, values: HTML contents |
||
| 1367 | * @since 1.25 |
||
| 1368 | */ |
||
| 1369 | public function getIndicators() { |
||
| 1370 | return $this->mIndicators; |
||
| 1371 | } |
||
| 1372 | |||
| 1373 | /** |
||
| 1374 | * Adds help link with an icon via page indicators. |
||
| 1375 | * Link target can be overridden by a local message containing a wikilink: |
||
| 1376 | * the message key is: lowercase action or special page name + '-helppage'. |
||
| 1377 | * @param string $to Target MediaWiki.org page title or encoded URL. |
||
| 1378 | * @param bool $overrideBaseUrl Whether $url is a full URL, to avoid MW.o. |
||
| 1379 | * @since 1.25 |
||
| 1380 | */ |
||
| 1381 | public function addHelpLink( $to, $overrideBaseUrl = false ) { |
||
| 1382 | $this->addModuleStyles( 'mediawiki.helplink' ); |
||
| 1383 | $text = $this->msg( 'helppage-top-gethelp' )->escaped(); |
||
| 1384 | |||
| 1385 | if ( $overrideBaseUrl ) { |
||
| 1386 | $helpUrl = $to; |
||
| 1387 | } else { |
||
| 1388 | $toUrlencoded = wfUrlencode( str_replace( ' ', '_', $to ) ); |
||
| 1389 | $helpUrl = "//www.mediawiki.org/wiki/Special:MyLanguage/$toUrlencoded"; |
||
| 1390 | } |
||
| 1391 | |||
| 1392 | $link = Html::rawElement( |
||
| 1393 | 'a', |
||
| 1394 | [ |
||
| 1395 | 'href' => $helpUrl, |
||
| 1396 | 'target' => '_blank', |
||
| 1397 | 'class' => 'mw-helplink', |
||
| 1398 | ], |
||
| 1399 | $text |
||
| 1400 | ); |
||
| 1401 | |||
| 1402 | $this->setIndicators( [ 'mw-helplink' => $link ] ); |
||
| 1403 | } |
||
| 1404 | |||
| 1405 | /** |
||
| 1406 | * Do not allow scripts which can be modified by wiki users to load on this page; |
||
| 1407 | * only allow scripts bundled with, or generated by, the software. |
||
| 1408 | * Site-wide styles are controlled by a config setting, since they can be |
||
| 1409 | * used to create a custom skin/theme, but not user-specific ones. |
||
| 1410 | * |
||
| 1411 | * @todo this should be given a more accurate name |
||
| 1412 | */ |
||
| 1413 | public function disallowUserJs() { |
||
| 1414 | $this->reduceAllowedModules( |
||
| 1415 | ResourceLoaderModule::TYPE_SCRIPTS, |
||
| 1416 | ResourceLoaderModule::ORIGIN_CORE_INDIVIDUAL |
||
| 1417 | ); |
||
| 1418 | |||
| 1419 | // Site-wide styles are controlled by a config setting, see bug 71621 |
||
| 1420 | // for background on why. User styles are never allowed. |
||
| 1421 | if ( $this->getConfig()->get( 'AllowSiteCSSOnRestrictedPages' ) ) { |
||
| 1422 | $styleOrigin = ResourceLoaderModule::ORIGIN_USER_SITEWIDE; |
||
| 1423 | } else { |
||
| 1424 | $styleOrigin = ResourceLoaderModule::ORIGIN_CORE_INDIVIDUAL; |
||
| 1425 | } |
||
| 1426 | $this->reduceAllowedModules( |
||
| 1427 | ResourceLoaderModule::TYPE_STYLES, |
||
| 1428 | $styleOrigin |
||
| 1429 | ); |
||
| 1430 | } |
||
| 1431 | |||
| 1432 | /** |
||
| 1433 | * Show what level of JavaScript / CSS untrustworthiness is allowed on this page |
||
| 1434 | * @see ResourceLoaderModule::$origin |
||
| 1435 | * @param string $type ResourceLoaderModule TYPE_ constant |
||
| 1436 | * @return int ResourceLoaderModule ORIGIN_ class constant |
||
| 1437 | */ |
||
| 1438 | public function getAllowedModules( $type ) { |
||
| 1439 | if ( $type == ResourceLoaderModule::TYPE_COMBINED ) { |
||
| 1440 | return min( array_values( $this->mAllowedModules ) ); |
||
| 1441 | } else { |
||
| 1442 | return isset( $this->mAllowedModules[$type] ) |
||
| 1443 | ? $this->mAllowedModules[$type] |
||
| 1444 | : ResourceLoaderModule::ORIGIN_ALL; |
||
| 1445 | } |
||
| 1446 | } |
||
| 1447 | |||
| 1448 | /** |
||
| 1449 | * Limit the highest level of CSS/JS untrustworthiness allowed. |
||
| 1450 | * |
||
| 1451 | * If passed the same or a higher level than the current level of untrustworthiness set, the |
||
| 1452 | * level will remain unchanged. |
||
| 1453 | * |
||
| 1454 | * @param string $type |
||
| 1455 | * @param int $level ResourceLoaderModule class constant |
||
| 1456 | */ |
||
| 1457 | public function reduceAllowedModules( $type, $level ) { |
||
| 1458 | $this->mAllowedModules[$type] = min( $this->getAllowedModules( $type ), $level ); |
||
| 1459 | } |
||
| 1460 | |||
| 1461 | /** |
||
| 1462 | * Prepend $text to the body HTML |
||
| 1463 | * |
||
| 1464 | * @param string $text HTML |
||
| 1465 | */ |
||
| 1466 | public function prependHTML( $text ) { |
||
| 1467 | $this->mBodytext = $text . $this->mBodytext; |
||
| 1468 | } |
||
| 1469 | |||
| 1470 | /** |
||
| 1471 | * Append $text to the body HTML |
||
| 1472 | * |
||
| 1473 | * @param string $text HTML |
||
| 1474 | */ |
||
| 1475 | public function addHTML( $text ) { |
||
| 1476 | $this->mBodytext .= $text; |
||
| 1477 | } |
||
| 1478 | |||
| 1479 | /** |
||
| 1480 | * Shortcut for adding an Html::element via addHTML. |
||
| 1481 | * |
||
| 1482 | * @since 1.19 |
||
| 1483 | * |
||
| 1484 | * @param string $element |
||
| 1485 | * @param array $attribs |
||
| 1486 | * @param string $contents |
||
| 1487 | */ |
||
| 1488 | public function addElement( $element, array $attribs = [], $contents = '' ) { |
||
| 1489 | $this->addHTML( Html::element( $element, $attribs, $contents ) ); |
||
| 1490 | } |
||
| 1491 | |||
| 1492 | /** |
||
| 1493 | * Clear the body HTML |
||
| 1494 | */ |
||
| 1495 | public function clearHTML() { |
||
| 1496 | $this->mBodytext = ''; |
||
| 1497 | } |
||
| 1498 | |||
| 1499 | /** |
||
| 1500 | * Get the body HTML |
||
| 1501 | * |
||
| 1502 | * @return string HTML |
||
| 1503 | */ |
||
| 1504 | public function getHTML() { |
||
| 1505 | return $this->mBodytext; |
||
| 1506 | } |
||
| 1507 | |||
| 1508 | /** |
||
| 1509 | * Get/set the ParserOptions object to use for wikitext parsing |
||
| 1510 | * |
||
| 1511 | * @param ParserOptions|null $options Either the ParserOption to use or null to only get the |
||
| 1512 | * current ParserOption object |
||
| 1513 | * @return ParserOptions |
||
| 1514 | */ |
||
| 1515 | public function parserOptions( $options = null ) { |
||
| 1516 | if ( $options !== null && !empty( $options->isBogus ) ) { |
||
| 1517 | // Someone is trying to set a bogus pre-$wgUser PO. Check if it has |
||
| 1518 | // been changed somehow, and keep it if so. |
||
| 1519 | $anonPO = ParserOptions::newFromAnon(); |
||
| 1520 | $anonPO->setEditSection( false ); |
||
| 1521 | if ( !$options->matches( $anonPO ) ) { |
||
| 1522 | wfLogWarning( __METHOD__ . ': Setting a changed bogus ParserOptions: ' . wfGetAllCallers( 5 ) ); |
||
| 1523 | $options->isBogus = false; |
||
| 1524 | } |
||
| 1525 | } |
||
| 1526 | |||
| 1527 | if ( !$this->mParserOptions ) { |
||
| 1528 | if ( !$this->getContext()->getUser()->isSafeToLoad() ) { |
||
| 1529 | // $wgUser isn't unstubbable yet, so don't try to get a |
||
| 1530 | // ParserOptions for it. And don't cache this ParserOptions |
||
| 1531 | // either. |
||
| 1532 | $po = ParserOptions::newFromAnon(); |
||
| 1533 | $po->setEditSection( false ); |
||
| 1534 | $po->isBogus = true; |
||
| 1535 | if ( $options !== null ) { |
||
| 1536 | $this->mParserOptions = empty( $options->isBogus ) ? $options : null; |
||
| 1537 | } |
||
| 1538 | return $po; |
||
| 1539 | } |
||
| 1540 | |||
| 1541 | $this->mParserOptions = ParserOptions::newFromContext( $this->getContext() ); |
||
| 1542 | $this->mParserOptions->setEditSection( false ); |
||
| 1543 | } |
||
| 1544 | |||
| 1545 | if ( $options !== null && !empty( $options->isBogus ) ) { |
||
| 1546 | // They're trying to restore the bogus pre-$wgUser PO. Do the right |
||
| 1547 | // thing. |
||
| 1548 | return wfSetVar( $this->mParserOptions, null, true ); |
||
| 1549 | } else { |
||
| 1550 | return wfSetVar( $this->mParserOptions, $options ); |
||
| 1551 | } |
||
| 1552 | } |
||
| 1553 | |||
| 1554 | /** |
||
| 1555 | * Set the revision ID which will be seen by the wiki text parser |
||
| 1556 | * for things such as embedded {{REVISIONID}} variable use. |
||
| 1557 | * |
||
| 1558 | * @param int|null $revid An positive integer, or null |
||
| 1559 | * @return mixed Previous value |
||
| 1560 | */ |
||
| 1561 | public function setRevisionId( $revid ) { |
||
| 1562 | $val = is_null( $revid ) ? null : intval( $revid ); |
||
| 1563 | return wfSetVar( $this->mRevisionId, $val ); |
||
| 1564 | } |
||
| 1565 | |||
| 1566 | /** |
||
| 1567 | * Get the displayed revision ID |
||
| 1568 | * |
||
| 1569 | * @return int |
||
| 1570 | */ |
||
| 1571 | public function getRevisionId() { |
||
| 1572 | return $this->mRevisionId; |
||
| 1573 | } |
||
| 1574 | |||
| 1575 | /** |
||
| 1576 | * Set the timestamp of the revision which will be displayed. This is used |
||
| 1577 | * to avoid a extra DB call in Skin::lastModified(). |
||
| 1578 | * |
||
| 1579 | * @param string|null $timestamp |
||
| 1580 | * @return mixed Previous value |
||
| 1581 | */ |
||
| 1582 | public function setRevisionTimestamp( $timestamp ) { |
||
| 1583 | return wfSetVar( $this->mRevisionTimestamp, $timestamp ); |
||
| 1584 | } |
||
| 1585 | |||
| 1586 | /** |
||
| 1587 | * Get the timestamp of displayed revision. |
||
| 1588 | * This will be null if not filled by setRevisionTimestamp(). |
||
| 1589 | * |
||
| 1590 | * @return string|null |
||
| 1591 | */ |
||
| 1592 | public function getRevisionTimestamp() { |
||
| 1593 | return $this->mRevisionTimestamp; |
||
| 1594 | } |
||
| 1595 | |||
| 1596 | /** |
||
| 1597 | * Set the displayed file version |
||
| 1598 | * |
||
| 1599 | * @param File|bool $file |
||
| 1600 | * @return mixed Previous value |
||
| 1601 | */ |
||
| 1602 | public function setFileVersion( $file ) { |
||
| 1603 | $val = null; |
||
| 1604 | if ( $file instanceof File && $file->exists() ) { |
||
| 1605 | $val = [ 'time' => $file->getTimestamp(), 'sha1' => $file->getSha1() ]; |
||
| 1606 | } |
||
| 1607 | return wfSetVar( $this->mFileVersion, $val, true ); |
||
| 1608 | } |
||
| 1609 | |||
| 1610 | /** |
||
| 1611 | * Get the displayed file version |
||
| 1612 | * |
||
| 1613 | * @return array|null ('time' => MW timestamp, 'sha1' => sha1) |
||
| 1614 | */ |
||
| 1615 | public function getFileVersion() { |
||
| 1616 | return $this->mFileVersion; |
||
| 1617 | } |
||
| 1618 | |||
| 1619 | /** |
||
| 1620 | * Get the templates used on this page |
||
| 1621 | * |
||
| 1622 | * @return array (namespace => dbKey => revId) |
||
| 1623 | * @since 1.18 |
||
| 1624 | */ |
||
| 1625 | public function getTemplateIds() { |
||
| 1626 | return $this->mTemplateIds; |
||
| 1627 | } |
||
| 1628 | |||
| 1629 | /** |
||
| 1630 | * Get the files used on this page |
||
| 1631 | * |
||
| 1632 | * @return array (dbKey => array('time' => MW timestamp or null, 'sha1' => sha1 or '')) |
||
| 1633 | * @since 1.18 |
||
| 1634 | */ |
||
| 1635 | public function getFileSearchOptions() { |
||
| 1636 | return $this->mImageTimeKeys; |
||
| 1637 | } |
||
| 1638 | |||
| 1639 | /** |
||
| 1640 | * Convert wikitext to HTML and add it to the buffer |
||
| 1641 | * Default assumes that the current page title will be used. |
||
| 1642 | * |
||
| 1643 | * @param string $text |
||
| 1644 | * @param bool $linestart Is this the start of a line? |
||
| 1645 | * @param bool $interface Is this text in the user interface language? |
||
| 1646 | * @throws MWException |
||
| 1647 | */ |
||
| 1648 | public function addWikiText( $text, $linestart = true, $interface = true ) { |
||
| 1649 | $title = $this->getTitle(); // Work around E_STRICT |
||
| 1650 | if ( !$title ) { |
||
| 1651 | throw new MWException( 'Title is null' ); |
||
| 1652 | } |
||
| 1653 | $this->addWikiTextTitle( $text, $title, $linestart, /*tidy*/false, $interface ); |
||
| 1654 | } |
||
| 1655 | |||
| 1656 | /** |
||
| 1657 | * Add wikitext with a custom Title object |
||
| 1658 | * |
||
| 1659 | * @param string $text Wikitext |
||
| 1660 | * @param Title $title |
||
| 1661 | * @param bool $linestart Is this the start of a line? |
||
| 1662 | */ |
||
| 1663 | public function addWikiTextWithTitle( $text, &$title, $linestart = true ) { |
||
| 1664 | $this->addWikiTextTitle( $text, $title, $linestart ); |
||
| 1665 | } |
||
| 1666 | |||
| 1667 | /** |
||
| 1668 | * Add wikitext with a custom Title object and tidy enabled. |
||
| 1669 | * |
||
| 1670 | * @param string $text Wikitext |
||
| 1671 | * @param Title $title |
||
| 1672 | * @param bool $linestart Is this the start of a line? |
||
| 1673 | */ |
||
| 1674 | function addWikiTextTitleTidy( $text, &$title, $linestart = true ) { |
||
| 1675 | $this->addWikiTextTitle( $text, $title, $linestart, true ); |
||
| 1676 | } |
||
| 1677 | |||
| 1678 | /** |
||
| 1679 | * Add wikitext with tidy enabled |
||
| 1680 | * |
||
| 1681 | * @param string $text Wikitext |
||
| 1682 | * @param bool $linestart Is this the start of a line? |
||
| 1683 | */ |
||
| 1684 | public function addWikiTextTidy( $text, $linestart = true ) { |
||
| 1685 | $title = $this->getTitle(); |
||
| 1686 | $this->addWikiTextTitleTidy( $text, $title, $linestart ); |
||
| 1687 | } |
||
| 1688 | |||
| 1689 | /** |
||
| 1690 | * Add wikitext with a custom Title object |
||
| 1691 | * |
||
| 1692 | * @param string $text Wikitext |
||
| 1693 | * @param Title $title |
||
| 1694 | * @param bool $linestart Is this the start of a line? |
||
| 1695 | * @param bool $tidy Whether to use tidy |
||
| 1696 | * @param bool $interface Whether it is an interface message |
||
| 1697 | * (for example disables conversion) |
||
| 1698 | */ |
||
| 1699 | public function addWikiTextTitle( $text, Title $title, $linestart, |
||
| 1700 | $tidy = false, $interface = false |
||
| 1701 | ) { |
||
| 1702 | global $wgParser; |
||
| 1703 | |||
| 1704 | $popts = $this->parserOptions(); |
||
| 1705 | $oldTidy = $popts->setTidy( $tidy ); |
||
| 1706 | $popts->setInterfaceMessage( (bool)$interface ); |
||
| 1707 | |||
| 1708 | $parserOutput = $wgParser->getFreshParser()->parse( |
||
| 1709 | $text, $title, $popts, |
||
| 1710 | $linestart, true, $this->mRevisionId |
||
| 1711 | ); |
||
| 1712 | |||
| 1713 | $popts->setTidy( $oldTidy ); |
||
| 1714 | |||
| 1715 | $this->addParserOutput( $parserOutput ); |
||
| 1716 | |||
| 1717 | } |
||
| 1718 | |||
| 1719 | /** |
||
| 1720 | * Add a ParserOutput object, but without Html. |
||
| 1721 | * |
||
| 1722 | * @deprecated since 1.24, use addParserOutputMetadata() instead. |
||
| 1723 | * @param ParserOutput $parserOutput |
||
| 1724 | */ |
||
| 1725 | public function addParserOutputNoText( $parserOutput ) { |
||
| 1726 | wfDeprecated( __METHOD__, '1.24' ); |
||
| 1727 | $this->addParserOutputMetadata( $parserOutput ); |
||
| 1728 | } |
||
| 1729 | |||
| 1730 | /** |
||
| 1731 | * Add all metadata associated with a ParserOutput object, but without the actual HTML. This |
||
| 1732 | * includes categories, language links, ResourceLoader modules, effects of certain magic words, |
||
| 1733 | * and so on. |
||
| 1734 | * |
||
| 1735 | * @since 1.24 |
||
| 1736 | * @param ParserOutput $parserOutput |
||
| 1737 | */ |
||
| 1738 | public function addParserOutputMetadata( $parserOutput ) { |
||
| 1739 | $this->mLanguageLinks += $parserOutput->getLanguageLinks(); |
||
| 1740 | $this->addCategoryLinks( $parserOutput->getCategories() ); |
||
| 1741 | $this->setIndicators( $parserOutput->getIndicators() ); |
||
| 1742 | $this->mNewSectionLink = $parserOutput->getNewSection(); |
||
| 1743 | $this->mHideNewSectionLink = $parserOutput->getHideNewSection(); |
||
| 1744 | |||
| 1745 | if ( !$parserOutput->isCacheable() ) { |
||
| 1746 | $this->enableClientCache( false ); |
||
| 1747 | } |
||
| 1748 | $this->mNoGallery = $parserOutput->getNoGallery(); |
||
| 1749 | $this->mHeadItems = array_merge( $this->mHeadItems, $parserOutput->getHeadItems() ); |
||
| 1750 | $this->addModules( $parserOutput->getModules() ); |
||
| 1751 | $this->addModuleScripts( $parserOutput->getModuleScripts() ); |
||
| 1752 | $this->addModuleStyles( $parserOutput->getModuleStyles() ); |
||
| 1753 | $this->addJsConfigVars( $parserOutput->getJsConfigVars() ); |
||
| 1754 | $this->mPreventClickjacking = $this->mPreventClickjacking |
||
| 1755 | || $parserOutput->preventClickjacking(); |
||
| 1756 | |||
| 1757 | // Template versioning... |
||
| 1758 | foreach ( (array)$parserOutput->getTemplateIds() as $ns => $dbks ) { |
||
| 1759 | if ( isset( $this->mTemplateIds[$ns] ) ) { |
||
| 1760 | $this->mTemplateIds[$ns] = $dbks + $this->mTemplateIds[$ns]; |
||
| 1761 | } else { |
||
| 1762 | $this->mTemplateIds[$ns] = $dbks; |
||
| 1763 | } |
||
| 1764 | } |
||
| 1765 | // File versioning... |
||
| 1766 | foreach ( (array)$parserOutput->getFileSearchOptions() as $dbk => $data ) { |
||
| 1767 | $this->mImageTimeKeys[$dbk] = $data; |
||
| 1768 | } |
||
| 1769 | |||
| 1770 | // Hooks registered in the object |
||
| 1771 | $parserOutputHooks = $this->getConfig()->get( 'ParserOutputHooks' ); |
||
| 1772 | foreach ( $parserOutput->getOutputHooks() as $hookInfo ) { |
||
| 1773 | list( $hookName, $data ) = $hookInfo; |
||
| 1774 | if ( isset( $parserOutputHooks[$hookName] ) ) { |
||
| 1775 | call_user_func( $parserOutputHooks[$hookName], $this, $parserOutput, $data ); |
||
| 1776 | } |
||
| 1777 | } |
||
| 1778 | |||
| 1779 | // Enable OOUI if requested via ParserOutput |
||
| 1780 | if ( $parserOutput->getEnableOOUI() ) { |
||
| 1781 | $this->enableOOUI(); |
||
| 1782 | } |
||
| 1783 | |||
| 1784 | // Include profiling data |
||
| 1785 | if ( !$this->limitReportData ) { |
||
| 1786 | $this->setLimitReportData( $parserOutput->getLimitReportData() ); |
||
| 1787 | } |
||
| 1788 | |||
| 1789 | // Link flags are ignored for now, but may in the future be |
||
| 1790 | // used to mark individual language links. |
||
| 1791 | $linkFlags = []; |
||
| 1792 | Hooks::run( 'LanguageLinks', [ $this->getTitle(), &$this->mLanguageLinks, &$linkFlags ] ); |
||
| 1793 | Hooks::run( 'OutputPageParserOutput', [ &$this, $parserOutput ] ); |
||
| 1794 | } |
||
| 1795 | |||
| 1796 | /** |
||
| 1797 | * Add the HTML and enhancements for it (like ResourceLoader modules) associated with a |
||
| 1798 | * ParserOutput object, without any other metadata. |
||
| 1799 | * |
||
| 1800 | * @since 1.24 |
||
| 1801 | * @param ParserOutput $parserOutput |
||
| 1802 | */ |
||
| 1803 | public function addParserOutputContent( $parserOutput ) { |
||
| 1812 | |||
| 1813 | /** |
||
| 1814 | * Add the HTML associated with a ParserOutput object, without any metadata. |
||
| 1815 | * |
||
| 1816 | * @since 1.24 |
||
| 1817 | * @param ParserOutput $parserOutput |
||
| 1818 | */ |
||
| 1819 | public function addParserOutputText( $parserOutput ) { |
||
| 1824 | |||
| 1825 | /** |
||
| 1826 | * Add everything from a ParserOutput object. |
||
| 1827 | * |
||
| 1828 | * @param ParserOutput $parserOutput |
||
| 1829 | */ |
||
| 1830 | function addParserOutput( $parserOutput ) { |
||
| 1841 | |||
| 1842 | /** |
||
| 1843 | * Add the output of a QuickTemplate to the output buffer |
||
| 1844 | * |
||
| 1845 | * @param QuickTemplate $template |
||
| 1846 | */ |
||
| 1847 | public function addTemplate( &$template ) { |
||
| 1850 | |||
| 1851 | /** |
||
| 1852 | * Parse wikitext and return the HTML. |
||
| 1853 | * |
||
| 1854 | * @param string $text |
||
| 1855 | * @param bool $linestart Is this the start of a line? |
||
| 1856 | * @param bool $interface Use interface language ($wgLang instead of |
||
| 1857 | * $wgContLang) while parsing language sensitive magic words like GRAMMAR and PLURAL. |
||
| 1858 | * This also disables LanguageConverter. |
||
| 1859 | * @param Language $language Target language object, will override $interface |
||
| 1860 | * @throws MWException |
||
| 1861 | * @return string HTML |
||
| 1862 | */ |
||
| 1863 | public function parse( $text, $linestart = true, $interface = false, $language = null ) { |
||
| 1892 | |||
| 1893 | /** |
||
| 1894 | * Parse wikitext, strip paragraphs, and return the HTML. |
||
| 1895 | * |
||
| 1896 | * @param string $text |
||
| 1897 | * @param bool $linestart Is this the start of a line? |
||
| 1898 | * @param bool $interface Use interface language ($wgLang instead of |
||
| 1899 | * $wgContLang) while parsing language sensitive magic |
||
| 1900 | * words like GRAMMAR and PLURAL |
||
| 1901 | * @return string HTML |
||
| 1902 | */ |
||
| 1903 | public function parseInline( $text, $linestart = true, $interface = false ) { |
||
| 1907 | |||
| 1908 | /** |
||
| 1909 | * @param $maxage |
||
| 1910 | * @deprecated since 1.27 Use setCdnMaxage() instead |
||
| 1911 | */ |
||
| 1912 | public function setSquidMaxage( $maxage ) { |
||
| 1915 | |||
| 1916 | /** |
||
| 1917 | * Set the value of the "s-maxage" part of the "Cache-control" HTTP header |
||
| 1918 | * |
||
| 1919 | * @param int $maxage Maximum cache time on the CDN, in seconds. |
||
| 1920 | */ |
||
| 1921 | public function setCdnMaxage( $maxage ) { |
||
| 1924 | |||
| 1925 | /** |
||
| 1926 | * Lower the value of the "s-maxage" part of the "Cache-control" HTTP header |
||
| 1927 | * |
||
| 1928 | * @param int $maxage Maximum cache time on the CDN, in seconds |
||
| 1929 | * @since 1.27 |
||
| 1930 | */ |
||
| 1931 | public function lowerCdnMaxage( $maxage ) { |
||
| 1935 | |||
| 1936 | /** |
||
| 1937 | * Get TTL in [$minTTL,$maxTTL] in pass it to lowerCdnMaxage() |
||
| 1938 | * |
||
| 1939 | * This sets and returns $minTTL if $mtime is false or null. Otherwise, |
||
| 1940 | * the TTL is higher the older the $mtime timestamp is. Essentially, the |
||
| 1941 | * TTL is 90% of the age of the object, subject to the min and max. |
||
| 1942 | * |
||
| 1943 | * @param string|integer|float|bool|null $mtime Last-Modified timestamp |
||
| 1944 | * @param integer $minTTL Mimimum TTL in seconds [default: 1 minute] |
||
| 1945 | * @param integer $maxTTL Maximum TTL in seconds [default: $wgSquidMaxage] |
||
| 1946 | * @return integer TTL in seconds |
||
| 1947 | * @since 1.28 |
||
| 1948 | */ |
||
| 1949 | public function adaptCdnTTL( $mtime, $minTTL = 0, $maxTTL = 0 ) { |
||
| 1950 | $minTTL = $minTTL ?: IExpiringStore::TTL_MINUTE; |
||
| 1951 | $maxTTL = $maxTTL ?: $this->getConfig()->get( 'SquidMaxage' ); |
||
| 1952 | |||
| 1953 | if ( $mtime === null || $mtime === false ) { |
||
| 1954 | return $minTTL; // entity does not exist |
||
| 1955 | } |
||
| 1956 | |||
| 1957 | $age = time() - wfTimestamp( TS_UNIX, $mtime ); |
||
| 1958 | $adaptiveTTL = max( .9 * $age, $minTTL ); |
||
| 1959 | $adaptiveTTL = min( $adaptiveTTL, $maxTTL ); |
||
| 1960 | |||
| 1961 | $this->lowerCdnMaxage( (int)$adaptiveTTL ); |
||
| 1962 | |||
| 1963 | return $adaptiveTTL; |
||
| 1964 | } |
||
| 1965 | |||
| 1966 | /** |
||
| 1967 | * Use enableClientCache(false) to force it to send nocache headers |
||
| 1968 | * |
||
| 1969 | * @param bool $state |
||
| 1970 | * |
||
| 1971 | * @return bool |
||
| 1972 | */ |
||
| 1973 | public function enableClientCache( $state ) { |
||
| 1974 | return wfSetVar( $this->mEnableClientCache, $state ); |
||
| 1975 | } |
||
| 1976 | |||
| 1977 | /** |
||
| 1978 | * Get the list of cookies that will influence on the cache |
||
| 1979 | * |
||
| 1980 | * @return array |
||
| 1981 | */ |
||
| 1982 | function getCacheVaryCookies() { |
||
| 1983 | static $cookies; |
||
| 1984 | if ( $cookies === null ) { |
||
| 1985 | $config = $this->getConfig(); |
||
| 1986 | $cookies = array_merge( |
||
| 1987 | SessionManager::singleton()->getVaryCookies(), |
||
| 1988 | [ |
||
| 1989 | 'forceHTTPS', |
||
| 1990 | ], |
||
| 1991 | $config->get( 'CacheVaryCookies' ) |
||
| 1992 | ); |
||
| 1993 | Hooks::run( 'GetCacheVaryCookies', [ $this, &$cookies ] ); |
||
| 1994 | } |
||
| 1995 | return $cookies; |
||
| 1996 | } |
||
| 1997 | |||
| 1998 | /** |
||
| 1999 | * Check if the request has a cache-varying cookie header |
||
| 2000 | * If it does, it's very important that we don't allow public caching |
||
| 2001 | * |
||
| 2002 | * @return bool |
||
| 2003 | */ |
||
| 2004 | function haveCacheVaryCookies() { |
||
| 2005 | $request = $this->getRequest(); |
||
| 2006 | foreach ( $this->getCacheVaryCookies() as $cookieName ) { |
||
| 2007 | if ( $request->getCookie( $cookieName, '', '' ) !== '' ) { |
||
| 2008 | wfDebug( __METHOD__ . ": found $cookieName\n" ); |
||
| 2009 | return true; |
||
| 2010 | } |
||
| 2011 | } |
||
| 2012 | wfDebug( __METHOD__ . ": no cache-varying cookies found\n" ); |
||
| 2013 | return false; |
||
| 2014 | } |
||
| 2015 | |||
| 2016 | /** |
||
| 2017 | * Add an HTTP header that will influence on the cache |
||
| 2018 | * |
||
| 2019 | * @param string $header Header name |
||
| 2020 | * @param string[]|null $option Options for the Key header. See |
||
| 2021 | * https://datatracker.ietf.org/doc/draft-fielding-http-key/ |
||
| 2022 | * for the list of valid options. |
||
| 2023 | */ |
||
| 2024 | public function addVaryHeader( $header, array $option = null ) { |
||
| 2025 | if ( !array_key_exists( $header, $this->mVaryHeader ) ) { |
||
| 2026 | $this->mVaryHeader[$header] = []; |
||
| 2027 | } |
||
| 2028 | if ( !is_array( $option ) ) { |
||
| 2029 | $option = []; |
||
| 2030 | } |
||
| 2031 | $this->mVaryHeader[$header] = array_unique( array_merge( $this->mVaryHeader[$header], $option ) ); |
||
| 2032 | } |
||
| 2033 | |||
| 2034 | /** |
||
| 2035 | * Return a Vary: header on which to vary caches. Based on the keys of $mVaryHeader, |
||
| 2036 | * such as Accept-Encoding or Cookie |
||
| 2037 | * |
||
| 2038 | * @return string |
||
| 2039 | */ |
||
| 2040 | public function getVaryHeader() { |
||
| 2041 | // If we vary on cookies, let's make sure it's always included here too. |
||
| 2042 | if ( $this->getCacheVaryCookies() ) { |
||
| 2043 | $this->addVaryHeader( 'Cookie' ); |
||
| 2044 | } |
||
| 2045 | |||
| 2051 | |||
| 2052 | /** |
||
| 2053 | * Get a complete Key header |
||
| 2054 | * |
||
| 2055 | * @return string |
||
| 2056 | */ |
||
| 2057 | public function getKeyHeader() { |
||
| 2082 | |||
| 2083 | /** |
||
| 2084 | * T23672: Add Accept-Language to Vary and Key headers |
||
| 2085 | * if there's no 'variant' parameter existed in GET. |
||
| 2086 | * |
||
| 2087 | * For example: |
||
| 2088 | * /w/index.php?title=Main_page should always be served; but |
||
| 2089 | * /w/index.php?title=Main_page&variant=zh-cn should never be served. |
||
| 2090 | */ |
||
| 2091 | function addAcceptLanguage() { |
||
| 2119 | |||
| 2120 | /** |
||
| 2121 | * Set a flag which will cause an X-Frame-Options header appropriate for |
||
| 2122 | * edit pages to be sent. The header value is controlled by |
||
| 2123 | * $wgEditPageFrameOptions. |
||
| 2124 | * |
||
| 2125 | * This is the default for special pages. If you display a CSRF-protected |
||
| 2126 | * form on an ordinary view page, then you need to call this function. |
||
| 2127 | * |
||
| 2128 | * @param bool $enable |
||
| 2129 | */ |
||
| 2130 | public function preventClickjacking( $enable = true ) { |
||
| 2133 | |||
| 2134 | /** |
||
| 2135 | * Turn off frame-breaking. Alias for $this->preventClickjacking(false). |
||
| 2136 | * This can be called from pages which do not contain any CSRF-protected |
||
| 2137 | * HTML form. |
||
| 2138 | */ |
||
| 2139 | public function allowClickjacking() { |
||
| 2142 | |||
| 2143 | /** |
||
| 2144 | * Get the prevent-clickjacking flag |
||
| 2145 | * |
||
| 2146 | * @since 1.24 |
||
| 2147 | * @return bool |
||
| 2148 | */ |
||
| 2149 | public function getPreventClickjacking() { |
||
| 2152 | |||
| 2153 | /** |
||
| 2154 | * Get the X-Frame-Options header value (without the name part), or false |
||
| 2155 | * if there isn't one. This is used by Skin to determine whether to enable |
||
| 2156 | * JavaScript frame-breaking, for clients that don't support X-Frame-Options. |
||
| 2157 | * |
||
| 2158 | * @return string |
||
| 2159 | */ |
||
| 2160 | public function getFrameOptions() { |
||
| 2169 | |||
| 2170 | /** |
||
| 2171 | * Send cache control HTTP headers |
||
| 2172 | */ |
||
| 2173 | public function sendCacheControl() { |
||
| 2238 | |||
| 2239 | /** |
||
| 2240 | * Finally, all the text has been munged and accumulated into |
||
| 2241 | * the object, let's actually output it: |
||
| 2242 | * |
||
| 2243 | * @param bool $return Set to true to get the result as a string rather than sending it |
||
| 2244 | * @return string|null |
||
| 2245 | * @throws Exception |
||
| 2246 | * @throws FatalError |
||
| 2247 | * @throws MWException |
||
| 2248 | */ |
||
| 2249 | public function output( $return = false ) { |
||
| 2365 | |||
| 2366 | /** |
||
| 2367 | * Prepare this object to display an error page; disable caching and |
||
| 2368 | * indexing, clear the current text and redirect, set the page's title |
||
| 2369 | * and optionally an custom HTML title (content of the "<title>" tag). |
||
| 2370 | * |
||
| 2371 | * @param string|Message $pageTitle Will be passed directly to setPageTitle() |
||
| 2372 | * @param string|Message $htmlTitle Will be passed directly to setHTMLTitle(); |
||
| 2373 | * optional, if not passed the "<title>" attribute will be |
||
| 2374 | * based on $pageTitle |
||
| 2375 | */ |
||
| 2376 | public function prepareErrorPage( $pageTitle, $htmlTitle = false ) { |
||
| 2388 | |||
| 2389 | /** |
||
| 2390 | * Output a standard error page |
||
| 2391 | * |
||
| 2392 | * showErrorPage( 'titlemsg', 'pagetextmsg' ); |
||
| 2393 | * showErrorPage( 'titlemsg', 'pagetextmsg', [ 'param1', 'param2' ] ); |
||
| 2394 | * showErrorPage( 'titlemsg', $messageObject ); |
||
| 2395 | * showErrorPage( $titleMessageObject, $messageObject ); |
||
| 2396 | * |
||
| 2397 | * @param string|Message $title Message key (string) for page title, or a Message object |
||
| 2398 | * @param string|Message $msg Message key (string) for page text, or a Message object |
||
| 2399 | * @param array $params Message parameters; ignored if $msg is a Message object |
||
| 2400 | */ |
||
| 2401 | public function showErrorPage( $title, $msg, $params = [] ) { |
||
| 2421 | |||
| 2422 | /** |
||
| 2423 | * Output a standard permission error page |
||
| 2424 | * |
||
| 2425 | * @param array $errors Error message keys or [key, param...] arrays |
||
| 2426 | * @param string $action Action that was denied or null if unknown |
||
| 2427 | */ |
||
| 2428 | public function showPermissionsErrorPage( array $errors, $action = null ) { |
||
| 2497 | |||
| 2498 | /** |
||
| 2499 | * Display an error page indicating that a given version of MediaWiki is |
||
| 2500 | * required to use it |
||
| 2501 | * |
||
| 2502 | * @param mixed $version The version of MediaWiki needed to use the page |
||
| 2503 | */ |
||
| 2504 | public function versionRequired( $version ) { |
||
| 2510 | |||
| 2511 | /** |
||
| 2512 | * Format a list of error messages |
||
| 2513 | * |
||
| 2514 | * @param array $errors Array of arrays returned by Title::getUserPermissionsErrors |
||
| 2515 | * @param string $action Action that was denied or null if unknown |
||
| 2516 | * @return string The wikitext error-messages, formatted into a list. |
||
| 2517 | */ |
||
| 2518 | public function formatPermissionsErrorMessage( array $errors, $action = null ) { |
||
| 2547 | |||
| 2548 | /** |
||
| 2549 | * Display a page stating that the Wiki is in read-only mode. |
||
| 2550 | * Should only be called after wfReadOnly() has returned true. |
||
| 2551 | * |
||
| 2552 | * Historically, this function was used to show the source of the page that the user |
||
| 2553 | * was trying to edit and _also_ permissions error messages. The relevant code was |
||
| 2554 | * moved into EditPage in 1.19 (r102024 / d83c2a431c2a) and removed here in 1.25. |
||
| 2555 | * |
||
| 2556 | * @deprecated since 1.25; throw the exception directly |
||
| 2557 | * @throws ReadOnlyError |
||
| 2558 | */ |
||
| 2559 | public function readOnlyPage() { |
||
| 2566 | |||
| 2567 | /** |
||
| 2568 | * Turn off regular page output and return an error response |
||
| 2569 | * for when rate limiting has triggered. |
||
| 2570 | * |
||
| 2571 | * @deprecated since 1.25; throw the exception directly |
||
| 2572 | */ |
||
| 2573 | public function rateLimited() { |
||
| 2577 | |||
| 2578 | /** |
||
| 2579 | * Show a warning about replica DB lag |
||
| 2580 | * |
||
| 2581 | * If the lag is higher than $wgSlaveLagCritical seconds, |
||
| 2582 | * then the warning is a bit more obvious. If the lag is |
||
| 2583 | * lower than $wgSlaveLagWarning, then no warning is shown. |
||
| 2584 | * |
||
| 2585 | * @param int $lag Slave lag |
||
| 2586 | */ |
||
| 2587 | public function showLagWarning( $lag ) { |
||
| 2598 | |||
| 2599 | public function showFatalError( $message ) { |
||
| 2604 | |||
| 2605 | public function showUnexpectedValueError( $name, $val ) { |
||
| 2608 | |||
| 2609 | public function showFileCopyError( $old, $new ) { |
||
| 2612 | |||
| 2613 | public function showFileRenameError( $old, $new ) { |
||
| 2616 | |||
| 2617 | public function showFileDeleteError( $name ) { |
||
| 2620 | |||
| 2621 | public function showFileNotFoundError( $name ) { |
||
| 2624 | |||
| 2625 | /** |
||
| 2626 | * Add a "return to" link pointing to a specified title |
||
| 2627 | * |
||
| 2628 | * @param Title $title Title to link |
||
| 2629 | * @param array $query Query string parameters |
||
| 2630 | * @param string $text Text of the link (input is not escaped) |
||
| 2631 | * @param array $options Options array to pass to Linker |
||
| 2632 | */ |
||
| 2633 | public function addReturnTo( $title, array $query = [], $text = null, $options = [] ) { |
||
| 2638 | |||
| 2639 | /** |
||
| 2640 | * Add a "return to" link pointing to a specified title, |
||
| 2641 | * or the title indicated in the request, or else the main page |
||
| 2642 | * |
||
| 2643 | * @param mixed $unused |
||
| 2644 | * @param Title|string $returnto Title or String to return to |
||
| 2645 | * @param string $returntoquery Query string for the return to link |
||
| 2646 | */ |
||
| 2647 | public function returnToMain( $unused = null, $returnto = null, $returntoquery = null ) { |
||
| 2671 | |||
| 2672 | private function getRlClientContext() { |
||
| 2692 | |||
| 2693 | /** |
||
| 2694 | * Call this to freeze the module queue and JS config and create a formatter. |
||
| 2695 | * |
||
| 2696 | * Depending on the Skin, this may get lazy-initialised in either headElement() or |
||
| 2697 | * getBottomScripts(). See SkinTemplate::prepareQuickTemplate(). Calling this too early may |
||
| 2698 | * cause unexpected side-effects since disallowUserJs() may be called at any time to change |
||
| 2699 | * the module filters retroactively. Skins and extension hooks may also add modules until very |
||
| 2700 | * late in the request lifecycle. |
||
| 2701 | * |
||
| 2702 | * @return ResourceLoaderClientHtml |
||
| 2703 | */ |
||
| 2704 | public function getRlClient() { |
||
| 2780 | |||
| 2781 | /** |
||
| 2782 | * @param Skin $sk The given Skin |
||
| 2783 | * @param bool $includeStyle Unused |
||
| 2784 | * @return string The doctype, opening "<html>", and head element. |
||
| 2785 | */ |
||
| 2786 | public function headElement( Skin $sk, $includeStyle = true ) { |
||
| 2857 | |||
| 2858 | /** |
||
| 2859 | * Get a ResourceLoader object associated with this OutputPage |
||
| 2860 | * |
||
| 2861 | * @return ResourceLoader |
||
| 2862 | */ |
||
| 2863 | public function getResourceLoader() { |
||
| 2872 | |||
| 2873 | /** |
||
| 2874 | * Explicily load or embed modules on a page. |
||
| 2875 | * |
||
| 2876 | * @param array|string $modules One or more module names |
||
| 2877 | * @param string $only ResourceLoaderModule TYPE_ class constant |
||
| 2878 | * @param array $extraQuery [optional] Array with extra query parameters for the request |
||
| 2879 | * @return string|WrappedStringList HTML |
||
| 2880 | */ |
||
| 2881 | public function makeResourceLoaderLink( $modules, $only, array $extraQuery = [] ) { |
||
| 2892 | |||
| 2893 | /** |
||
| 2894 | * Combine WrappedString chunks and filter out empty ones |
||
| 2895 | * |
||
| 2896 | * @param array $chunks |
||
| 2897 | * @return string|WrappedStringList HTML |
||
| 2898 | */ |
||
| 2899 | protected static function combineWrappedStrings( array $chunks ) { |
||
| 2904 | |||
| 2905 | private function isUserJsPreview() { |
||
| 2911 | |||
| 2912 | private function isUserCssPreview() { |
||
| 2918 | |||
| 2919 | /** |
||
| 2920 | * JS stuff to put at the bottom of the `<body>`. These are modules with position 'bottom', |
||
| 2921 | * legacy scripts ($this->mScripts), and user JS. |
||
| 2922 | * |
||
| 2923 | * @return string|WrappedStringList HTML |
||
| 2924 | */ |
||
| 2925 | public function getBottomScripts() { |
||
| 2977 | |||
| 2978 | /** |
||
| 2979 | * Get the javascript config vars to include on this page |
||
| 2980 | * |
||
| 2981 | * @return array Array of javascript config vars |
||
| 2982 | * @since 1.23 |
||
| 2983 | */ |
||
| 2984 | public function getJsConfigVars() { |
||
| 2987 | |||
| 2988 | /** |
||
| 2989 | * Add one or more variables to be set in mw.config in JavaScript |
||
| 2990 | * |
||
| 2991 | * @param string|array $keys Key or array of key/value pairs |
||
| 2992 | * @param mixed $value [optional] Value of the configuration variable |
||
| 2993 | */ |
||
| 2994 | View Code Duplication | public function addJsConfigVars( $keys, $value = null ) { |
|
| 3004 | |||
| 3005 | /** |
||
| 3006 | * Get an array containing the variables to be set in mw.config in JavaScript. |
||
| 3007 | * |
||
| 3008 | * Do not add things here which can be evaluated in ResourceLoaderStartUpModule |
||
| 3009 | * - in other words, page-independent/site-wide variables (without state). |
||
| 3010 | * You will only be adding bloat to the html page and causing page caches to |
||
| 3011 | * have to be purged on configuration changes. |
||
| 3012 | * @return array |
||
| 3013 | */ |
||
| 3014 | public function getJSVars() { |
||
| 3131 | |||
| 3132 | /** |
||
| 3133 | * To make it harder for someone to slip a user a fake |
||
| 3134 | * user-JavaScript or user-CSS preview, a random token |
||
| 3135 | * is associated with the login session. If it's not |
||
| 3136 | * passed back with the preview request, we won't render |
||
| 3137 | * the code. |
||
| 3138 | * |
||
| 3139 | * @return bool |
||
| 3140 | */ |
||
| 3141 | public function userCanPreview() { |
||
| 3177 | |||
| 3178 | /** |
||
| 3179 | * @return array Array in format "link name or number => 'link html'". |
||
| 3180 | */ |
||
| 3181 | public function getHeadLinksArray() { |
||
| 3442 | |||
| 3443 | /** |
||
| 3444 | * @return string HTML tag links to be put in the header. |
||
| 3445 | * @deprecated since 1.24 Use OutputPage::headElement or if you have to, |
||
| 3446 | * OutputPage::getHeadLinksArray directly. |
||
| 3447 | */ |
||
| 3448 | public function getHeadLinks() { |
||
| 3452 | |||
| 3453 | /** |
||
| 3454 | * Generate a "<link rel/>" for a feed. |
||
| 3455 | * |
||
| 3456 | * @param string $type Feed type |
||
| 3457 | * @param string $url URL to the feed |
||
| 3458 | * @param string $text Value of the "title" attribute |
||
| 3459 | * @return string HTML fragment |
||
| 3460 | */ |
||
| 3461 | private function feedLink( $type, $url, $text ) { |
||
| 3469 | |||
| 3470 | /** |
||
| 3471 | * Add a local or specified stylesheet, with the given media options. |
||
| 3472 | * Internal use only. Use OutputPage::addModuleStyles() if possible. |
||
| 3473 | * |
||
| 3474 | * @param string $style URL to the file |
||
| 3475 | * @param string $media To specify a media type, 'screen', 'printable', 'handheld' or any. |
||
| 3476 | * @param string $condition For IE conditional comments, specifying an IE version |
||
| 3477 | * @param string $dir Set to 'rtl' or 'ltr' for direction-specific sheets |
||
| 3478 | */ |
||
| 3479 | public function addStyle( $style, $media = '', $condition = '', $dir = '' ) { |
||
| 3492 | |||
| 3493 | /** |
||
| 3494 | * Adds inline CSS styles |
||
| 3495 | * Internal use only. Use OutputPage::addModuleStyles() if possible. |
||
| 3496 | * |
||
| 3497 | * @param mixed $style_css Inline CSS |
||
| 3498 | * @param string $flip Set to 'flip' to flip the CSS if needed |
||
| 3499 | */ |
||
| 3500 | public function addInlineStyle( $style_css, $flip = 'noflip' ) { |
||
| 3507 | |||
| 3508 | /** |
||
| 3509 | * Build exempt modules and legacy non-ResourceLoader styles. |
||
| 3510 | * |
||
| 3511 | * @return string|WrappedStringList HTML |
||
| 3512 | */ |
||
| 3513 | protected function buildExemptModules() { |
||
| 3562 | |||
| 3563 | /** |
||
| 3564 | * @return array |
||
| 3565 | */ |
||
| 3566 | public function buildCssLinksArray() { |
||
| 3583 | |||
| 3584 | /** |
||
| 3585 | * Generate \<link\> tags for stylesheets |
||
| 3586 | * |
||
| 3587 | * @param string $style URL to the file |
||
| 3588 | * @param array $options Option, can contain 'condition', 'dir', 'media' keys |
||
| 3589 | * @return string HTML fragment |
||
| 3590 | */ |
||
| 3591 | protected function styleLink( $style, array $options ) { |
||
| 3625 | |||
| 3626 | /** |
||
| 3627 | * Transform path to web-accessible static resource. |
||
| 3628 | * |
||
| 3629 | * This is used to add a validation hash as query string. |
||
| 3630 | * This aids various behaviors: |
||
| 3631 | * |
||
| 3632 | * - Put long Cache-Control max-age headers on responses for improved |
||
| 3633 | * cache performance. |
||
| 3634 | * - Get the correct version of a file as expected by the current page. |
||
| 3635 | * - Instantly get the updated version of a file after deployment. |
||
| 3636 | * |
||
| 3637 | * Avoid using this for urls included in HTML as otherwise clients may get different |
||
| 3638 | * versions of a resource when navigating the site depending on when the page was cached. |
||
| 3639 | * If changes to the url propagate, this is not a problem (e.g. if the url is in |
||
| 3640 | * an external stylesheet). |
||
| 3641 | * |
||
| 3642 | * @since 1.27 |
||
| 3643 | * @param Config $config |
||
| 3644 | * @param string $path Path-absolute URL to file (from document root, must start with "/") |
||
| 3645 | * @return string URL |
||
| 3646 | */ |
||
| 3647 | public static function transformResourcePath( Config $config, $path ) { |
||
| 3664 | |||
| 3665 | /** |
||
| 3666 | * Utility method for transformResourceFilePath(). |
||
| 3667 | * |
||
| 3668 | * Caller is responsible for ensuring the file exists. Emits a PHP warning otherwise. |
||
| 3669 | * |
||
| 3670 | * @since 1.27 |
||
| 3671 | * @param string $remotePath URL path prefix that points to $localPath |
||
| 3672 | * @param string $localPath File directory exposed at $remotePath |
||
| 3673 | * @param string $file Path to target file relative to $localPath |
||
| 3674 | * @return string URL |
||
| 3675 | */ |
||
| 3676 | public static function transformFilePath( $remotePathPrefix, $localPath, $file ) { |
||
| 3684 | |||
| 3685 | /** |
||
| 3686 | * Transform "media" attribute based on request parameters |
||
| 3687 | * |
||
| 3688 | * @param string $media Current value of the "media" attribute |
||
| 3689 | * @return string Modified value of the "media" attribute, or null to skip |
||
| 3690 | * this stylesheet |
||
| 3691 | */ |
||
| 3692 | public static function transformCssMedia( $media ) { |
||
| 3730 | |||
| 3731 | /** |
||
| 3732 | * Add a wikitext-formatted message to the output. |
||
| 3733 | * This is equivalent to: |
||
| 3734 | * |
||
| 3735 | * $wgOut->addWikiText( wfMessage( ... )->plain() ) |
||
| 3736 | */ |
||
| 3737 | public function addWikiMsg( /*...*/ ) { |
||
| 3742 | |||
| 3743 | /** |
||
| 3744 | * Add a wikitext-formatted message to the output. |
||
| 3745 | * Like addWikiMsg() except the parameters are taken as an array |
||
| 3746 | * instead of a variable argument list. |
||
| 3747 | * |
||
| 3748 | * @param string $name |
||
| 3749 | * @param array $args |
||
| 3750 | */ |
||
| 3751 | public function addWikiMsgArray( $name, $args ) { |
||
| 3754 | |||
| 3755 | /** |
||
| 3756 | * This function takes a number of message/argument specifications, wraps them in |
||
| 3757 | * some overall structure, and then parses the result and adds it to the output. |
||
| 3758 | * |
||
| 3759 | * In the $wrap, $1 is replaced with the first message, $2 with the second, |
||
| 3760 | * and so on. The subsequent arguments may be either |
||
| 3761 | * 1) strings, in which case they are message names, or |
||
| 3762 | * 2) arrays, in which case, within each array, the first element is the message |
||
| 3763 | * name, and subsequent elements are the parameters to that message. |
||
| 3764 | * |
||
| 3765 | * Don't use this for messages that are not in the user's interface language. |
||
| 3766 | * |
||
| 3767 | * For example: |
||
| 3768 | * |
||
| 3769 | * $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>", 'some-error' ); |
||
| 3770 | * |
||
| 3771 | * Is equivalent to: |
||
| 3772 | * |
||
| 3773 | * $wgOut->addWikiText( "<div class='error'>\n" |
||
| 3774 | * . wfMessage( 'some-error' )->plain() . "\n</div>" ); |
||
| 3775 | * |
||
| 3776 | * The newline after the opening div is needed in some wikitext. See bug 19226. |
||
| 3777 | * |
||
| 3778 | * @param string $wrap |
||
| 3779 | */ |
||
| 3780 | public function wrapWikiMsg( $wrap /*, ...*/ ) { |
||
| 3804 | |||
| 3805 | /** |
||
| 3806 | * Enables/disables TOC, doesn't override __NOTOC__ |
||
| 3807 | * @param bool $flag |
||
| 3808 | * @since 1.22 |
||
| 3809 | */ |
||
| 3810 | public function enableTOC( $flag = true ) { |
||
| 3813 | |||
| 3814 | /** |
||
| 3815 | * @return bool |
||
| 3816 | * @since 1.22 |
||
| 3817 | */ |
||
| 3818 | public function isTOCEnabled() { |
||
| 3821 | |||
| 3822 | /** |
||
| 3823 | * Enables/disables section edit links, doesn't override __NOEDITSECTION__ |
||
| 3824 | * @param bool $flag |
||
| 3825 | * @since 1.23 |
||
| 3826 | */ |
||
| 3827 | public function enableSectionEditLinks( $flag = true ) { |
||
| 3830 | |||
| 3831 | /** |
||
| 3832 | * @return bool |
||
| 3833 | * @since 1.23 |
||
| 3834 | */ |
||
| 3835 | public function sectionEditLinksEnabled() { |
||
| 3838 | |||
| 3839 | /** |
||
| 3840 | * Helper function to setup the PHP implementation of OOUI to use in this request. |
||
| 3841 | * |
||
| 3842 | * @since 1.26 |
||
| 3843 | * @param String $skinName The Skin name to determine the correct OOUI theme |
||
| 3844 | * @param String $dir Language direction |
||
| 3845 | */ |
||
| 3846 | public static function setupOOUI( $skinName = '', $dir = 'ltr' ) { |
||
| 3856 | |||
| 3857 | /** |
||
| 3858 | * Add ResourceLoader module styles for OOUI and set up the PHP implementation of it for use with |
||
| 3859 | * MediaWiki and this OutputPage instance. |
||
| 3860 | * |
||
| 3861 | * @since 1.25 |
||
| 3862 | */ |
||
| 3863 | public function enableOOUI() { |
||
| 3876 | |||
| 3877 | /** |
||
| 3878 | * @param array $data Data from ParserOutput::getLimitReportData() |
||
| 3879 | * @since 1.28 |
||
| 3880 | */ |
||
| 3881 | public function setLimitReportData( array $data ) { |
||
| 3884 | } |
||
| 3885 |
This check looks for assignments to scalar types that may be of the wrong type.
To ensure the code behaves as expected, it may be a good idea to add an explicit type cast.