3 * Preparation for the final page rendering.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
23 use MediaWiki\Logger\LoggerFactory
;
24 use MediaWiki\MediaWikiServices
;
25 use MediaWiki\Session\SessionManager
;
26 use WrappedString\WrappedString
;
27 use WrappedString\WrappedStringList
;
30 * This class should be covered by a general architecture document which does
31 * not exist as of January 2011. This is one of the Core classes and should
32 * be read at least once by any new developers.
34 * This class is used to prepare the final rendering. A skin is then
35 * applied to the output parameters (links, javascript, html, categories ...).
37 * @todo FIXME: Another class handles sending the whole page to the client.
39 * Some comments comes from a pairing session between Zak Greant and Antoine Musso
44 class OutputPage
extends ContextSource
{
45 /** @var array Should be private. Used with addMeta() which adds "<meta>" */
46 protected $mMetatags = [];
49 protected $mLinktags = [];
52 protected $mCanonicalUrl = false;
55 * @var array Additional stylesheets. Looks like this is for extensions.
56 * Might be replaced by ResourceLoader.
58 protected $mExtStyles = [];
61 * @var string Should be private - has getter and setter. Contains
63 public $mPagetitle = '';
66 * @var string Contains all of the "<body>" content. Should be private we
67 * got set/get accessors and the append() method.
69 public $mBodytext = '';
71 /** @var string Stores contents of "<title>" tag */
72 private $mHTMLtitle = '';
75 * @var bool Is the displayed content related to the source of the
76 * corresponding wiki article.
78 private $mIsarticle = false;
80 /** @var bool Stores "article flag" toggle. */
81 private $mIsArticleRelated = true;
84 * @var bool We have to set isPrintable(). Some pages should
85 * never be printed (ex: redirections).
87 private $mPrintable = false;
90 * @var array Contains the page subtitle. Special pages usually have some
91 * links here. Don't confuse with site subtitle added by skins.
93 private $mSubtitle = [];
96 public $mRedirect = '';
99 protected $mStatusCode;
102 * @var string Used for sending cache control.
103 * The whole caching system should probably be moved into its own class.
105 protected $mLastModified = '';
108 protected $mCategoryLinks = [];
111 protected $mCategories = [
117 protected $mIndicators = [];
119 /** @var array Array of Interwiki Prefixed (non DB key) Titles (e.g. 'fr:Test page') */
120 private $mLanguageLinks = [];
123 * Used for JavaScript (predates ResourceLoader)
124 * @todo We should split JS / CSS.
125 * mScripts content is inserted as is in "<head>" by Skin. This might
126 * contain either a link to a stylesheet or inline CSS.
128 private $mScripts = '';
130 /** @var string Inline CSS styles. Use addInlineStyle() sparingly */
131 protected $mInlineStyles = '';
134 * @var string Used by skin template.
135 * Example: $tpl->set( 'displaytitle', $out->mPageLinkTitle );
137 public $mPageLinkTitle = '';
139 /** @var array Array of elements in "<head>". Parser might add its own headers! */
140 protected $mHeadItems = [];
143 protected $mModules = [];
146 protected $mModuleScripts = [];
149 protected $mModuleStyles = [];
151 /** @var ResourceLoader */
152 protected $mResourceLoader;
154 /** @var ResourceLoaderClientHtml */
157 /** @var ResourceLoaderContext */
158 private $rlClientContext;
161 private $rlUserModuleState;
164 private $rlExemptStyleModules;
167 protected $mJsConfigVars = [];
170 protected $mTemplateIds = [];
173 protected $mImageTimeKeys = [];
176 public $mRedirectCode = '';
178 protected $mFeedLinksAppendQuery = null;
181 * What level of 'untrustworthiness' is allowed in CSS/JS modules loaded on this page?
182 * @see ResourceLoaderModule::$origin
183 * ResourceLoaderModule::ORIGIN_ALL is assumed unless overridden;
185 protected $mAllowedModules = [
186 ResourceLoaderModule
::TYPE_COMBINED
=> ResourceLoaderModule
::ORIGIN_ALL
,
189 /** @var bool Whether output is disabled. If this is true, the 'output' method will do nothing. */
190 protected $mDoNothing = false;
195 protected $mContainsNewMagic = 0;
198 * lazy initialised, use parserOptions()
201 protected $mParserOptions = null;
204 * Handles the Atom / RSS links.
205 * We probably only support Atom in 2011.
206 * @see $wgAdvertisedFeedTypes
208 private $mFeedLinks = [];
210 // Gwicke work on squid caching? Roughly from 2003.
211 protected $mEnableClientCache = true;
213 /** @var bool Flag if output should only contain the body of the article. */
214 private $mArticleBodyOnly = false;
217 protected $mNewSectionLink = false;
220 protected $mHideNewSectionLink = false;
223 * @var bool Comes from the parser. This was probably made to load CSS/JS
224 * only if we had "<gallery>". Used directly in CategoryPage.php.
225 * Looks like ResourceLoader can replace this.
227 public $mNoGallery = false;
230 private $mPageTitleActionText = '';
232 /** @var int Cache stuff. Looks like mEnableClientCache */
233 protected $mCdnMaxage = 0;
234 /** @var int Upper limit on mCdnMaxage */
235 protected $mCdnMaxageLimit = INF
;
238 * @var bool Controls if anti-clickjacking / frame-breaking headers will
239 * be sent. This should be done for pages where edit actions are possible.
240 * Setters: $this->preventClickjacking() and $this->allowClickjacking().
242 protected $mPreventClickjacking = true;
244 /** @var int To include the variable {{REVISIONID}} */
245 private $mRevisionId = null;
248 private $mRevisionTimestamp = null;
251 protected $mFileVersion = null;
254 * @var array An array of stylesheet filenames (relative from skins path),
255 * with options for CSS media, IE conditions, and RTL/LTR direction.
256 * For internal use; add settings in the skin via $this->addStyle()
258 * Style again! This seems like a code duplication since we already have
259 * mStyles. This is what makes Open Source amazing.
261 protected $styles = [];
263 private $mIndexPolicy = 'index';
264 private $mFollowPolicy = 'follow';
265 private $mVaryHeader = [
266 'Accept-Encoding' => [ 'match=gzip' ],
270 * If the current page was reached through a redirect, $mRedirectedFrom contains the Title
275 private $mRedirectedFrom = null;
278 * Additional key => value data
280 private $mProperties = [];
283 * @var string|null ResourceLoader target for load.php links. If null, will be omitted
285 private $mTarget = null;
288 * @var bool Whether parser output contains a table of contents
290 private $mEnableTOC = false;
293 * @var bool Whether parser output should contain section edit links
295 private $mEnableSectionEditLinks = true;
298 * @var string|null The URL to send in a <link> element with rel=copyright
300 private $copyrightUrl;
302 /** @var array Profiling data */
303 private $limitReportJSData = [];
306 * Link: header contents
308 private $mLinkHeader = [];
311 * Constructor for OutputPage. This should not be called directly.
312 * Instead a new RequestContext should be created and it will implicitly create
313 * a OutputPage tied to that context.
314 * @param IContextSource|null $context
316 function __construct( IContextSource
$context = null ) {
317 if ( $context === null ) {
318 # Extensions should use `new RequestContext` instead of `new OutputPage` now.
319 wfDeprecated( __METHOD__
, '1.18' );
321 $this->setContext( $context );
326 * Redirect to $url rather than displaying the normal page
328 * @param string $url URL
329 * @param string $responsecode HTTP status code
331 public function redirect( $url, $responsecode = '302' ) {
332 # Strip newlines as a paranoia check for header injection in PHP<5.1.2
333 $this->mRedirect
= str_replace( "\n", '', $url );
334 $this->mRedirectCode
= $responsecode;
338 * Get the URL to redirect to, or an empty string if not redirect URL set
342 public function getRedirect() {
343 return $this->mRedirect
;
347 * Set the copyright URL to send with the output.
348 * Empty string to omit, null to reset.
352 * @param string|null $url
354 public function setCopyrightUrl( $url ) {
355 $this->copyrightUrl
= $url;
359 * Set the HTTP status code to send with the output.
361 * @param int $statusCode
363 public function setStatusCode( $statusCode ) {
364 $this->mStatusCode
= $statusCode;
368 * Add a new "<meta>" tag
369 * To add an http-equiv meta tag, precede the name with "http:"
371 * @param string $name Tag name
372 * @param string $val Tag value
374 function addMeta( $name, $val ) {
375 array_push( $this->mMetatags
, [ $name, $val ] );
379 * Returns the current <meta> tags
384 public function getMetaTags() {
385 return $this->mMetatags
;
389 * Add a new \<link\> tag to the page header.
391 * Note: use setCanonicalUrl() for rel=canonical.
393 * @param array $linkarr Associative array of attributes.
395 function addLink( array $linkarr ) {
396 array_push( $this->mLinktags
, $linkarr );
400 * Returns the current <link> tags
405 public function getLinkTags() {
406 return $this->mLinktags
;
410 * Add a new \<link\> with "rel" attribute set to "meta"
412 * @param array $linkarr Associative array mapping attribute names to their
413 * values, both keys and values will be escaped, and the
414 * "rel" attribute will be automatically added
416 function addMetadataLink( array $linkarr ) {
417 $linkarr['rel'] = $this->getMetadataAttribute();
418 $this->addLink( $linkarr );
422 * Set the URL to be used for the <link rel=canonical>. This should be used
423 * in preference to addLink(), to avoid duplicate link tags.
426 function setCanonicalUrl( $url ) {
427 $this->mCanonicalUrl
= $url;
431 * Returns the URL to be used for the <link rel=canonical> if
435 * @return bool|string
437 public function getCanonicalUrl() {
438 return $this->mCanonicalUrl
;
442 * Get the value of the "rel" attribute for metadata links
446 public function getMetadataAttribute() {
447 # note: buggy CC software only reads first "meta" link
448 static $haveMeta = false;
450 return 'alternate meta';
458 * Add raw HTML to the list of scripts (including \<script\> tag, etc.)
459 * Internal use only. Use OutputPage::addModules() or OutputPage::addJsConfigVars()
462 * @param string $script Raw HTML
464 function addScript( $script ) {
465 $this->mScripts
.= $script;
469 * Register and add a stylesheet from an extension directory.
471 * @deprecated since 1.27 use addModuleStyles() or addStyle() instead
472 * @param string $url Path to sheet. Provide either a full url (beginning
473 * with 'http', etc) or a relative path from the document root
474 * (beginning with '/'). Otherwise it behaves identically to
475 * addStyle() and draws from the /skins folder.
477 public function addExtensionStyle( $url ) {
478 wfDeprecated( __METHOD__
, '1.27' );
479 array_push( $this->mExtStyles
, $url );
483 * Get all styles added by extensions
485 * @deprecated since 1.27
488 function getExtStyle() {
489 wfDeprecated( __METHOD__
, '1.27' );
490 return $this->mExtStyles
;
494 * Add a JavaScript file out of skins/common, or a given relative path.
495 * Internal use only. Use OutputPage::addModules() if possible.
497 * @param string $file Filename in skins/common or complete on-server path
499 * @param string $version Style version of the file. Defaults to $wgStyleVersion
501 public function addScriptFile( $file, $version = null ) {
502 // See if $file parameter is an absolute URL or begins with a slash
503 if ( substr( $file, 0, 1 ) == '/' ||
preg_match( '#^[a-z]*://#i', $file ) ) {
506 $path = $this->getConfig()->get( 'StylePath' ) . "/common/{$file}";
508 if ( is_null( $version ) ) {
509 $version = $this->getConfig()->get( 'StyleVersion' );
511 $this->addScript( Html
::linkedScript( wfAppendQuery( $path, $version ) ) );
515 * Add a self-contained script tag with the given contents
516 * Internal use only. Use OutputPage::addModules() if possible.
518 * @param string $script JavaScript text, no script tags
520 public function addInlineScript( $script ) {
521 $this->mScripts
.= Html
::inlineScript( $script );
525 * Filter an array of modules to remove insufficiently trustworthy members, and modules
526 * which are no longer registered (eg a page is cached before an extension is disabled)
527 * @param array $modules
528 * @param string|null $position If not null, only return modules with this position
529 * @param string $type
532 protected function filterModules( array $modules, $position = null,
533 $type = ResourceLoaderModule
::TYPE_COMBINED
535 $resourceLoader = $this->getResourceLoader();
536 $filteredModules = [];
537 foreach ( $modules as $val ) {
538 $module = $resourceLoader->getModule( $val );
539 if ( $module instanceof ResourceLoaderModule
540 && $module->getOrigin() <= $this->getAllowedModules( $type )
541 && ( is_null( $position ) ||
$module->getPosition() == $position )
543 if ( $this->mTarget
&& !in_array( $this->mTarget
, $module->getTargets() ) ) {
544 $this->warnModuleTargetFilter( $module->getName() );
547 $filteredModules[] = $val;
550 return $filteredModules;
553 private function warnModuleTargetFilter( $moduleName ) {
554 static $warnings = [];
555 if ( isset( $warnings[$this->mTarget
][$moduleName] ) ) {
558 $warnings[$this->mTarget
][$moduleName] = true;
559 $this->getResourceLoader()->getLogger()->debug(
560 'Module "{module}" not loadable on target "{target}".',
562 'module' => $moduleName,
563 'target' => $this->mTarget
,
569 * Get the list of modules to include on this page
571 * @param bool $filter Whether to filter out insufficiently trustworthy modules
572 * @param string|null $position If not null, only return modules with this position
573 * @param string $param
574 * @return array Array of module names
576 public function getModules( $filter = false, $position = null, $param = 'mModules',
577 $type = ResourceLoaderModule
::TYPE_COMBINED
579 $modules = array_values( array_unique( $this->$param ) );
581 ?
$this->filterModules( $modules, $position, $type )
586 * Add one or more modules recognized by ResourceLoader. Modules added
587 * through this function will be loaded by ResourceLoader when the
590 * @param string|array $modules Module name (string) or array of module names
592 public function addModules( $modules ) {
593 $this->mModules
= array_merge( $this->mModules
, (array)$modules );
597 * Get the list of module JS to include on this page
599 * @param bool $filter
600 * @param string|null $position
601 * @return array Array of module names
603 public function getModuleScripts( $filter = false, $position = null ) {
604 return $this->getModules( $filter, $position, 'mModuleScripts',
605 ResourceLoaderModule
::TYPE_SCRIPTS
610 * Add only JS of one or more modules recognized by ResourceLoader. Module
611 * scripts added through this function will be loaded by ResourceLoader when
614 * @param string|array $modules Module name (string) or array of module names
616 public function addModuleScripts( $modules ) {
617 $this->mModuleScripts
= array_merge( $this->mModuleScripts
, (array)$modules );
621 * Get the list of module CSS to include on this page
623 * @param bool $filter
624 * @param string|null $position
625 * @return array Array of module names
627 public function getModuleStyles( $filter = false, $position = null ) {
628 return $this->getModules( $filter, $position, 'mModuleStyles',
629 ResourceLoaderModule
::TYPE_STYLES
634 * Add only CSS of one or more modules recognized by ResourceLoader.
636 * Module styles added through this function will be added using standard link CSS
637 * tags, rather than as a combined Javascript and CSS package. Thus, they will
638 * load when JavaScript is disabled (unless CSS also happens to be disabled).
640 * @param string|array $modules Module name (string) or array of module names
642 public function addModuleStyles( $modules ) {
643 $this->mModuleStyles
= array_merge( $this->mModuleStyles
, (array)$modules );
647 * @return null|string ResourceLoader target
649 public function getTarget() {
650 return $this->mTarget
;
654 * Sets ResourceLoader target for load.php links. If null, will be omitted
656 * @param string|null $target
658 public function setTarget( $target ) {
659 $this->mTarget
= $target;
663 * Get an array of head items
667 function getHeadItemsArray() {
668 return $this->mHeadItems
;
672 * Add or replace a head item to the output
674 * Whenever possible, use more specific options like ResourceLoader modules,
675 * OutputPage::addLink(), OutputPage::addMetaLink() and OutputPage::addFeedLink()
676 * Fallback options for those are: OutputPage::addStyle, OutputPage::addScript(),
677 * OutputPage::addInlineScript() and OutputPage::addInlineStyle()
678 * This would be your very LAST fallback.
680 * @param string $name Item name
681 * @param string $value Raw HTML
683 public function addHeadItem( $name, $value ) {
684 $this->mHeadItems
[$name] = $value;
688 * Add one or more head items to the output
691 * @param string|string[] $value Raw HTML
693 public function addHeadItems( $values ) {
694 $this->mHeadItems
= array_merge( $this->mHeadItems
, (array)$values );
698 * Check if the header item $name is already set
700 * @param string $name Item name
703 public function hasHeadItem( $name ) {
704 return isset( $this->mHeadItems
[$name] );
708 * @deprecated since 1.28 Obsolete - wgUseETag experiment was removed.
711 public function setETag( $tag ) {
715 * Set whether the output should only contain the body of the article,
716 * without any skin, sidebar, etc.
717 * Used e.g. when calling with "action=render".
719 * @param bool $only Whether to output only the body of the article
721 public function setArticleBodyOnly( $only ) {
722 $this->mArticleBodyOnly
= $only;
726 * Return whether the output will contain only the body of the article
730 public function getArticleBodyOnly() {
731 return $this->mArticleBodyOnly
;
735 * Set an additional output property
738 * @param string $name
739 * @param mixed $value
741 public function setProperty( $name, $value ) {
742 $this->mProperties
[$name] = $value;
746 * Get an additional output property
749 * @param string $name
750 * @return mixed Property value or null if not found
752 public function getProperty( $name ) {
753 if ( isset( $this->mProperties
[$name] ) ) {
754 return $this->mProperties
[$name];
761 * checkLastModified tells the client to use the client-cached page if
762 * possible. If successful, the OutputPage is disabled so that
763 * any future call to OutputPage->output() have no effect.
765 * Side effect: sets mLastModified for Last-Modified header
767 * @param string $timestamp
769 * @return bool True if cache-ok headers was sent.
771 public function checkLastModified( $timestamp ) {
772 if ( !$timestamp ||
$timestamp == '19700101000000' ) {
773 wfDebug( __METHOD__
. ": CACHE DISABLED, NO TIMESTAMP\n" );
776 $config = $this->getConfig();
777 if ( !$config->get( 'CachePages' ) ) {
778 wfDebug( __METHOD__
. ": CACHE DISABLED\n" );
782 $timestamp = wfTimestamp( TS_MW
, $timestamp );
784 'page' => $timestamp,
785 'user' => $this->getUser()->getTouched(),
786 'epoch' => $config->get( 'CacheEpoch' )
788 if ( $config->get( 'UseSquid' ) ) {
789 // T46570: the core page itself may not change, but resources might
790 $modifiedTimes['sepoch'] = wfTimestamp( TS_MW
, time() - $config->get( 'SquidMaxage' ) );
792 Hooks
::run( 'OutputPageCheckLastModified', [ &$modifiedTimes, $this ] );
794 $maxModified = max( $modifiedTimes );
795 $this->mLastModified
= wfTimestamp( TS_RFC2822
, $maxModified );
797 $clientHeader = $this->getRequest()->getHeader( 'If-Modified-Since' );
798 if ( $clientHeader === false ) {
799 wfDebug( __METHOD__
. ": client did not send If-Modified-Since header", 'private' );
803 # IE sends sizes after the date like this:
804 # Wed, 20 Aug 2003 06:51:19 GMT; length=5202
805 # this breaks strtotime().
806 $clientHeader = preg_replace( '/;.*$/', '', $clientHeader );
808 MediaWiki\
suppressWarnings(); // E_STRICT system time bitching
809 $clientHeaderTime = strtotime( $clientHeader );
810 MediaWiki\restoreWarnings
();
811 if ( !$clientHeaderTime ) {
813 . ": unable to parse the client's If-Modified-Since header: $clientHeader\n" );
816 $clientHeaderTime = wfTimestamp( TS_MW
, $clientHeaderTime );
820 foreach ( $modifiedTimes as $name => $value ) {
821 if ( $info !== '' ) {
824 $info .= "$name=" . wfTimestamp( TS_ISO_8601
, $value );
827 wfDebug( __METHOD__
. ": client sent If-Modified-Since: " .
828 wfTimestamp( TS_ISO_8601
, $clientHeaderTime ), 'private' );
829 wfDebug( __METHOD__
. ": effective Last-Modified: " .
830 wfTimestamp( TS_ISO_8601
, $maxModified ), 'private' );
831 if ( $clientHeaderTime < $maxModified ) {
832 wfDebug( __METHOD__
. ": STALE, $info", 'private' );
837 # Give a 304 Not Modified response code and disable body output
838 wfDebug( __METHOD__
. ": NOT MODIFIED, $info", 'private' );
839 ini_set( 'zlib.output_compression', 0 );
840 $this->getRequest()->response()->statusHeader( 304 );
841 $this->sendCacheControl();
844 // Don't output a compressed blob when using ob_gzhandler;
845 // it's technically against HTTP spec and seems to confuse
846 // Firefox when the response gets split over two packets.
847 wfClearOutputBuffers();
853 * Override the last modified timestamp
855 * @param string $timestamp New timestamp, in a format readable by
858 public function setLastModified( $timestamp ) {
859 $this->mLastModified
= wfTimestamp( TS_RFC2822
, $timestamp );
863 * Set the robot policy for the page: <http://www.robotstxt.org/meta.html>
865 * @param string $policy The literal string to output as the contents of
866 * the meta tag. Will be parsed according to the spec and output in
870 public function setRobotPolicy( $policy ) {
871 $policy = Article
::formatRobotPolicy( $policy );
873 if ( isset( $policy['index'] ) ) {
874 $this->setIndexPolicy( $policy['index'] );
876 if ( isset( $policy['follow'] ) ) {
877 $this->setFollowPolicy( $policy['follow'] );
882 * Set the index policy for the page, but leave the follow policy un-
885 * @param string $policy Either 'index' or 'noindex'.
888 public function setIndexPolicy( $policy ) {
889 $policy = trim( $policy );
890 if ( in_array( $policy, [ 'index', 'noindex' ] ) ) {
891 $this->mIndexPolicy
= $policy;
896 * Set the follow policy for the page, but leave the index policy un-
899 * @param string $policy Either 'follow' or 'nofollow'.
902 public function setFollowPolicy( $policy ) {
903 $policy = trim( $policy );
904 if ( in_array( $policy, [ 'follow', 'nofollow' ] ) ) {
905 $this->mFollowPolicy
= $policy;
910 * Set the new value of the "action text", this will be added to the
911 * "HTML title", separated from it with " - ".
913 * @param string $text New value of the "action text"
915 public function setPageTitleActionText( $text ) {
916 $this->mPageTitleActionText
= $text;
920 * Get the value of the "action text"
924 public function getPageTitleActionText() {
925 return $this->mPageTitleActionText
;
929 * "HTML title" means the contents of "<title>".
930 * It is stored as plain, unescaped text and will be run through htmlspecialchars in the skin file.
932 * @param string|Message $name
934 public function setHTMLTitle( $name ) {
935 if ( $name instanceof Message
) {
936 $this->mHTMLtitle
= $name->setContext( $this->getContext() )->text();
938 $this->mHTMLtitle
= $name;
943 * Return the "HTML title", i.e. the content of the "<title>" tag.
947 public function getHTMLTitle() {
948 return $this->mHTMLtitle
;
952 * Set $mRedirectedFrom, the Title of the page which redirected us to the current page.
956 public function setRedirectedFrom( $t ) {
957 $this->mRedirectedFrom
= $t;
961 * "Page title" means the contents of \<h1\>. It is stored as a valid HTML
962 * fragment. This function allows good tags like \<sup\> in the \<h1\> tag,
963 * but not bad tags like \<script\>. This function automatically sets
964 * \<title\> to the same content as \<h1\> but with all tags removed. Bad
965 * tags that were escaped in \<h1\> will still be escaped in \<title\>, and
966 * good tags like \<i\> will be dropped entirely.
968 * @param string|Message $name
970 public function setPageTitle( $name ) {
971 if ( $name instanceof Message
) {
972 $name = $name->setContext( $this->getContext() )->text();
975 # change "<script>foo&bar</script>" to "<script>foo&bar</script>"
976 # but leave "<i>foobar</i>" alone
977 $nameWithTags = Sanitizer
::normalizeCharReferences( Sanitizer
::removeHTMLtags( $name ) );
978 $this->mPagetitle
= $nameWithTags;
980 # change "<i>foo&bar</i>" to "foo&bar"
982 $this->msg( 'pagetitle' )->rawParams( Sanitizer
::stripAllTags( $nameWithTags ) )
983 ->inContentLanguage()
988 * Return the "page title", i.e. the content of the \<h1\> tag.
992 public function getPageTitle() {
993 return $this->mPagetitle
;
997 * Set the Title object to use
1001 public function setTitle( Title
$t ) {
1002 $this->getContext()->setTitle( $t );
1006 * Replace the subtitle with $str
1008 * @param string|Message $str New value of the subtitle. String should be safe HTML.
1010 public function setSubtitle( $str ) {
1011 $this->clearSubtitle();
1012 $this->addSubtitle( $str );
1016 * Add $str to the subtitle
1018 * @param string|Message $str String or Message to add to the subtitle. String should be safe HTML.
1020 public function addSubtitle( $str ) {
1021 if ( $str instanceof Message
) {
1022 $this->mSubtitle
[] = $str->setContext( $this->getContext() )->parse();
1024 $this->mSubtitle
[] = $str;
1029 * Build message object for a subtitle containing a backlink to a page
1031 * @param Title $title Title to link to
1032 * @param array $query Array of additional parameters to include in the link
1036 public static function buildBacklinkSubtitle( Title
$title, $query = [] ) {
1037 if ( $title->isRedirect() ) {
1038 $query['redirect'] = 'no';
1040 $linkRenderer = MediaWikiServices
::getInstance()->getLinkRenderer();
1041 return wfMessage( 'backlinksubtitle' )
1042 ->rawParams( $linkRenderer->makeLink( $title, null, [], $query ) );
1046 * Add a subtitle containing a backlink to a page
1048 * @param Title $title Title to link to
1049 * @param array $query Array of additional parameters to include in the link
1051 public function addBacklinkSubtitle( Title
$title, $query = [] ) {
1052 $this->addSubtitle( self
::buildBacklinkSubtitle( $title, $query ) );
1056 * Clear the subtitles
1058 public function clearSubtitle() {
1059 $this->mSubtitle
= [];
1067 public function getSubtitle() {
1068 return implode( "<br />\n\t\t\t\t", $this->mSubtitle
);
1072 * Set the page as printable, i.e. it'll be displayed with all
1073 * print styles included
1075 public function setPrintable() {
1076 $this->mPrintable
= true;
1080 * Return whether the page is "printable"
1084 public function isPrintable() {
1085 return $this->mPrintable
;
1089 * Disable output completely, i.e. calling output() will have no effect
1091 public function disable() {
1092 $this->mDoNothing
= true;
1096 * Return whether the output will be completely disabled
1100 public function isDisabled() {
1101 return $this->mDoNothing
;
1105 * Show an "add new section" link?
1109 public function showNewSectionLink() {
1110 return $this->mNewSectionLink
;
1114 * Forcibly hide the new section link?
1118 public function forceHideNewSectionLink() {
1119 return $this->mHideNewSectionLink
;
1123 * Add or remove feed links in the page header
1124 * This is mainly kept for backward compatibility, see OutputPage::addFeedLink()
1125 * for the new version
1126 * @see addFeedLink()
1128 * @param bool $show True: add default feeds, false: remove all feeds
1130 public function setSyndicated( $show = true ) {
1132 $this->setFeedAppendQuery( false );
1134 $this->mFeedLinks
= [];
1139 * Add default feeds to the page header
1140 * This is mainly kept for backward compatibility, see OutputPage::addFeedLink()
1141 * for the new version
1142 * @see addFeedLink()
1144 * @param string $val Query to append to feed links or false to output
1147 public function setFeedAppendQuery( $val ) {
1148 $this->mFeedLinks
= [];
1150 foreach ( $this->getConfig()->get( 'AdvertisedFeedTypes' ) as $type ) {
1151 $query = "feed=$type";
1152 if ( is_string( $val ) ) {
1153 $query .= '&' . $val;
1155 $this->mFeedLinks
[$type] = $this->getTitle()->getLocalURL( $query );
1160 * Add a feed link to the page header
1162 * @param string $format Feed type, should be a key of $wgFeedClasses
1163 * @param string $href URL
1165 public function addFeedLink( $format, $href ) {
1166 if ( in_array( $format, $this->getConfig()->get( 'AdvertisedFeedTypes' ) ) ) {
1167 $this->mFeedLinks
[$format] = $href;
1172 * Should we output feed links for this page?
1175 public function isSyndicated() {
1176 return count( $this->mFeedLinks
) > 0;
1180 * Return URLs for each supported syndication format for this page.
1181 * @return array Associating format keys with URLs
1183 public function getSyndicationLinks() {
1184 return $this->mFeedLinks
;
1188 * Will currently always return null
1192 public function getFeedAppendQuery() {
1193 return $this->mFeedLinksAppendQuery
;
1197 * Set whether the displayed content is related to the source of the
1198 * corresponding article on the wiki
1199 * Setting true will cause the change "article related" toggle to true
1203 public function setArticleFlag( $v ) {
1204 $this->mIsarticle
= $v;
1206 $this->mIsArticleRelated
= $v;
1211 * Return whether the content displayed page is related to the source of
1212 * the corresponding article on the wiki
1216 public function isArticle() {
1217 return $this->mIsarticle
;
1221 * Set whether this page is related an article on the wiki
1222 * Setting false will cause the change of "article flag" toggle to false
1226 public function setArticleRelated( $v ) {
1227 $this->mIsArticleRelated
= $v;
1229 $this->mIsarticle
= false;
1234 * Return whether this page is related an article on the wiki
1238 public function isArticleRelated() {
1239 return $this->mIsArticleRelated
;
1243 * Add new language links
1245 * @param string[] $newLinkArray Array of interwiki-prefixed (non DB key) titles
1246 * (e.g. 'fr:Test page')
1248 public function addLanguageLinks( array $newLinkArray ) {
1249 $this->mLanguageLinks +
= $newLinkArray;
1253 * Reset the language links and add new language links
1255 * @param string[] $newLinkArray Array of interwiki-prefixed (non DB key) titles
1256 * (e.g. 'fr:Test page')
1258 public function setLanguageLinks( array $newLinkArray ) {
1259 $this->mLanguageLinks
= $newLinkArray;
1263 * Get the list of language links
1265 * @return string[] Array of interwiki-prefixed (non DB key) titles (e.g. 'fr:Test page')
1267 public function getLanguageLinks() {
1268 return $this->mLanguageLinks
;
1272 * Add an array of categories, with names in the keys
1274 * @param array $categories Mapping category name => sort key
1276 public function addCategoryLinks( array $categories ) {
1279 if ( !is_array( $categories ) ||
count( $categories ) == 0 ) {
1283 $res = $this->addCategoryLinksToLBAndGetResult( $categories );
1285 # Set all the values to 'normal'.
1286 $categories = array_fill_keys( array_keys( $categories ), 'normal' );
1288 # Mark hidden categories
1289 foreach ( $res as $row ) {
1290 if ( isset( $row->pp_value
) ) {
1291 $categories[$row->page_title
] = 'hidden';
1295 // Avoid PHP 7.1 warning of passing $this by reference
1296 $outputPage = $this;
1297 # Add the remaining categories to the skin
1299 'OutputPageMakeCategoryLinks',
1300 [ &$outputPage, $categories, &$this->mCategoryLinks
] )
1302 $linkRenderer = MediaWikiServices
::getInstance()->getLinkRenderer();
1303 foreach ( $categories as $category => $type ) {
1304 // array keys will cast numeric category names to ints, so cast back to string
1305 $category = (string)$category;
1306 $origcategory = $category;
1307 $title = Title
::makeTitleSafe( NS_CATEGORY
, $category );
1311 $wgContLang->findVariantLink( $category, $title, true );
1312 if ( $category != $origcategory && array_key_exists( $category, $categories ) ) {
1315 $text = $wgContLang->convertHtml( $title->getText() );
1316 $this->mCategories
[$type][] = $title->getText();
1317 $this->mCategoryLinks
[$type][] = $linkRenderer->makeLink( $title, new HtmlArmor( $text ) );
1323 * @param array $categories
1324 * @return bool|ResultWrapper
1326 protected function addCategoryLinksToLBAndGetResult( array $categories ) {
1327 # Add the links to a LinkBatch
1328 $arr = [ NS_CATEGORY
=> $categories ];
1329 $lb = new LinkBatch
;
1330 $lb->setArray( $arr );
1332 # Fetch existence plus the hiddencat property
1333 $dbr = wfGetDB( DB_REPLICA
);
1334 $fields = array_merge(
1335 LinkCache
::getSelectFields(),
1336 [ 'page_namespace', 'page_title', 'pp_value' ]
1339 $res = $dbr->select( [ 'page', 'page_props' ],
1341 $lb->constructSet( 'page', $dbr ),
1344 [ 'page_props' => [ 'LEFT JOIN', [
1345 'pp_propname' => 'hiddencat',
1350 # Add the results to the link cache
1351 $lb->addResultToCache( LinkCache
::singleton(), $res );
1357 * Reset the category links (but not the category list) and add $categories
1359 * @param array $categories Mapping category name => sort key
1361 public function setCategoryLinks( array $categories ) {
1362 $this->mCategoryLinks
= [];
1363 $this->addCategoryLinks( $categories );
1367 * Get the list of category links, in a 2-D array with the following format:
1368 * $arr[$type][] = $link, where $type is either "normal" or "hidden" (for
1369 * hidden categories) and $link a HTML fragment with a link to the category
1374 public function getCategoryLinks() {
1375 return $this->mCategoryLinks
;
1379 * Get the list of category names this page belongs to.
1381 * @param string $type The type of categories which should be returned. Possible values:
1382 * * all: all categories of all types
1383 * * hidden: only the hidden categories
1384 * * normal: all categories, except hidden categories
1385 * @return array Array of strings
1387 public function getCategories( $type = 'all' ) {
1388 if ( $type === 'all' ) {
1389 $allCategories = [];
1390 foreach ( $this->mCategories
as $categories ) {
1391 $allCategories = array_merge( $allCategories, $categories );
1393 return $allCategories;
1395 if ( !isset( $this->mCategories
[$type] ) ) {
1396 throw new InvalidArgumentException( 'Invalid category type given: ' . $type );
1398 return $this->mCategories
[$type];
1402 * Add an array of indicators, with their identifiers as array
1403 * keys and HTML contents as values.
1405 * In case of duplicate keys, existing values are overwritten.
1407 * @param array $indicators
1410 public function setIndicators( array $indicators ) {
1411 $this->mIndicators
= $indicators +
$this->mIndicators
;
1412 // Keep ordered by key
1413 ksort( $this->mIndicators
);
1417 * Get the indicators associated with this page.
1419 * The array will be internally ordered by item keys.
1421 * @return array Keys: identifiers, values: HTML contents
1424 public function getIndicators() {
1425 return $this->mIndicators
;
1429 * Adds help link with an icon via page indicators.
1430 * Link target can be overridden by a local message containing a wikilink:
1431 * the message key is: lowercase action or special page name + '-helppage'.
1432 * @param string $to Target MediaWiki.org page title or encoded URL.
1433 * @param bool $overrideBaseUrl Whether $url is a full URL, to avoid MW.o.
1436 public function addHelpLink( $to, $overrideBaseUrl = false ) {
1437 $this->addModuleStyles( 'mediawiki.helplink' );
1438 $text = $this->msg( 'helppage-top-gethelp' )->escaped();
1440 if ( $overrideBaseUrl ) {
1443 $toUrlencoded = wfUrlencode( str_replace( ' ', '_', $to ) );
1444 $helpUrl = "//www.mediawiki.org/wiki/Special:MyLanguage/$toUrlencoded";
1447 $link = Html
::rawElement(
1451 'target' => '_blank',
1452 'class' => 'mw-helplink',
1457 $this->setIndicators( [ 'mw-helplink' => $link ] );
1461 * Do not allow scripts which can be modified by wiki users to load on this page;
1462 * only allow scripts bundled with, or generated by, the software.
1463 * Site-wide styles are controlled by a config setting, since they can be
1464 * used to create a custom skin/theme, but not user-specific ones.
1466 * @todo this should be given a more accurate name
1468 public function disallowUserJs() {
1469 $this->reduceAllowedModules(
1470 ResourceLoaderModule
::TYPE_SCRIPTS
,
1471 ResourceLoaderModule
::ORIGIN_CORE_INDIVIDUAL
1474 // Site-wide styles are controlled by a config setting, see T73621
1475 // for background on why. User styles are never allowed.
1476 if ( $this->getConfig()->get( 'AllowSiteCSSOnRestrictedPages' ) ) {
1477 $styleOrigin = ResourceLoaderModule
::ORIGIN_USER_SITEWIDE
;
1479 $styleOrigin = ResourceLoaderModule
::ORIGIN_CORE_INDIVIDUAL
;
1481 $this->reduceAllowedModules(
1482 ResourceLoaderModule
::TYPE_STYLES
,
1488 * Show what level of JavaScript / CSS untrustworthiness is allowed on this page
1489 * @see ResourceLoaderModule::$origin
1490 * @param string $type ResourceLoaderModule TYPE_ constant
1491 * @return int ResourceLoaderModule ORIGIN_ class constant
1493 public function getAllowedModules( $type ) {
1494 if ( $type == ResourceLoaderModule
::TYPE_COMBINED
) {
1495 return min( array_values( $this->mAllowedModules
) );
1497 return isset( $this->mAllowedModules
[$type] )
1498 ?
$this->mAllowedModules
[$type]
1499 : ResourceLoaderModule
::ORIGIN_ALL
;
1504 * Limit the highest level of CSS/JS untrustworthiness allowed.
1506 * If passed the same or a higher level than the current level of untrustworthiness set, the
1507 * level will remain unchanged.
1509 * @param string $type
1510 * @param int $level ResourceLoaderModule class constant
1512 public function reduceAllowedModules( $type, $level ) {
1513 $this->mAllowedModules
[$type] = min( $this->getAllowedModules( $type ), $level );
1517 * Prepend $text to the body HTML
1519 * @param string $text HTML
1521 public function prependHTML( $text ) {
1522 $this->mBodytext
= $text . $this->mBodytext
;
1526 * Append $text to the body HTML
1528 * @param string $text HTML
1530 public function addHTML( $text ) {
1531 $this->mBodytext
.= $text;
1535 * Shortcut for adding an Html::element via addHTML.
1539 * @param string $element
1540 * @param array $attribs
1541 * @param string $contents
1543 public function addElement( $element, array $attribs = [], $contents = '' ) {
1544 $this->addHTML( Html
::element( $element, $attribs, $contents ) );
1548 * Clear the body HTML
1550 public function clearHTML() {
1551 $this->mBodytext
= '';
1557 * @return string HTML
1559 public function getHTML() {
1560 return $this->mBodytext
;
1564 * Get/set the ParserOptions object to use for wikitext parsing
1566 * @param ParserOptions|null $options Either the ParserOption to use or null to only get the
1567 * current ParserOption object
1568 * @return ParserOptions
1570 public function parserOptions( $options = null ) {
1571 if ( $options !== null && !empty( $options->isBogus
) ) {
1572 // Someone is trying to set a bogus pre-$wgUser PO. Check if it has
1573 // been changed somehow, and keep it if so.
1574 $anonPO = ParserOptions
::newFromAnon();
1575 $anonPO->setEditSection( false );
1576 $anonPO->setAllowUnsafeRawHtml( false );
1577 if ( !$options->matches( $anonPO ) ) {
1578 wfLogWarning( __METHOD__
. ': Setting a changed bogus ParserOptions: ' . wfGetAllCallers( 5 ) );
1579 $options->isBogus
= false;
1583 if ( !$this->mParserOptions
) {
1584 if ( !$this->getContext()->getUser()->isSafeToLoad() ) {
1585 // $wgUser isn't unstubbable yet, so don't try to get a
1586 // ParserOptions for it. And don't cache this ParserOptions
1588 $po = ParserOptions
::newFromAnon();
1589 $po->setEditSection( false );
1590 $po->setAllowUnsafeRawHtml( false );
1591 $po->isBogus
= true;
1592 if ( $options !== null ) {
1593 $this->mParserOptions
= empty( $options->isBogus
) ?
$options : null;
1598 $this->mParserOptions
= ParserOptions
::newFromContext( $this->getContext() );
1599 $this->mParserOptions
->setEditSection( false );
1600 $this->mParserOptions
->setAllowUnsafeRawHtml( false );
1603 if ( $options !== null && !empty( $options->isBogus
) ) {
1604 // They're trying to restore the bogus pre-$wgUser PO. Do the right
1606 return wfSetVar( $this->mParserOptions
, null, true );
1608 return wfSetVar( $this->mParserOptions
, $options );
1613 * Set the revision ID which will be seen by the wiki text parser
1614 * for things such as embedded {{REVISIONID}} variable use.
1616 * @param int|null $revid An positive integer, or null
1617 * @return mixed Previous value
1619 public function setRevisionId( $revid ) {
1620 $val = is_null( $revid ) ?
null : intval( $revid );
1621 return wfSetVar( $this->mRevisionId
, $val );
1625 * Get the displayed revision ID
1629 public function getRevisionId() {
1630 return $this->mRevisionId
;
1634 * Set the timestamp of the revision which will be displayed. This is used
1635 * to avoid a extra DB call in Skin::lastModified().
1637 * @param string|null $timestamp
1638 * @return mixed Previous value
1640 public function setRevisionTimestamp( $timestamp ) {
1641 return wfSetVar( $this->mRevisionTimestamp
, $timestamp );
1645 * Get the timestamp of displayed revision.
1646 * This will be null if not filled by setRevisionTimestamp().
1648 * @return string|null
1650 public function getRevisionTimestamp() {
1651 return $this->mRevisionTimestamp
;
1655 * Set the displayed file version
1657 * @param File|bool $file
1658 * @return mixed Previous value
1660 public function setFileVersion( $file ) {
1662 if ( $file instanceof File
&& $file->exists() ) {
1663 $val = [ 'time' => $file->getTimestamp(), 'sha1' => $file->getSha1() ];
1665 return wfSetVar( $this->mFileVersion
, $val, true );
1669 * Get the displayed file version
1671 * @return array|null ('time' => MW timestamp, 'sha1' => sha1)
1673 public function getFileVersion() {
1674 return $this->mFileVersion
;
1678 * Get the templates used on this page
1680 * @return array (namespace => dbKey => revId)
1683 public function getTemplateIds() {
1684 return $this->mTemplateIds
;
1688 * Get the files used on this page
1690 * @return array (dbKey => array('time' => MW timestamp or null, 'sha1' => sha1 or ''))
1693 public function getFileSearchOptions() {
1694 return $this->mImageTimeKeys
;
1698 * Convert wikitext to HTML and add it to the buffer
1699 * Default assumes that the current page title will be used.
1701 * @param string $text
1702 * @param bool $linestart Is this the start of a line?
1703 * @param bool $interface Is this text in the user interface language?
1704 * @throws MWException
1706 public function addWikiText( $text, $linestart = true, $interface = true ) {
1707 $title = $this->getTitle(); // Work around E_STRICT
1709 throw new MWException( 'Title is null' );
1711 $this->addWikiTextTitle( $text, $title, $linestart, /*tidy*/false, $interface );
1715 * Add wikitext with a custom Title object
1717 * @param string $text Wikitext
1718 * @param Title $title
1719 * @param bool $linestart Is this the start of a line?
1721 public function addWikiTextWithTitle( $text, &$title, $linestart = true ) {
1722 $this->addWikiTextTitle( $text, $title, $linestart );
1726 * Add wikitext with a custom Title object and tidy enabled.
1728 * @param string $text Wikitext
1729 * @param Title $title
1730 * @param bool $linestart Is this the start of a line?
1732 function addWikiTextTitleTidy( $text, &$title, $linestart = true ) {
1733 $this->addWikiTextTitle( $text, $title, $linestart, true );
1737 * Add wikitext with tidy enabled
1739 * @param string $text Wikitext
1740 * @param bool $linestart Is this the start of a line?
1742 public function addWikiTextTidy( $text, $linestart = true ) {
1743 $title = $this->getTitle();
1744 $this->addWikiTextTitleTidy( $text, $title, $linestart );
1748 * Add wikitext with a custom Title object
1750 * @param string $text Wikitext
1751 * @param Title $title
1752 * @param bool $linestart Is this the start of a line?
1753 * @param bool $tidy Whether to use tidy
1754 * @param bool $interface Whether it is an interface message
1755 * (for example disables conversion)
1757 public function addWikiTextTitle( $text, Title
$title, $linestart,
1758 $tidy = false, $interface = false
1762 $popts = $this->parserOptions();
1763 $oldTidy = $popts->setTidy( $tidy );
1764 $popts->setInterfaceMessage( (bool)$interface );
1766 $parserOutput = $wgParser->getFreshParser()->parse(
1767 $text, $title, $popts,
1768 $linestart, true, $this->mRevisionId
1771 $popts->setTidy( $oldTidy );
1773 $this->addParserOutput( $parserOutput );
1777 * Add all metadata associated with a ParserOutput object, but without the actual HTML. This
1778 * includes categories, language links, ResourceLoader modules, effects of certain magic words,
1782 * @param ParserOutput $parserOutput
1784 public function addParserOutputMetadata( $parserOutput ) {
1785 $this->mLanguageLinks +
= $parserOutput->getLanguageLinks();
1786 $this->addCategoryLinks( $parserOutput->getCategories() );
1787 $this->setIndicators( $parserOutput->getIndicators() );
1788 $this->mNewSectionLink
= $parserOutput->getNewSection();
1789 $this->mHideNewSectionLink
= $parserOutput->getHideNewSection();
1791 if ( !$parserOutput->isCacheable() ) {
1792 $this->enableClientCache( false );
1794 $this->mNoGallery
= $parserOutput->getNoGallery();
1795 $this->mHeadItems
= array_merge( $this->mHeadItems
, $parserOutput->getHeadItems() );
1796 $this->addModules( $parserOutput->getModules() );
1797 $this->addModuleScripts( $parserOutput->getModuleScripts() );
1798 $this->addModuleStyles( $parserOutput->getModuleStyles() );
1799 $this->addJsConfigVars( $parserOutput->getJsConfigVars() );
1800 $this->mPreventClickjacking
= $this->mPreventClickjacking
1801 ||
$parserOutput->preventClickjacking();
1803 // Template versioning...
1804 foreach ( (array)$parserOutput->getTemplateIds() as $ns => $dbks ) {
1805 if ( isset( $this->mTemplateIds
[$ns] ) ) {
1806 $this->mTemplateIds
[$ns] = $dbks +
$this->mTemplateIds
[$ns];
1808 $this->mTemplateIds
[$ns] = $dbks;
1811 // File versioning...
1812 foreach ( (array)$parserOutput->getFileSearchOptions() as $dbk => $data ) {
1813 $this->mImageTimeKeys
[$dbk] = $data;
1816 // Hooks registered in the object
1817 $parserOutputHooks = $this->getConfig()->get( 'ParserOutputHooks' );
1818 foreach ( $parserOutput->getOutputHooks() as $hookInfo ) {
1819 list( $hookName, $data ) = $hookInfo;
1820 if ( isset( $parserOutputHooks[$hookName] ) ) {
1821 call_user_func( $parserOutputHooks[$hookName], $this, $parserOutput, $data );
1825 // Enable OOUI if requested via ParserOutput
1826 if ( $parserOutput->getEnableOOUI() ) {
1827 $this->enableOOUI();
1830 // Include parser limit report
1831 if ( !$this->limitReportJSData
) {
1832 $this->limitReportJSData
= $parserOutput->getLimitReportJSData();
1835 // Link flags are ignored for now, but may in the future be
1836 // used to mark individual language links.
1838 // Avoid PHP 7.1 warning of passing $this by reference
1839 $outputPage = $this;
1840 Hooks
::run( 'LanguageLinks', [ $this->getTitle(), &$this->mLanguageLinks
, &$linkFlags ] );
1841 Hooks
::run( 'OutputPageParserOutput', [ &$outputPage, $parserOutput ] );
1843 // This check must be after 'OutputPageParserOutput' runs in addParserOutputMetadata
1844 // so that extensions may modify ParserOutput to toggle TOC.
1845 // This cannot be moved to addParserOutputText because that is not
1846 // called by EditPage for Preview.
1847 if ( $parserOutput->getTOCEnabled() && $parserOutput->getTOCHTML() ) {
1848 $this->mEnableTOC
= true;
1853 * Add the HTML and enhancements for it (like ResourceLoader modules) associated with a
1854 * ParserOutput object, without any other metadata.
1857 * @param ParserOutput $parserOutput
1859 public function addParserOutputContent( $parserOutput ) {
1860 $this->addParserOutputText( $parserOutput );
1862 $this->addModules( $parserOutput->getModules() );
1863 $this->addModuleScripts( $parserOutput->getModuleScripts() );
1864 $this->addModuleStyles( $parserOutput->getModuleStyles() );
1866 $this->addJsConfigVars( $parserOutput->getJsConfigVars() );
1870 * Add the HTML associated with a ParserOutput object, without any metadata.
1873 * @param ParserOutput $parserOutput
1875 public function addParserOutputText( $parserOutput ) {
1876 $text = $parserOutput->getText();
1877 // Avoid PHP 7.1 warning of passing $this by reference
1878 $outputPage = $this;
1879 Hooks
::run( 'OutputPageBeforeHTML', [ &$outputPage, &$text ] );
1880 $this->addHTML( $text );
1884 * Add everything from a ParserOutput object.
1886 * @param ParserOutput $parserOutput
1888 function addParserOutput( $parserOutput ) {
1889 $this->addParserOutputMetadata( $parserOutput );
1891 // Touch section edit links only if not previously disabled
1892 if ( $parserOutput->getEditSectionTokens() ) {
1893 $parserOutput->setEditSectionTokens( $this->mEnableSectionEditLinks
);
1896 $this->addParserOutputText( $parserOutput );
1900 * Add the output of a QuickTemplate to the output buffer
1902 * @param QuickTemplate $template
1904 public function addTemplate( &$template ) {
1905 $this->addHTML( $template->getHTML() );
1909 * Parse wikitext and return the HTML.
1911 * @param string $text
1912 * @param bool $linestart Is this the start of a line?
1913 * @param bool $interface Use interface language ($wgLang instead of
1914 * $wgContLang) while parsing language sensitive magic words like GRAMMAR and PLURAL.
1915 * This also disables LanguageConverter.
1916 * @param Language $language Target language object, will override $interface
1917 * @throws MWException
1918 * @return string HTML
1920 public function parse( $text, $linestart = true, $interface = false, $language = null ) {
1923 if ( is_null( $this->getTitle() ) ) {
1924 throw new MWException( 'Empty $mTitle in ' . __METHOD__
);
1927 $popts = $this->parserOptions();
1929 $popts->setInterfaceMessage( true );
1931 if ( $language !== null ) {
1932 $oldLang = $popts->setTargetLanguage( $language );
1935 $parserOutput = $wgParser->getFreshParser()->parse(
1936 $text, $this->getTitle(), $popts,
1937 $linestart, true, $this->mRevisionId
1941 $popts->setInterfaceMessage( false );
1943 if ( $language !== null ) {
1944 $popts->setTargetLanguage( $oldLang );
1947 return $parserOutput->getText();
1951 * Parse wikitext, strip paragraphs, and return the HTML.
1953 * @param string $text
1954 * @param bool $linestart Is this the start of a line?
1955 * @param bool $interface Use interface language ($wgLang instead of
1956 * $wgContLang) while parsing language sensitive magic
1957 * words like GRAMMAR and PLURAL
1958 * @return string HTML
1960 public function parseInline( $text, $linestart = true, $interface = false ) {
1961 $parsed = $this->parse( $text, $linestart, $interface );
1962 return Parser
::stripOuterParagraph( $parsed );
1967 * @deprecated since 1.27 Use setCdnMaxage() instead
1969 public function setSquidMaxage( $maxage ) {
1970 $this->setCdnMaxage( $maxage );
1974 * Set the value of the "s-maxage" part of the "Cache-control" HTTP header
1976 * @param int $maxage Maximum cache time on the CDN, in seconds.
1978 public function setCdnMaxage( $maxage ) {
1979 $this->mCdnMaxage
= min( $maxage, $this->mCdnMaxageLimit
);
1983 * Lower the value of the "s-maxage" part of the "Cache-control" HTTP header
1985 * @param int $maxage Maximum cache time on the CDN, in seconds
1988 public function lowerCdnMaxage( $maxage ) {
1989 $this->mCdnMaxageLimit
= min( $maxage, $this->mCdnMaxageLimit
);
1990 $this->setCdnMaxage( $this->mCdnMaxage
);
1994 * Get TTL in [$minTTL,$maxTTL] in pass it to lowerCdnMaxage()
1996 * This sets and returns $minTTL if $mtime is false or null. Otherwise,
1997 * the TTL is higher the older the $mtime timestamp is. Essentially, the
1998 * TTL is 90% of the age of the object, subject to the min and max.
2000 * @param string|integer|float|bool|null $mtime Last-Modified timestamp
2001 * @param integer $minTTL Mimimum TTL in seconds [default: 1 minute]
2002 * @param integer $maxTTL Maximum TTL in seconds [default: $wgSquidMaxage]
2003 * @return integer TTL in seconds
2006 public function adaptCdnTTL( $mtime, $minTTL = 0, $maxTTL = 0 ) {
2007 $minTTL = $minTTL ?
: IExpiringStore
::TTL_MINUTE
;
2008 $maxTTL = $maxTTL ?
: $this->getConfig()->get( 'SquidMaxage' );
2010 if ( $mtime === null ||
$mtime === false ) {
2011 return $minTTL; // entity does not exist
2014 $age = time() - wfTimestamp( TS_UNIX
, $mtime );
2015 $adaptiveTTL = max( .9 * $age, $minTTL );
2016 $adaptiveTTL = min( $adaptiveTTL, $maxTTL );
2018 $this->lowerCdnMaxage( (int)$adaptiveTTL );
2020 return $adaptiveTTL;
2024 * Use enableClientCache(false) to force it to send nocache headers
2026 * @param bool $state
2030 public function enableClientCache( $state ) {
2031 return wfSetVar( $this->mEnableClientCache
, $state );
2035 * Get the list of cookies that will influence on the cache
2039 function getCacheVaryCookies() {
2041 if ( $cookies === null ) {
2042 $config = $this->getConfig();
2043 $cookies = array_merge(
2044 SessionManager
::singleton()->getVaryCookies(),
2048 $config->get( 'CacheVaryCookies' )
2050 Hooks
::run( 'GetCacheVaryCookies', [ $this, &$cookies ] );
2056 * Check if the request has a cache-varying cookie header
2057 * If it does, it's very important that we don't allow public caching
2061 function haveCacheVaryCookies() {
2062 $request = $this->getRequest();
2063 foreach ( $this->getCacheVaryCookies() as $cookieName ) {
2064 if ( $request->getCookie( $cookieName, '', '' ) !== '' ) {
2065 wfDebug( __METHOD__
. ": found $cookieName\n" );
2069 wfDebug( __METHOD__
. ": no cache-varying cookies found\n" );
2074 * Add an HTTP header that will influence on the cache
2076 * @param string $header Header name
2077 * @param string[]|null $option Options for the Key header. See
2078 * https://datatracker.ietf.org/doc/draft-fielding-http-key/
2079 * for the list of valid options.
2081 public function addVaryHeader( $header, array $option = null ) {
2082 if ( !array_key_exists( $header, $this->mVaryHeader
) ) {
2083 $this->mVaryHeader
[$header] = [];
2085 if ( !is_array( $option ) ) {
2088 $this->mVaryHeader
[$header] = array_unique( array_merge( $this->mVaryHeader
[$header], $option ) );
2092 * Return a Vary: header on which to vary caches. Based on the keys of $mVaryHeader,
2093 * such as Accept-Encoding or Cookie
2097 public function getVaryHeader() {
2098 // If we vary on cookies, let's make sure it's always included here too.
2099 if ( $this->getCacheVaryCookies() ) {
2100 $this->addVaryHeader( 'Cookie' );
2103 foreach ( SessionManager
::singleton()->getVaryHeaders() as $header => $options ) {
2104 $this->addVaryHeader( $header, $options );
2106 return 'Vary: ' . implode( ', ', array_keys( $this->mVaryHeader
) );
2110 * Add an HTTP Link: header
2112 * @param string $header Header value
2114 public function addLinkHeader( $header ) {
2115 $this->mLinkHeader
[] = $header;
2119 * Return a Link: header. Based on the values of $mLinkHeader.
2123 public function getLinkHeader() {
2124 if ( !$this->mLinkHeader
) {
2128 return 'Link: ' . implode( ',', $this->mLinkHeader
);
2132 * Get a complete Key header
2136 public function getKeyHeader() {
2137 $cvCookies = $this->getCacheVaryCookies();
2139 $cookiesOption = [];
2140 foreach ( $cvCookies as $cookieName ) {
2141 $cookiesOption[] = 'param=' . $cookieName;
2143 $this->addVaryHeader( 'Cookie', $cookiesOption );
2145 foreach ( SessionManager
::singleton()->getVaryHeaders() as $header => $options ) {
2146 $this->addVaryHeader( $header, $options );
2150 foreach ( $this->mVaryHeader
as $header => $option ) {
2151 $newheader = $header;
2152 if ( is_array( $option ) && count( $option ) > 0 ) {
2153 $newheader .= ';' . implode( ';', $option );
2155 $headers[] = $newheader;
2157 $key = 'Key: ' . implode( ',', $headers );
2163 * T23672: Add Accept-Language to Vary and Key headers
2164 * if there's no 'variant' parameter existed in GET.
2167 * /w/index.php?title=Main_page should always be served; but
2168 * /w/index.php?title=Main_page&variant=zh-cn should never be served.
2170 function addAcceptLanguage() {
2171 $title = $this->getTitle();
2172 if ( !$title instanceof Title
) {
2176 $lang = $title->getPageLanguage();
2177 if ( !$this->getRequest()->getCheck( 'variant' ) && $lang->hasVariants() ) {
2178 $variants = $lang->getVariants();
2180 foreach ( $variants as $variant ) {
2181 if ( $variant === $lang->getCode() ) {
2184 $aloption[] = 'substr=' . $variant;
2186 // IE and some other browsers use BCP 47 standards in
2187 // their Accept-Language header, like "zh-CN" or "zh-Hant".
2188 // We should handle these too.
2189 $variantBCP47 = wfBCP47( $variant );
2190 if ( $variantBCP47 !== $variant ) {
2191 $aloption[] = 'substr=' . $variantBCP47;
2195 $this->addVaryHeader( 'Accept-Language', $aloption );
2200 * Set a flag which will cause an X-Frame-Options header appropriate for
2201 * edit pages to be sent. The header value is controlled by
2202 * $wgEditPageFrameOptions.
2204 * This is the default for special pages. If you display a CSRF-protected
2205 * form on an ordinary view page, then you need to call this function.
2207 * @param bool $enable
2209 public function preventClickjacking( $enable = true ) {
2210 $this->mPreventClickjacking
= $enable;
2214 * Turn off frame-breaking. Alias for $this->preventClickjacking(false).
2215 * This can be called from pages which do not contain any CSRF-protected
2218 public function allowClickjacking() {
2219 $this->mPreventClickjacking
= false;
2223 * Get the prevent-clickjacking flag
2228 public function getPreventClickjacking() {
2229 return $this->mPreventClickjacking
;
2233 * Get the X-Frame-Options header value (without the name part), or false
2234 * if there isn't one. This is used by Skin to determine whether to enable
2235 * JavaScript frame-breaking, for clients that don't support X-Frame-Options.
2237 * @return string|false
2239 public function getFrameOptions() {
2240 $config = $this->getConfig();
2241 if ( $config->get( 'BreakFrames' ) ) {
2243 } elseif ( $this->mPreventClickjacking
&& $config->get( 'EditPageFrameOptions' ) ) {
2244 return $config->get( 'EditPageFrameOptions' );
2250 * Send cache control HTTP headers
2252 public function sendCacheControl() {
2253 $response = $this->getRequest()->response();
2254 $config = $this->getConfig();
2256 $this->addVaryHeader( 'Cookie' );
2257 $this->addAcceptLanguage();
2259 # don't serve compressed data to clients who can't handle it
2260 # maintain different caches for logged-in users and non-logged in ones
2261 $response->header( $this->getVaryHeader() );
2263 if ( $config->get( 'UseKeyHeader' ) ) {
2264 $response->header( $this->getKeyHeader() );
2267 if ( $this->mEnableClientCache
) {
2269 $config->get( 'UseSquid' ) &&
2270 !$response->hasCookies() &&
2271 !SessionManager
::getGlobalSession()->isPersistent() &&
2272 !$this->isPrintable() &&
2273 $this->mCdnMaxage
!= 0 &&
2274 !$this->haveCacheVaryCookies()
2276 if ( $config->get( 'UseESI' ) ) {
2277 # We'll purge the proxy cache explicitly, but require end user agents
2278 # to revalidate against the proxy on each visit.
2279 # Surrogate-Control controls our CDN, Cache-Control downstream caches
2280 wfDebug( __METHOD__
.
2281 ": proxy caching with ESI; {$this->mLastModified} **", 'private' );
2282 # start with a shorter timeout for initial testing
2283 # header( 'Surrogate-Control: max-age=2678400+2678400, content="ESI/1.0"');
2285 "Surrogate-Control: max-age={$config->get( 'SquidMaxage' )}" .
2286 "+{$this->mCdnMaxage}, content=\"ESI/1.0\""
2288 $response->header( 'Cache-Control: s-maxage=0, must-revalidate, max-age=0' );
2290 # We'll purge the proxy cache for anons explicitly, but require end user agents
2291 # to revalidate against the proxy on each visit.
2292 # IMPORTANT! The CDN needs to replace the Cache-Control header with
2293 # Cache-Control: s-maxage=0, must-revalidate, max-age=0
2294 wfDebug( __METHOD__
.
2295 ": local proxy caching; {$this->mLastModified} **", 'private' );
2296 # start with a shorter timeout for initial testing
2297 # header( "Cache-Control: s-maxage=2678400, must-revalidate, max-age=0" );
2298 $response->header( "Cache-Control: " .
2299 "s-maxage={$this->mCdnMaxage}, must-revalidate, max-age=0" );
2302 # We do want clients to cache if they can, but they *must* check for updates
2303 # on revisiting the page.
2304 wfDebug( __METHOD__
. ": private caching; {$this->mLastModified} **", 'private' );
2305 $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
2306 $response->header( "Cache-Control: private, must-revalidate, max-age=0" );
2308 if ( $this->mLastModified
) {
2309 $response->header( "Last-Modified: {$this->mLastModified}" );
2312 wfDebug( __METHOD__
. ": no caching **", 'private' );
2314 # In general, the absence of a last modified header should be enough to prevent
2315 # the client from using its cache. We send a few other things just to make sure.
2316 $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
2317 $response->header( 'Cache-Control: no-cache, no-store, max-age=0, must-revalidate' );
2318 $response->header( 'Pragma: no-cache' );
2323 * Finally, all the text has been munged and accumulated into
2324 * the object, let's actually output it:
2326 * @param bool $return Set to true to get the result as a string rather than sending it
2327 * @return string|null
2329 * @throws FatalError
2330 * @throws MWException
2332 public function output( $return = false ) {
2335 if ( $this->mDoNothing
) {
2336 return $return ?
'' : null;
2339 $response = $this->getRequest()->response();
2340 $config = $this->getConfig();
2342 if ( $this->mRedirect
!= '' ) {
2343 # Standards require redirect URLs to be absolute
2344 $this->mRedirect
= wfExpandUrl( $this->mRedirect
, PROTO_CURRENT
);
2346 $redirect = $this->mRedirect
;
2347 $code = $this->mRedirectCode
;
2349 if ( Hooks
::run( "BeforePageRedirect", [ $this, &$redirect, &$code ] ) ) {
2350 if ( $code == '301' ||
$code == '303' ) {
2351 if ( !$config->get( 'DebugRedirects' ) ) {
2352 $response->statusHeader( $code );
2354 $this->mLastModified
= wfTimestamp( TS_RFC2822
);
2356 if ( $config->get( 'VaryOnXFP' ) ) {
2357 $this->addVaryHeader( 'X-Forwarded-Proto' );
2359 $this->sendCacheControl();
2361 $response->header( "Content-Type: text/html; charset=utf-8" );
2362 if ( $config->get( 'DebugRedirects' ) ) {
2363 $url = htmlspecialchars( $redirect );
2364 print "<!DOCTYPE html>\n<html>\n<head>\n<title>Redirect</title>\n</head>\n<body>\n";
2365 print "<p>Location: <a href=\"$url\">$url</a></p>\n";
2366 print "</body>\n</html>\n";
2368 $response->header( 'Location: ' . $redirect );
2372 return $return ?
'' : null;
2373 } elseif ( $this->mStatusCode
) {
2374 $response->statusHeader( $this->mStatusCode
);
2377 # Buffer output; final headers may depend on later processing
2380 $response->header( 'Content-type: ' . $config->get( 'MimeType' ) . '; charset=UTF-8' );
2381 $response->header( 'Content-language: ' . $wgContLang->getHtmlCode() );
2383 // Avoid Internet Explorer "compatibility view" in IE 8-10, so that
2384 // jQuery etc. can work correctly.
2385 $response->header( 'X-UA-Compatible: IE=Edge' );
2387 if ( !$this->mArticleBodyOnly
) {
2388 $sk = $this->getSkin();
2390 if ( $sk->shouldPreloadLogo() ) {
2391 $this->addLogoPreloadLinkHeaders();
2395 $linkHeader = $this->getLinkHeader();
2396 if ( $linkHeader ) {
2397 $response->header( $linkHeader );
2400 // Prevent framing, if requested
2401 $frameOptions = $this->getFrameOptions();
2402 if ( $frameOptions ) {
2403 $response->header( "X-Frame-Options: $frameOptions" );
2406 if ( $this->mArticleBodyOnly
) {
2407 echo $this->mBodytext
;
2409 // Enable safe mode if requested
2410 if ( $this->getRequest()->getBool( 'safemode' ) ) {
2411 $this->disallowUserJs();
2414 $sk = $this->getSkin();
2415 foreach ( $sk->getDefaultModules() as $group ) {
2416 $this->addModules( $group );
2419 MWDebug
::addModules( $this );
2421 // Avoid PHP 7.1 warning of passing $this by reference
2422 $outputPage = $this;
2423 // Hook that allows last minute changes to the output page, e.g.
2424 // adding of CSS or Javascript by extensions.
2425 Hooks
::run( 'BeforePageDisplay', [ &$outputPage, &$sk ] );
2429 } catch ( Exception
$e ) {
2430 ob_end_clean(); // bug T129657
2436 // This hook allows last minute changes to final overall output by modifying output buffer
2437 Hooks
::run( 'AfterFinalPageOutput', [ $this ] );
2438 } catch ( Exception
$e ) {
2439 ob_end_clean(); // bug T129657
2443 $this->sendCacheControl();
2446 return ob_get_clean();
2454 * Prepare this object to display an error page; disable caching and
2455 * indexing, clear the current text and redirect, set the page's title
2456 * and optionally an custom HTML title (content of the "<title>" tag).
2458 * @param string|Message $pageTitle Will be passed directly to setPageTitle()
2459 * @param string|Message $htmlTitle Will be passed directly to setHTMLTitle();
2460 * optional, if not passed the "<title>" attribute will be
2461 * based on $pageTitle
2463 public function prepareErrorPage( $pageTitle, $htmlTitle = false ) {
2464 $this->setPageTitle( $pageTitle );
2465 if ( $htmlTitle !== false ) {
2466 $this->setHTMLTitle( $htmlTitle );
2468 $this->setRobotPolicy( 'noindex,nofollow' );
2469 $this->setArticleRelated( false );
2470 $this->enableClientCache( false );
2471 $this->mRedirect
= '';
2472 $this->clearSubtitle();
2477 * Output a standard error page
2479 * showErrorPage( 'titlemsg', 'pagetextmsg' );
2480 * showErrorPage( 'titlemsg', 'pagetextmsg', [ 'param1', 'param2' ] );
2481 * showErrorPage( 'titlemsg', $messageObject );
2482 * showErrorPage( $titleMessageObject, $messageObject );
2484 * @param string|Message $title Message key (string) for page title, or a Message object
2485 * @param string|Message $msg Message key (string) for page text, or a Message object
2486 * @param array $params Message parameters; ignored if $msg is a Message object
2488 public function showErrorPage( $title, $msg, $params = [] ) {
2489 if ( !$title instanceof Message
) {
2490 $title = $this->msg( $title );
2493 $this->prepareErrorPage( $title );
2495 if ( $msg instanceof Message
) {
2496 if ( $params !== [] ) {
2497 trigger_error( 'Argument ignored: $params. The message parameters argument '
2498 . 'is discarded when the $msg argument is a Message object instead of '
2499 . 'a string.', E_USER_NOTICE
);
2501 $this->addHTML( $msg->parseAsBlock() );
2503 $this->addWikiMsgArray( $msg, $params );
2506 $this->returnToMain();
2510 * Output a standard permission error page
2512 * @param array $errors Error message keys or [key, param...] arrays
2513 * @param string $action Action that was denied or null if unknown
2515 public function showPermissionsErrorPage( array $errors, $action = null ) {
2516 foreach ( $errors as $key => $error ) {
2517 $errors[$key] = (array)$error;
2520 // For some action (read, edit, create and upload), display a "login to do this action"
2521 // error if all of the following conditions are met:
2522 // 1. the user is not logged in
2523 // 2. the only error is insufficient permissions (i.e. no block or something else)
2524 // 3. the error can be avoided simply by logging in
2525 if ( in_array( $action, [ 'read', 'edit', 'createpage', 'createtalk', 'upload' ] )
2526 && $this->getUser()->isAnon() && count( $errors ) == 1 && isset( $errors[0][0] )
2527 && ( $errors[0][0] == 'badaccess-groups' ||
$errors[0][0] == 'badaccess-group0' )
2528 && ( User
::groupHasPermission( 'user', $action )
2529 || User
::groupHasPermission( 'autoconfirmed', $action ) )
2531 $displayReturnto = null;
2533 # Due to T34276, if a user does not have read permissions,
2534 # $this->getTitle() will just give Special:Badtitle, which is
2535 # not especially useful as a returnto parameter. Use the title
2536 # from the request instead, if there was one.
2537 $request = $this->getRequest();
2538 $returnto = Title
::newFromText( $request->getVal( 'title', '' ) );
2539 if ( $action == 'edit' ) {
2540 $msg = 'whitelistedittext';
2541 $displayReturnto = $returnto;
2542 } elseif ( $action == 'createpage' ||
$action == 'createtalk' ) {
2543 $msg = 'nocreatetext';
2544 } elseif ( $action == 'upload' ) {
2545 $msg = 'uploadnologintext';
2547 $msg = 'loginreqpagetext';
2548 $displayReturnto = Title
::newMainPage();
2554 $query['returnto'] = $returnto->getPrefixedText();
2556 if ( !$request->wasPosted() ) {
2557 $returntoquery = $request->getValues();
2558 unset( $returntoquery['title'] );
2559 unset( $returntoquery['returnto'] );
2560 unset( $returntoquery['returntoquery'] );
2561 $query['returntoquery'] = wfArrayToCgi( $returntoquery );
2564 $linkRenderer = MediaWikiServices
::getInstance()->getLinkRenderer();
2565 $loginLink = $linkRenderer->makeKnownLink(
2566 SpecialPage
::getTitleFor( 'Userlogin' ),
2567 $this->msg( 'loginreqlink' )->text(),
2572 $this->prepareErrorPage( $this->msg( 'loginreqtitle' ) );
2573 $this->addHTML( $this->msg( $msg )->rawParams( $loginLink )->parse() );
2575 # Don't return to a page the user can't read otherwise
2576 # we'll end up in a pointless loop
2577 if ( $displayReturnto && $displayReturnto->userCan( 'read', $this->getUser() ) ) {
2578 $this->returnToMain( null, $displayReturnto );
2581 $this->prepareErrorPage( $this->msg( 'permissionserrors' ) );
2582 $this->addWikiText( $this->formatPermissionsErrorMessage( $errors, $action ) );
2587 * Display an error page indicating that a given version of MediaWiki is
2588 * required to use it
2590 * @param mixed $version The version of MediaWiki needed to use the page
2592 public function versionRequired( $version ) {
2593 $this->prepareErrorPage( $this->msg( 'versionrequired', $version ) );
2595 $this->addWikiMsg( 'versionrequiredtext', $version );
2596 $this->returnToMain();
2600 * Format a list of error messages
2602 * @param array $errors Array of arrays returned by Title::getUserPermissionsErrors
2603 * @param string $action Action that was denied or null if unknown
2604 * @return string The wikitext error-messages, formatted into a list.
2606 public function formatPermissionsErrorMessage( array $errors, $action = null ) {
2607 if ( $action == null ) {
2608 $text = $this->msg( 'permissionserrorstext', count( $errors ) )->plain() . "\n\n";
2610 $action_desc = $this->msg( "action-$action" )->plain();
2612 'permissionserrorstext-withaction',
2615 )->plain() . "\n\n";
2618 if ( count( $errors ) > 1 ) {
2619 $text .= '<ul class="permissions-errors">' . "\n";
2621 foreach ( $errors as $error ) {
2623 $text .= call_user_func_array( [ $this, 'msg' ], $error )->plain();
2628 $text .= "<div class=\"permissions-errors\">\n" .
2629 call_user_func_array( [ $this, 'msg' ], reset( $errors ) )->plain() .
2637 * Display a page stating that the Wiki is in read-only mode.
2638 * Should only be called after wfReadOnly() has returned true.
2640 * Historically, this function was used to show the source of the page that the user
2641 * was trying to edit and _also_ permissions error messages. The relevant code was
2642 * moved into EditPage in 1.19 (r102024 / d83c2a431c2a) and removed here in 1.25.
2644 * @deprecated since 1.25; throw the exception directly
2645 * @throws ReadOnlyError
2647 public function readOnlyPage() {
2648 if ( func_num_args() > 0 ) {
2649 throw new MWException( __METHOD__
. ' no longer accepts arguments since 1.25.' );
2652 throw new ReadOnlyError
;
2656 * Turn off regular page output and return an error response
2657 * for when rate limiting has triggered.
2659 * @deprecated since 1.25; throw the exception directly
2661 public function rateLimited() {
2662 wfDeprecated( __METHOD__
, '1.25' );
2663 throw new ThrottledError
;
2667 * Show a warning about replica DB lag
2669 * If the lag is higher than $wgSlaveLagCritical seconds,
2670 * then the warning is a bit more obvious. If the lag is
2671 * lower than $wgSlaveLagWarning, then no warning is shown.
2673 * @param int $lag Slave lag
2675 public function showLagWarning( $lag ) {
2676 $config = $this->getConfig();
2677 if ( $lag >= $config->get( 'SlaveLagWarning' ) ) {
2678 $lag = floor( $lag ); // floor to avoid nano seconds to display
2679 $message = $lag < $config->get( 'SlaveLagCritical' )
2682 $wrap = Html
::rawElement( 'div', [ 'class' => "mw-{$message}" ], "\n$1\n" );
2683 $this->wrapWikiMsg( "$wrap\n", [ $message, $this->getLanguage()->formatNum( $lag ) ] );
2687 public function showFatalError( $message ) {
2688 $this->prepareErrorPage( $this->msg( 'internalerror' ) );
2690 $this->addHTML( $message );
2693 public function showUnexpectedValueError( $name, $val ) {
2694 $this->showFatalError( $this->msg( 'unexpected', $name, $val )->text() );
2697 public function showFileCopyError( $old, $new ) {
2698 $this->showFatalError( $this->msg( 'filecopyerror', $old, $new )->text() );
2701 public function showFileRenameError( $old, $new ) {
2702 $this->showFatalError( $this->msg( 'filerenameerror', $old, $new )->text() );
2705 public function showFileDeleteError( $name ) {
2706 $this->showFatalError( $this->msg( 'filedeleteerror', $name )->text() );
2709 public function showFileNotFoundError( $name ) {
2710 $this->showFatalError( $this->msg( 'filenotfound', $name )->text() );
2714 * Add a "return to" link pointing to a specified title
2716 * @param Title $title Title to link
2717 * @param array $query Query string parameters
2718 * @param string $text Text of the link (input is not escaped)
2719 * @param array $options Options array to pass to Linker
2721 public function addReturnTo( $title, array $query = [], $text = null, $options = [] ) {
2722 $linkRenderer = MediaWikiServices
::getInstance()
2723 ->getLinkRendererFactory()->createFromLegacyOptions( $options );
2724 $link = $this->msg( 'returnto' )->rawParams(
2725 $linkRenderer->makeLink( $title, $text, [], $query ) )->escaped();
2726 $this->addHTML( "<p id=\"mw-returnto\">{$link}</p>\n" );
2730 * Add a "return to" link pointing to a specified title,
2731 * or the title indicated in the request, or else the main page
2733 * @param mixed $unused
2734 * @param Title|string $returnto Title or String to return to
2735 * @param string $returntoquery Query string for the return to link
2737 public function returnToMain( $unused = null, $returnto = null, $returntoquery = null ) {
2738 if ( $returnto == null ) {
2739 $returnto = $this->getRequest()->getText( 'returnto' );
2742 if ( $returntoquery == null ) {
2743 $returntoquery = $this->getRequest()->getText( 'returntoquery' );
2746 if ( $returnto === '' ) {
2747 $returnto = Title
::newMainPage();
2750 if ( is_object( $returnto ) ) {
2751 $titleObj = $returnto;
2753 $titleObj = Title
::newFromText( $returnto );
2755 // We don't want people to return to external interwiki. That
2756 // might potentially be used as part of a phishing scheme
2757 if ( !is_object( $titleObj ) ||
$titleObj->isExternal() ) {
2758 $titleObj = Title
::newMainPage();
2761 $this->addReturnTo( $titleObj, wfCgiToArray( $returntoquery ) );
2764 private function getRlClientContext() {
2765 if ( !$this->rlClientContext
) {
2766 $query = ResourceLoader
::makeLoaderQuery(
2767 [], // modules; not relevant
2768 $this->getLanguage()->getCode(),
2769 $this->getSkin()->getSkinName(),
2770 $this->getUser()->isLoggedIn() ?
$this->getUser()->getName() : null,
2771 null, // version; not relevant
2772 ResourceLoader
::inDebugMode(),
2773 null, // only; not relevant
2774 $this->isPrintable(),
2775 $this->getRequest()->getBool( 'handheld' )
2777 $this->rlClientContext
= new ResourceLoaderContext(
2778 $this->getResourceLoader(),
2779 new FauxRequest( $query )
2782 return $this->rlClientContext
;
2786 * Call this to freeze the module queue and JS config and create a formatter.
2788 * Depending on the Skin, this may get lazy-initialised in either headElement() or
2789 * getBottomScripts(). See SkinTemplate::prepareQuickTemplate(). Calling this too early may
2790 * cause unexpected side-effects since disallowUserJs() may be called at any time to change
2791 * the module filters retroactively. Skins and extension hooks may also add modules until very
2792 * late in the request lifecycle.
2794 * @return ResourceLoaderClientHtml
2796 public function getRlClient() {
2797 if ( !$this->rlClient
) {
2798 $context = $this->getRlClientContext();
2799 $rl = $this->getResourceLoader();
2800 $this->addModules( [
2804 $this->addModuleStyles( [
2809 $this->getSkin()->setupSkinUserCss( $this );
2811 // Prepare exempt modules for buildExemptModules()
2812 $exemptGroups = [ 'site' => [], 'noscript' => [], 'private' => [], 'user' => [] ];
2814 $moduleStyles = $this->getModuleStyles( /*filter*/ true );
2816 // Preload getTitleInfo for isKnownEmpty calls below and in ResourceLoaderClientHtml
2817 // Separate user-specific batch for improved cache-hit ratio.
2818 $userBatch = [ 'user.styles', 'user' ];
2819 $siteBatch = array_diff( $moduleStyles, $userBatch );
2820 $dbr = wfGetDB( DB_REPLICA
);
2821 ResourceLoaderWikiModule
::preloadTitleInfo( $context, $dbr, $siteBatch );
2822 ResourceLoaderWikiModule
::preloadTitleInfo( $context, $dbr, $userBatch );
2824 // Filter out modules handled by buildExemptModules()
2825 $moduleStyles = array_filter( $moduleStyles,
2826 function ( $name ) use ( $rl, $context, &$exemptGroups, &$exemptStates ) {
2827 $module = $rl->getModule( $name );
2829 if ( $name === 'user.styles' && $this->isUserCssPreview() ) {
2830 $exemptStates[$name] = 'ready';
2831 // Special case in buildExemptModules()
2834 $group = $module->getGroup();
2835 if ( isset( $exemptGroups[$group] ) ) {
2836 $exemptStates[$name] = 'ready';
2837 if ( !$module->isKnownEmpty( $context ) ) {
2838 // E.g. Don't output empty <styles>
2839 $exemptGroups[$group][] = $name;
2847 $this->rlExemptStyleModules
= $exemptGroups;
2849 $isUserModuleFiltered = !$this->filterModules( [ 'user' ] );
2850 // If this page filters out 'user', makeResourceLoaderLink will drop it.
2851 // Avoid indefinite "loading" state or untrue "ready" state (T145368).
2852 if ( !$isUserModuleFiltered ) {
2853 // Manually handled by getBottomScripts()
2854 $userModule = $rl->getModule( 'user' );
2855 $userState = $userModule->isKnownEmpty( $context ) && !$this->isUserJsPreview()
2858 $this->rlUserModuleState
= $exemptStates['user'] = $userState;
2861 $rlClient = new ResourceLoaderClientHtml( $context, $this->getTarget() );
2862 $rlClient->setConfig( $this->getJSVars() );
2863 $rlClient->setModules( $this->getModules( /*filter*/ true ) );
2864 $rlClient->setModuleStyles( $moduleStyles );
2865 $rlClient->setModuleScripts( $this->getModuleScripts( /*filter*/ true ) );
2866 $rlClient->setExemptStates( $exemptStates );
2867 $this->rlClient
= $rlClient;
2869 return $this->rlClient
;
2873 * @param Skin $sk The given Skin
2874 * @param bool $includeStyle Unused
2875 * @return string The doctype, opening "<html>", and head element.
2877 public function headElement( Skin
$sk, $includeStyle = true ) {
2880 $userdir = $this->getLanguage()->getDir();
2881 $sitedir = $wgContLang->getDir();
2884 $pieces[] = Html
::htmlHeader( Sanitizer
::mergeAttributes(
2885 $this->getRlClient()->getDocumentAttributes(),
2886 $sk->getHtmlElementAttributes()
2888 $pieces[] = Html
::openElement( 'head' );
2890 if ( $this->getHTMLTitle() == '' ) {
2891 $this->setHTMLTitle( $this->msg( 'pagetitle', $this->getPageTitle() )->inContentLanguage() );
2894 if ( !Html
::isXmlMimeType( $this->getConfig()->get( 'MimeType' ) ) ) {
2895 // Add <meta charset="UTF-8">
2896 // This should be before <title> since it defines the charset used by
2897 // text including the text inside <title>.
2898 // The spec recommends defining XHTML5's charset using the XML declaration
2900 // Our XML declaration is output by Html::htmlHeader.
2901 // https://html.spec.whatwg.org/multipage/semantics.html#attr-meta-http-equiv-content-type
2902 // https://html.spec.whatwg.org/multipage/semantics.html#charset
2903 $pieces[] = Html
::element( 'meta', [ 'charset' => 'UTF-8' ] );
2906 $pieces[] = Html
::element( 'title', null, $this->getHTMLTitle() );
2907 $pieces[] = $this->getRlClient()->getHeadHtml();
2908 $pieces[] = $this->buildExemptModules();
2909 $pieces = array_merge( $pieces, array_values( $this->getHeadLinksArray() ) );
2910 $pieces = array_merge( $pieces, array_values( $this->mHeadItems
) );
2911 $pieces[] = Html
::closeElement( 'head' );
2914 $bodyClasses[] = 'mediawiki';
2916 # Classes for LTR/RTL directionality support
2917 $bodyClasses[] = $userdir;
2918 $bodyClasses[] = "sitedir-$sitedir";
2920 $underline = $this->getUser()->getOption( 'underline' );
2921 if ( $underline < 2 ) {
2922 // The following classes can be used here:
2923 // * mw-underline-always
2924 // * mw-underline-never
2925 $bodyClasses[] = 'mw-underline-' . ( $underline ?
'always' : 'never' );
2928 if ( $this->getLanguage()->capitalizeAllNouns() ) {
2929 # A <body> class is probably not the best way to do this . . .
2930 $bodyClasses[] = 'capitalize-all-nouns';
2933 // Parser feature migration class
2934 // The idea is that this will eventually be removed, after the wikitext
2935 // which requires it is cleaned up.
2936 $bodyClasses[] = 'mw-hide-empty-elt';
2938 $bodyClasses[] = $sk->getPageClasses( $this->getTitle() );
2939 $bodyClasses[] = 'skin-' . Sanitizer
::escapeClass( $sk->getSkinName() );
2941 'action-' . Sanitizer
::escapeClass( Action
::getActionName( $this->getContext() ) );
2944 // While the implode() is not strictly needed, it's used for backwards compatibility
2945 // (this used to be built as a string and hooks likely still expect that).
2946 $bodyAttrs['class'] = implode( ' ', $bodyClasses );
2948 // Allow skins and extensions to add body attributes they need
2949 $sk->addToBodyAttributes( $this, $bodyAttrs );
2950 Hooks
::run( 'OutputPageBodyAttributes', [ $this, $sk, &$bodyAttrs ] );
2952 $pieces[] = Html
::openElement( 'body', $bodyAttrs );
2954 return self
::combineWrappedStrings( $pieces );
2958 * Get a ResourceLoader object associated with this OutputPage
2960 * @return ResourceLoader
2962 public function getResourceLoader() {
2963 if ( is_null( $this->mResourceLoader
) ) {
2964 $this->mResourceLoader
= new ResourceLoader(
2966 LoggerFactory
::getInstance( 'resourceloader' )
2969 return $this->mResourceLoader
;
2973 * Explicily load or embed modules on a page.
2975 * @param array|string $modules One or more module names
2976 * @param string $only ResourceLoaderModule TYPE_ class constant
2977 * @param array $extraQuery [optional] Array with extra query parameters for the request
2978 * @return string|WrappedStringList HTML
2980 public function makeResourceLoaderLink( $modules, $only, array $extraQuery = [] ) {
2981 // Apply 'target' and 'origin' filters
2982 $modules = $this->filterModules( (array)$modules, null, $only );
2984 return ResourceLoaderClientHtml
::makeLoad(
2985 $this->getRlClientContext(),
2993 * Combine WrappedString chunks and filter out empty ones
2995 * @param array $chunks
2996 * @return string|WrappedStringList HTML
2998 protected static function combineWrappedStrings( array $chunks ) {
2999 // Filter out empty values
3000 $chunks = array_filter( $chunks, 'strlen' );
3001 return WrappedString
::join( "\n", $chunks );
3004 private function isUserJsPreview() {
3005 return $this->getConfig()->get( 'AllowUserJs' )
3006 && $this->getTitle()
3007 && $this->getTitle()->isJsSubpage()
3008 && $this->userCanPreview();
3011 protected function isUserCssPreview() {
3012 return $this->getConfig()->get( 'AllowUserCss' )
3013 && $this->getTitle()
3014 && $this->getTitle()->isCssSubpage()
3015 && $this->userCanPreview();
3019 * JS stuff to put at the bottom of the `<body>`. These are modules with position 'bottom',
3020 * legacy scripts ($this->mScripts), and user JS.
3022 * @return string|WrappedStringList HTML
3024 public function getBottomScripts() {
3026 $chunks[] = $this->getRlClient()->getBodyHtml();
3028 // Legacy non-ResourceLoader scripts
3029 $chunks[] = $this->mScripts
;
3031 // Exempt 'user' module
3032 // - May need excludepages for live preview. (T28283)
3033 // - Must use TYPE_COMBINED so its response is handled by mw.loader.implement() which
3034 // ensures execution is scheduled after the "site" module.
3035 // - Don't load if module state is already resolved as "ready".
3036 if ( $this->rlUserModuleState
=== 'loading' ) {
3037 if ( $this->isUserJsPreview() ) {
3038 $chunks[] = $this->makeResourceLoaderLink( 'user', ResourceLoaderModule
::TYPE_COMBINED
,
3039 [ 'excludepage' => $this->getTitle()->getPrefixedDBkey() ]
3041 $chunks[] = ResourceLoader
::makeInlineScript(
3042 Xml
::encodeJsCall( 'mw.loader.using', [
3046 . Xml
::encodeJsCall( '$.globalEval', [
3047 $this->getRequest()->getText( 'wpTextbox1' )
3053 // FIXME: If the user is previewing, say, ./vector.js, his ./common.js will be loaded
3054 // asynchronously and may arrive *after* the inline script here. So the previewed code
3055 // may execute before ./common.js runs. Normally, ./common.js runs before ./vector.js.
3056 // Similarly, when previewing ./common.js and the user module does arrive first,
3057 // it will arrive without common.js and the inline script runs after.
3058 // Thus running common after the excluded subpage.
3061 $chunks[] = $this->makeResourceLoaderLink( 'user', ResourceLoaderModule
::TYPE_COMBINED
);
3065 if ( $this->limitReportJSData
) {
3066 $chunks[] = ResourceLoader
::makeInlineScript(
3067 ResourceLoader
::makeConfigSetScript(
3068 [ 'wgPageParseReport' => $this->limitReportJSData
]
3073 return self
::combineWrappedStrings( $chunks );
3077 * Get the javascript config vars to include on this page
3079 * @return array Array of javascript config vars
3082 public function getJsConfigVars() {
3083 return $this->mJsConfigVars
;
3087 * Add one or more variables to be set in mw.config in JavaScript
3089 * @param string|array $keys Key or array of key/value pairs
3090 * @param mixed $value [optional] Value of the configuration variable
3092 public function addJsConfigVars( $keys, $value = null ) {
3093 if ( is_array( $keys ) ) {
3094 foreach ( $keys as $key => $value ) {
3095 $this->mJsConfigVars
[$key] = $value;
3100 $this->mJsConfigVars
[$keys] = $value;
3104 * Get an array containing the variables to be set in mw.config in JavaScript.
3106 * Do not add things here which can be evaluated in ResourceLoaderStartUpModule
3107 * - in other words, page-independent/site-wide variables (without state).
3108 * You will only be adding bloat to the html page and causing page caches to
3109 * have to be purged on configuration changes.
3112 public function getJSVars() {
3117 $canonicalSpecialPageName = false; # T23115
3119 $title = $this->getTitle();
3120 $ns = $title->getNamespace();
3121 $canonicalNamespace = MWNamespace
::exists( $ns )
3122 ? MWNamespace
::getCanonicalName( $ns )
3123 : $title->getNsText();
3125 $sk = $this->getSkin();
3126 // Get the relevant title so that AJAX features can use the correct page name
3127 // when making API requests from certain special pages (T36972).
3128 $relevantTitle = $sk->getRelevantTitle();
3129 $relevantUser = $sk->getRelevantUser();
3131 if ( $ns == NS_SPECIAL
) {
3132 list( $canonicalSpecialPageName, /*...*/ ) =
3133 SpecialPageFactory
::resolveAlias( $title->getDBkey() );
3134 } elseif ( $this->canUseWikiPage() ) {
3135 $wikiPage = $this->getWikiPage();
3136 $curRevisionId = $wikiPage->getLatest();
3137 $articleId = $wikiPage->getId();
3140 $lang = $title->getPageViewLanguage();
3142 // Pre-process information
3143 $separatorTransTable = $lang->separatorTransformTable();
3144 $separatorTransTable = $separatorTransTable ?
$separatorTransTable : [];
3145 $compactSeparatorTransTable = [
3146 implode( "\t", array_keys( $separatorTransTable ) ),
3147 implode( "\t", $separatorTransTable ),
3149 $digitTransTable = $lang->digitTransformTable();
3150 $digitTransTable = $digitTransTable ?
$digitTransTable : [];
3151 $compactDigitTransTable = [
3152 implode( "\t", array_keys( $digitTransTable ) ),
3153 implode( "\t", $digitTransTable ),
3156 $user = $this->getUser();
3159 'wgCanonicalNamespace' => $canonicalNamespace,
3160 'wgCanonicalSpecialPageName' => $canonicalSpecialPageName,
3161 'wgNamespaceNumber' => $title->getNamespace(),
3162 'wgPageName' => $title->getPrefixedDBkey(),
3163 'wgTitle' => $title->getText(),
3164 'wgCurRevisionId' => $curRevisionId,
3165 'wgRevisionId' => (int)$this->getRevisionId(),
3166 'wgArticleId' => $articleId,
3167 'wgIsArticle' => $this->isArticle(),
3168 'wgIsRedirect' => $title->isRedirect(),
3169 'wgAction' => Action
::getActionName( $this->getContext() ),
3170 'wgUserName' => $user->isAnon() ?
null : $user->getName(),
3171 'wgUserGroups' => $user->getEffectiveGroups(),
3172 'wgCategories' => $this->getCategories(),
3173 'wgBreakFrames' => $this->getFrameOptions() == 'DENY',
3174 'wgPageContentLanguage' => $lang->getCode(),
3175 'wgPageContentModel' => $title->getContentModel(),
3176 'wgSeparatorTransformTable' => $compactSeparatorTransTable,
3177 'wgDigitTransformTable' => $compactDigitTransTable,
3178 'wgDefaultDateFormat' => $lang->getDefaultDateFormat(),
3179 'wgMonthNames' => $lang->getMonthNamesArray(),
3180 'wgMonthNamesShort' => $lang->getMonthAbbreviationsArray(),
3181 'wgRelevantPageName' => $relevantTitle->getPrefixedDBkey(),
3182 'wgRelevantArticleId' => $relevantTitle->getArticleID(),
3183 'wgRequestId' => WebRequest
::getRequestId(),
3186 if ( $user->isLoggedIn() ) {
3187 $vars['wgUserId'] = $user->getId();
3188 $vars['wgUserEditCount'] = $user->getEditCount();
3189 $userReg = $user->getRegistration();
3190 $vars['wgUserRegistration'] = $userReg ?
wfTimestamp( TS_UNIX
, $userReg ) * 1000 : null;
3191 // Get the revision ID of the oldest new message on the user's talk
3192 // page. This can be used for constructing new message alerts on
3194 $vars['wgUserNewMsgRevisionId'] = $user->getNewMessageRevisionId();
3197 if ( $wgContLang->hasVariants() ) {
3198 $vars['wgUserVariant'] = $wgContLang->getPreferredVariant();
3200 // Same test as SkinTemplate
3201 $vars['wgIsProbablyEditable'] = $title->quickUserCan( 'edit', $user )
3202 && ( $title->exists() ||
$title->quickUserCan( 'create', $user ) );
3204 $vars['wgRelevantPageIsProbablyEditable'] = $relevantTitle
3205 && $relevantTitle->quickUserCan( 'edit', $user )
3206 && ( $relevantTitle->exists() ||
$relevantTitle->quickUserCan( 'create', $user ) );
3208 foreach ( $title->getRestrictionTypes() as $type ) {
3209 $vars['wgRestriction' . ucfirst( $type )] = $title->getRestrictions( $type );
3212 if ( $title->isMainPage() ) {
3213 $vars['wgIsMainPage'] = true;
3216 if ( $this->mRedirectedFrom
) {
3217 $vars['wgRedirectedFrom'] = $this->mRedirectedFrom
->getPrefixedDBkey();
3220 if ( $relevantUser ) {
3221 $vars['wgRelevantUserName'] = $relevantUser->getName();
3224 // Allow extensions to add their custom variables to the mw.config map.
3225 // Use the 'ResourceLoaderGetConfigVars' hook if the variable is not
3226 // page-dependant but site-wide (without state).
3227 // Alternatively, you may want to use OutputPage->addJsConfigVars() instead.
3228 Hooks
::run( 'MakeGlobalVariablesScript', [ &$vars, $this ] );
3230 // Merge in variables from addJsConfigVars last
3231 return array_merge( $vars, $this->getJsConfigVars() );
3235 * To make it harder for someone to slip a user a fake
3236 * user-JavaScript or user-CSS preview, a random token
3237 * is associated with the login session. If it's not
3238 * passed back with the preview request, we won't render
3243 public function userCanPreview() {
3244 $request = $this->getRequest();
3246 $request->getVal( 'action' ) !== 'submit' ||
3247 !$request->getCheck( 'wpPreview' ) ||
3248 !$request->wasPosted()
3253 $user = $this->getUser();
3255 if ( !$user->isLoggedIn() ) {
3256 // Anons have predictable edit tokens
3259 if ( !$user->matchEditToken( $request->getVal( 'wpEditToken' ) ) ) {
3263 $title = $this->getTitle();
3264 if ( !$title->isJsSubpage() && !$title->isCssSubpage() ) {
3267 if ( !$title->isSubpageOf( $user->getUserPage() ) ) {
3268 // Don't execute another user's CSS or JS on preview (T85855)
3272 $errors = $title->getUserPermissionsErrors( 'edit', $user );
3273 if ( count( $errors ) !== 0 ) {
3281 * @return array Array in format "link name or number => 'link html'".
3283 public function getHeadLinksArray() {
3287 $config = $this->getConfig();
3289 $canonicalUrl = $this->mCanonicalUrl
;
3291 $tags['meta-generator'] = Html
::element( 'meta', [
3292 'name' => 'generator',
3293 'content' => "MediaWiki $wgVersion",
3296 if ( $config->get( 'ReferrerPolicy' ) !== false ) {
3297 $tags['meta-referrer'] = Html
::element( 'meta', [
3298 'name' => 'referrer',
3299 'content' => $config->get( 'ReferrerPolicy' )
3303 $p = "{$this->mIndexPolicy},{$this->mFollowPolicy}";
3304 if ( $p !== 'index,follow' ) {
3305 // http://www.robotstxt.org/wc/meta-user.html
3306 // Only show if it's different from the default robots policy
3307 $tags['meta-robots'] = Html
::element( 'meta', [
3313 foreach ( $this->mMetatags
as $tag ) {
3314 if ( strncasecmp( $tag[0], 'http:', 5 ) === 0 ) {
3316 $tag[0] = substr( $tag[0], 5 );
3317 } elseif ( strncasecmp( $tag[0], 'og:', 3 ) === 0 ) {
3322 $tagName = "meta-{$tag[0]}";
3323 if ( isset( $tags[$tagName] ) ) {
3324 $tagName .= $tag[1];
3326 $tags[$tagName] = Html
::element( 'meta',
3329 'content' => $tag[1]
3334 foreach ( $this->mLinktags
as $tag ) {
3335 $tags[] = Html
::element( 'link', $tag );
3338 # Universal edit button
3339 if ( $config->get( 'UniversalEditButton' ) && $this->isArticleRelated() ) {
3340 $user = $this->getUser();
3341 if ( $this->getTitle()->quickUserCan( 'edit', $user )
3342 && ( $this->getTitle()->exists() ||
3343 $this->getTitle()->quickUserCan( 'create', $user ) )
3345 // Original UniversalEditButton
3346 $msg = $this->msg( 'edit' )->text();
3347 $tags['universal-edit-button'] = Html
::element( 'link', [
3348 'rel' => 'alternate',
3349 'type' => 'application/x-wiki',
3351 'href' => $this->getTitle()->getEditURL(),
3353 // Alternate edit link
3354 $tags['alternative-edit'] = Html
::element( 'link', [
3357 'href' => $this->getTitle()->getEditURL(),
3362 # Generally the order of the favicon and apple-touch-icon links
3363 # should not matter, but Konqueror (3.5.9 at least) incorrectly
3364 # uses whichever one appears later in the HTML source. Make sure
3365 # apple-touch-icon is specified first to avoid this.
3366 if ( $config->get( 'AppleTouchIcon' ) !== false ) {
3367 $tags['apple-touch-icon'] = Html
::element( 'link', [
3368 'rel' => 'apple-touch-icon',
3369 'href' => $config->get( 'AppleTouchIcon' )
3373 if ( $config->get( 'Favicon' ) !== false ) {
3374 $tags['favicon'] = Html
::element( 'link', [
3375 'rel' => 'shortcut icon',
3376 'href' => $config->get( 'Favicon' )
3380 # OpenSearch description link
3381 $tags['opensearch'] = Html
::element( 'link', [
3383 'type' => 'application/opensearchdescription+xml',
3384 'href' => wfScript( 'opensearch_desc' ),
3385 'title' => $this->msg( 'opensearch-desc' )->inContentLanguage()->text(),
3388 if ( $config->get( 'EnableAPI' ) ) {
3389 # Real Simple Discovery link, provides auto-discovery information
3390 # for the MediaWiki API (and potentially additional custom API
3391 # support such as WordPress or Twitter-compatible APIs for a
3392 # blogging extension, etc)
3393 $tags['rsd'] = Html
::element( 'link', [
3395 'type' => 'application/rsd+xml',
3396 // Output a protocol-relative URL here if $wgServer is protocol-relative.
3397 // Whether RSD accepts relative or protocol-relative URLs is completely
3398 // undocumented, though.
3399 'href' => wfExpandUrl( wfAppendQuery(
3401 [ 'action' => 'rsd' ] ),
3408 if ( !$config->get( 'DisableLangConversion' ) ) {
3409 $lang = $this->getTitle()->getPageLanguage();
3410 if ( $lang->hasVariants() ) {
3411 $variants = $lang->getVariants();
3412 foreach ( $variants as $variant ) {
3413 $tags["variant-$variant"] = Html
::element( 'link', [
3414 'rel' => 'alternate',
3415 'hreflang' => wfBCP47( $variant ),
3416 'href' => $this->getTitle()->getLocalURL(
3417 [ 'variant' => $variant ] )
3421 # x-default link per https://support.google.com/webmasters/answer/189077?hl=en
3422 $tags["variant-x-default"] = Html
::element( 'link', [
3423 'rel' => 'alternate',
3424 'hreflang' => 'x-default',
3425 'href' => $this->getTitle()->getLocalURL() ] );
3430 if ( $this->copyrightUrl
!== null ) {
3431 $copyright = $this->copyrightUrl
;
3434 if ( $config->get( 'RightsPage' ) ) {
3435 $copy = Title
::newFromText( $config->get( 'RightsPage' ) );
3438 $copyright = $copy->getLocalURL();
3442 if ( !$copyright && $config->get( 'RightsUrl' ) ) {
3443 $copyright = $config->get( 'RightsUrl' );
3448 $tags['copyright'] = Html
::element( 'link', [
3449 'rel' => 'copyright',
3450 'href' => $copyright ]
3455 if ( $config->get( 'Feed' ) ) {
3458 foreach ( $this->getSyndicationLinks() as $format => $link ) {
3459 # Use the page name for the title. In principle, this could
3460 # lead to issues with having the same name for different feeds
3461 # corresponding to the same page, but we can't avoid that at
3464 $feedLinks[] = $this->feedLink(
3467 # Used messages: 'page-rss-feed' and 'page-atom-feed' (for an easier grep)
3469 "page-{$format}-feed", $this->getTitle()->getPrefixedText()
3474 # Recent changes feed should appear on every page (except recentchanges,
3475 # that would be redundant). Put it after the per-page feed to avoid
3476 # changing existing behavior. It's still available, probably via a
3477 # menu in your browser. Some sites might have a different feed they'd
3478 # like to promote instead of the RC feed (maybe like a "Recent New Articles"
3479 # or "Breaking news" one). For this, we see if $wgOverrideSiteFeed is defined.
3480 # If so, use it instead.
3481 $sitename = $config->get( 'Sitename' );
3482 if ( $config->get( 'OverrideSiteFeed' ) ) {
3483 foreach ( $config->get( 'OverrideSiteFeed' ) as $type => $feedUrl ) {
3484 // Note, this->feedLink escapes the url.
3485 $feedLinks[] = $this->feedLink(
3488 $this->msg( "site-{$type}-feed", $sitename )->text()
3491 } elseif ( !$this->getTitle()->isSpecial( 'Recentchanges' ) ) {
3492 $rctitle = SpecialPage
::getTitleFor( 'Recentchanges' );
3493 foreach ( $config->get( 'AdvertisedFeedTypes' ) as $format ) {
3494 $feedLinks[] = $this->feedLink(
3496 $rctitle->getLocalURL( [ 'feed' => $format ] ),
3497 # For grep: 'site-rss-feed', 'site-atom-feed'
3498 $this->msg( "site-{$format}-feed", $sitename )->text()
3503 # Allow extensions to change the list pf feeds. This hook is primarily for changing,
3504 # manipulating or removing existing feed tags. If you want to add new feeds, you should
3505 # use OutputPage::addFeedLink() instead.
3506 Hooks
::run( 'AfterBuildFeedLinks', [ &$feedLinks ] );
3508 $tags +
= $feedLinks;
3512 if ( $config->get( 'EnableCanonicalServerLink' ) ) {
3513 if ( $canonicalUrl !== false ) {
3514 $canonicalUrl = wfExpandUrl( $canonicalUrl, PROTO_CANONICAL
);
3516 if ( $this->isArticleRelated() ) {
3517 // This affects all requests where "setArticleRelated" is true. This is
3518 // typically all requests that show content (query title, curid, oldid, diff),
3519 // and all wikipage actions (edit, delete, purge, info, history etc.).
3520 // It does not apply to File pages and Special pages.
3521 // 'history' and 'info' actions address page metadata rather than the page
3522 // content itself, so they may not be canonicalized to the view page url.
3523 // TODO: this ought to be better encapsulated in the Action class.
3524 $action = Action
::getActionName( $this->getContext() );
3525 if ( in_array( $action, [ 'history', 'info' ] ) ) {
3526 $query = "action={$action}";
3530 $canonicalUrl = $this->getTitle()->getCanonicalURL( $query );
3532 $reqUrl = $this->getRequest()->getRequestURL();
3533 $canonicalUrl = wfExpandUrl( $reqUrl, PROTO_CANONICAL
);
3537 if ( $canonicalUrl !== false ) {
3538 $tags[] = Html
::element( 'link', [
3539 'rel' => 'canonical',
3540 'href' => $canonicalUrl
3548 * Generate a "<link rel/>" for a feed.
3550 * @param string $type Feed type
3551 * @param string $url URL to the feed
3552 * @param string $text Value of the "title" attribute
3553 * @return string HTML fragment
3555 private function feedLink( $type, $url, $text ) {
3556 return Html
::element( 'link', [
3557 'rel' => 'alternate',
3558 'type' => "application/$type+xml",
3565 * Add a local or specified stylesheet, with the given media options.
3566 * Internal use only. Use OutputPage::addModuleStyles() if possible.
3568 * @param string $style URL to the file
3569 * @param string $media To specify a media type, 'screen', 'printable', 'handheld' or any.
3570 * @param string $condition For IE conditional comments, specifying an IE version
3571 * @param string $dir Set to 'rtl' or 'ltr' for direction-specific sheets
3573 public function addStyle( $style, $media = '', $condition = '', $dir = '' ) {
3576 $options['media'] = $media;
3579 $options['condition'] = $condition;
3582 $options['dir'] = $dir;
3584 $this->styles
[$style] = $options;
3588 * Adds inline CSS styles
3589 * Internal use only. Use OutputPage::addModuleStyles() if possible.
3591 * @param mixed $style_css Inline CSS
3592 * @param string $flip Set to 'flip' to flip the CSS if needed
3594 public function addInlineStyle( $style_css, $flip = 'noflip' ) {
3595 if ( $flip === 'flip' && $this->getLanguage()->isRTL() ) {
3596 # If wanted, and the interface is right-to-left, flip the CSS
3597 $style_css = CSSJanus
::transform( $style_css, true, false );
3599 $this->mInlineStyles
.= Html
::inlineStyle( $style_css );
3603 * Build exempt modules and legacy non-ResourceLoader styles.
3605 * @return string|WrappedStringList HTML
3607 protected function buildExemptModules() {
3611 // Things that go after the ResourceLoaderDynamicStyles marker
3614 // Exempt 'user' styles module (may need 'excludepages' for live preview)
3615 if ( $this->isUserCssPreview() ) {
3616 $append[] = $this->makeResourceLoaderLink(
3618 ResourceLoaderModule
::TYPE_STYLES
,
3619 [ 'excludepage' => $this->getTitle()->getPrefixedDBkey() ]
3622 // Load the previewed CSS. Janus it if needed.
3623 // User-supplied CSS is assumed to in the wiki's content language.
3624 $previewedCSS = $this->getRequest()->getText( 'wpTextbox1' );
3625 if ( $this->getLanguage()->getDir() !== $wgContLang->getDir() ) {
3626 $previewedCSS = CSSJanus
::transform( $previewedCSS, true, false );
3628 $append[] = Html
::inlineStyle( $previewedCSS );
3631 // We want site, private and user styles to override dynamically added styles from
3632 // general modules, but we want dynamically added styles to override statically added
3633 // style modules. So the order has to be:
3634 // - page style modules (formatted by ResourceLoaderClientHtml::getHeadHtml())
3635 // - dynamically loaded styles (added by mw.loader before ResourceLoaderDynamicStyles)
3636 // - ResourceLoaderDynamicStyles marker
3637 // - site/private/user styles
3639 // Add legacy styles added through addStyle()/addInlineStyle() here
3640 $chunks[] = implode( '', $this->buildCssLinksArray() ) . $this->mInlineStyles
;
3642 $chunks[] = Html
::element(
3644 [ 'name' => 'ResourceLoaderDynamicStyles', 'content' => '' ]
3647 $separateReq = [ 'site.styles', 'user.styles' ];
3648 foreach ( $this->rlExemptStyleModules
as $group => $moduleNames ) {
3649 // Combinable modules
3650 $chunks[] = $this->makeResourceLoaderLink(
3651 array_diff( $moduleNames, $separateReq ),
3652 ResourceLoaderModule
::TYPE_STYLES
3655 foreach ( array_intersect( $moduleNames, $separateReq ) as $name ) {
3656 // These require their own dedicated request in order to support "@import"
3657 // syntax, which is incompatible with concatenation. (T147667, T37562)
3658 $chunks[] = $this->makeResourceLoaderLink( $name,
3659 ResourceLoaderModule
::TYPE_STYLES
3664 return self
::combineWrappedStrings( array_merge( $chunks, $append ) );
3670 public function buildCssLinksArray() {
3673 // Add any extension CSS
3674 foreach ( $this->mExtStyles
as $url ) {
3675 $this->addStyle( $url );
3677 $this->mExtStyles
= [];
3679 foreach ( $this->styles
as $file => $options ) {
3680 $link = $this->styleLink( $file, $options );
3682 $links[$file] = $link;
3689 * Generate \<link\> tags for stylesheets
3691 * @param string $style URL to the file
3692 * @param array $options Option, can contain 'condition', 'dir', 'media' keys
3693 * @return string HTML fragment
3695 protected function styleLink( $style, array $options ) {
3696 if ( isset( $options['dir'] ) ) {
3697 if ( $this->getLanguage()->getDir() != $options['dir'] ) {
3702 if ( isset( $options['media'] ) ) {
3703 $media = self
::transformCssMedia( $options['media'] );
3704 if ( is_null( $media ) ) {
3711 if ( substr( $style, 0, 1 ) == '/' ||
3712 substr( $style, 0, 5 ) == 'http:' ||
3713 substr( $style, 0, 6 ) == 'https:' ) {
3716 $config = $this->getConfig();
3717 $url = $config->get( 'StylePath' ) . '/' . $style . '?' .
3718 $config->get( 'StyleVersion' );
3721 $link = Html
::linkedStyle( $url, $media );
3723 if ( isset( $options['condition'] ) ) {
3724 $condition = htmlspecialchars( $options['condition'] );
3725 $link = "<!--[if $condition]>$link<![endif]-->";
3731 * Transform path to web-accessible static resource.
3733 * This is used to add a validation hash as query string.
3734 * This aids various behaviors:
3736 * - Put long Cache-Control max-age headers on responses for improved
3737 * cache performance.
3738 * - Get the correct version of a file as expected by the current page.
3739 * - Instantly get the updated version of a file after deployment.
3741 * Avoid using this for urls included in HTML as otherwise clients may get different
3742 * versions of a resource when navigating the site depending on when the page was cached.
3743 * If changes to the url propagate, this is not a problem (e.g. if the url is in
3744 * an external stylesheet).
3747 * @param Config $config
3748 * @param string $path Path-absolute URL to file (from document root, must start with "/")
3749 * @return string URL
3751 public static function transformResourcePath( Config
$config, $path ) {
3755 $remotePathPrefix = $config->get( 'ResourceBasePath' );
3756 if ( $remotePathPrefix === '' ) {
3757 // The configured base path is required to be empty string for
3758 // wikis in the domain root
3761 $remotePath = $remotePathPrefix;
3763 if ( strpos( $path, $remotePath ) !== 0 ||
substr( $path, 0, 2 ) === '//' ) {
3764 // - Path is outside wgResourceBasePath, ignore.
3765 // - Path is protocol-relative. Fixes T155310. Not supported by RelPath lib.
3768 // For files in resources, extensions/ or skins/, ResourceBasePath is preferred here.
3769 // For other misc files in $IP, we'll fallback to that as well. There is, however, a fourth
3770 // supported dir/path pair in the configuration (wgUploadDirectory, wgUploadPath)
3771 // which is not expected to be in wgResourceBasePath on CDNs. (T155146)
3772 $uploadPath = $config->get( 'UploadPath' );
3773 if ( strpos( $path, $uploadPath ) === 0 ) {
3774 $localDir = $config->get( 'UploadDirectory' );
3775 $remotePathPrefix = $remotePath = $uploadPath;
3778 $path = RelPath\
getRelativePath( $path, $remotePath );
3779 return self
::transformFilePath( $remotePathPrefix, $localDir, $path );
3783 * Utility method for transformResourceFilePath().
3785 * Caller is responsible for ensuring the file exists. Emits a PHP warning otherwise.
3788 * @param string $remotePath URL path prefix that points to $localPath
3789 * @param string $localPath File directory exposed at $remotePath
3790 * @param string $file Path to target file relative to $localPath
3791 * @return string URL
3793 public static function transformFilePath( $remotePathPrefix, $localPath, $file ) {
3794 $hash = md5_file( "$localPath/$file" );
3795 if ( $hash === false ) {
3796 wfLogWarning( __METHOD__
. ": Failed to hash $localPath/$file" );
3799 return "$remotePathPrefix/$file?" . substr( $hash, 0, 5 );
3803 * Transform "media" attribute based on request parameters
3805 * @param string $media Current value of the "media" attribute
3806 * @return string Modified value of the "media" attribute, or null to skip
3809 public static function transformCssMedia( $media ) {
3812 // https://www.w3.org/TR/css3-mediaqueries/#syntax
3813 $screenMediaQueryRegex = '/^(?:only\s+)?screen\b/i';
3815 // Switch in on-screen display for media testing
3817 'printable' => 'print',
3818 'handheld' => 'handheld',
3820 foreach ( $switches as $switch => $targetMedia ) {
3821 if ( $wgRequest->getBool( $switch ) ) {
3822 if ( $media == $targetMedia ) {
3824 } elseif ( preg_match( $screenMediaQueryRegex, $media ) === 1 ) {
3825 /* This regex will not attempt to understand a comma-separated media_query_list
3827 * Example supported values for $media:
3828 * 'screen', 'only screen', 'screen and (min-width: 982px)' ),
3829 * Example NOT supported value for $media:
3830 * '3d-glasses, screen, print and resolution > 90dpi'
3832 * If it's a print request, we never want any kind of screen stylesheets
3833 * If it's a handheld request (currently the only other choice with a switch),
3834 * we don't want simple 'screen' but we might want screen queries that
3835 * have a max-width or something, so we'll pass all others on and let the
3836 * client do the query.
3838 if ( $targetMedia == 'print' ||
$media == 'screen' ) {
3849 * Add a wikitext-formatted message to the output.
3850 * This is equivalent to:
3852 * $wgOut->addWikiText( wfMessage( ... )->plain() )
3854 public function addWikiMsg( /*...*/ ) {
3855 $args = func_get_args();
3856 $name = array_shift( $args );
3857 $this->addWikiMsgArray( $name, $args );
3861 * Add a wikitext-formatted message to the output.
3862 * Like addWikiMsg() except the parameters are taken as an array
3863 * instead of a variable argument list.
3865 * @param string $name
3866 * @param array $args
3868 public function addWikiMsgArray( $name, $args ) {
3869 $this->addHTML( $this->msg( $name, $args )->parseAsBlock() );
3873 * This function takes a number of message/argument specifications, wraps them in
3874 * some overall structure, and then parses the result and adds it to the output.
3876 * In the $wrap, $1 is replaced with the first message, $2 with the second,
3877 * and so on. The subsequent arguments may be either
3878 * 1) strings, in which case they are message names, or
3879 * 2) arrays, in which case, within each array, the first element is the message
3880 * name, and subsequent elements are the parameters to that message.
3882 * Don't use this for messages that are not in the user's interface language.
3886 * $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>", 'some-error' );
3890 * $wgOut->addWikiText( "<div class='error'>\n"
3891 * . wfMessage( 'some-error' )->plain() . "\n</div>" );
3893 * The newline after the opening div is needed in some wikitext. See T21226.
3895 * @param string $wrap
3897 public function wrapWikiMsg( $wrap /*, ...*/ ) {
3898 $msgSpecs = func_get_args();
3899 array_shift( $msgSpecs );
3900 $msgSpecs = array_values( $msgSpecs );
3902 foreach ( $msgSpecs as $n => $spec ) {
3903 if ( is_array( $spec ) ) {
3905 $name = array_shift( $args );
3906 if ( isset( $args['options'] ) ) {
3907 unset( $args['options'] );
3909 'Adding "options" to ' . __METHOD__
. ' is no longer supported',
3917 $s = str_replace( '$' . ( $n +
1 ), $this->msg( $name, $args )->plain(), $s );
3919 $this->addWikiText( $s );
3923 * Whether the output has a table of contents
3927 public function isTOCEnabled() {
3928 return $this->mEnableTOC
;
3932 * Enables/disables section edit links, doesn't override __NOEDITSECTION__
3936 public function enableSectionEditLinks( $flag = true ) {
3937 $this->mEnableSectionEditLinks
= $flag;
3944 public function sectionEditLinksEnabled() {
3945 return $this->mEnableSectionEditLinks
;
3949 * Helper function to setup the PHP implementation of OOUI to use in this request.
3952 * @param String $skinName The Skin name to determine the correct OOUI theme
3953 * @param String $dir Language direction
3955 public static function setupOOUI( $skinName = 'default', $dir = 'ltr' ) {
3956 $themes = ResourceLoaderOOUIModule
::getSkinThemeMap();
3957 $theme = isset( $themes[$skinName] ) ?
$themes[$skinName] : $themes['default'];
3958 // For example, 'OOUI\WikimediaUITheme'.
3959 $themeClass = "OOUI\\{$theme}Theme";
3960 OOUI\Theme
::setSingleton( new $themeClass() );
3961 OOUI\Element
::setDefaultDir( $dir );
3965 * Add ResourceLoader module styles for OOUI and set up the PHP implementation of it for use with
3966 * MediaWiki and this OutputPage instance.
3970 public function enableOOUI() {
3972 strtolower( $this->getSkin()->getSkinName() ),
3973 $this->getLanguage()->getDir()
3975 $this->addModuleStyles( [
3976 'oojs-ui-core.styles',
3977 'oojs-ui.styles.indicators',
3978 'oojs-ui.styles.textures',
3979 'mediawiki.widgets.styles',
3980 'oojs-ui.styles.icons-content',
3981 'oojs-ui.styles.icons-alerts',
3982 'oojs-ui.styles.icons-interactions',
3987 * Add Link headers for preloading the wiki's logo.
3991 protected function addLogoPreloadLinkHeaders() {
3992 $logo = ResourceLoaderSkinModule
::getLogo( $this->getConfig() );
3998 if ( !is_array( $logo ) ) {
3999 // No media queries required if we only have one variant
4000 $this->addLinkHeader( '<' . $logo . '>;rel=preload;as=image' );
4004 foreach ( $logo as $dppx => $src ) {
4005 // Keys are in this format: "1.5x"
4006 $dppx = substr( $dppx, 0, -1 );
4007 $logosPerDppx[$dppx] = $src;
4010 // Because PHP can't have floats as array keys
4011 uksort( $logosPerDppx, function ( $a , $b ) {
4012 $a = floatval( $a );
4013 $b = floatval( $b );
4018 // Sort from smallest to largest (e.g. 1x, 1.5x, 2x)
4019 return ( $a < $b ) ?
-1 : 1;
4022 foreach ( $logosPerDppx as $dppx => $src ) {
4023 $logos[] = [ 'dppx' => $dppx, 'src' => $src ];
4026 $logosCount = count( $logos );
4027 // Logic must match ResourceLoaderSkinModule:
4028 // - 1x applies to resolution < 1.5dppx
4029 // - 1.5x applies to resolution >= 1.5dppx && < 2dppx
4030 // - 2x applies to resolution >= 2dppx
4031 // Note that min-resolution and max-resolution are both inclusive.
4032 for ( $i = 0; $i < $logosCount; $i++
) {
4035 // min-resolution is ">=" (larger than or equal to)
4036 // "not min-resolution" is essentially "<"
4037 $media_query = 'not all and (min-resolution: ' . $logos[ 1 ]['dppx'] . 'dppx)';
4038 } elseif ( $i !== $logosCount - 1 ) {
4040 // Media query expressions can only apply "not" to the entire expression
4041 // (e.g. can't express ">= 1.5 and not >= 2).
4042 // Workaround: Use <= 1.9999 in place of < 2.
4043 $upper_bound = floatval( $logos[ $i +
1 ]['dppx'] ) - 0.000001;
4044 $media_query = '(min-resolution: ' . $logos[ $i ]['dppx'] .
4045 'dppx) and (max-resolution: ' . $upper_bound . 'dppx)';
4048 $media_query = '(min-resolution: ' . $logos[ $i ]['dppx'] . 'dppx)';
4051 $this->addLinkHeader(
4052 '<' . $logos[$i]['src'] . '>;rel=preload;as=image;media=' . $media_query