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\Session\SessionManager
;
25 use WrappedString\WrappedString
;
26 use WrappedString\WrappedStringList
;
29 * This class should be covered by a general architecture document which does
30 * not exist as of January 2011. This is one of the Core classes and should
31 * be read at least once by any new developers.
33 * This class is used to prepare the final rendering. A skin is then
34 * applied to the output parameters (links, javascript, html, categories ...).
36 * @todo FIXME: Another class handles sending the whole page to the client.
38 * Some comments comes from a pairing session between Zak Greant and Antoine Musso
43 class OutputPage
extends ContextSource
{
44 /** @var array Should be private. Used with addMeta() which adds "<meta>" */
45 protected $mMetatags = [];
48 protected $mLinktags = [];
51 protected $mCanonicalUrl = false;
54 * @var array Additional stylesheets. Looks like this is for extensions.
55 * Might be replaced by ResourceLoader.
57 protected $mExtStyles = [];
60 * @var string Should be private - has getter and setter. Contains
62 public $mPagetitle = '';
65 * @var string Contains all of the "<body>" content. Should be private we
66 * got set/get accessors and the append() method.
68 public $mBodytext = '';
71 * Holds the debug lines that will be output as comments in page source if
72 * $wgDebugComments is enabled. See also $wgShowDebug.
73 * @deprecated since 1.20; use MWDebug class instead.
75 public $mDebugtext = '';
77 /** @var string Stores contents of "<title>" tag */
78 private $mHTMLtitle = '';
81 * @var bool Is the displayed content related to the source of the
82 * corresponding wiki article.
84 private $mIsarticle = false;
86 /** @var bool Stores "article flag" toggle. */
87 private $mIsArticleRelated = true;
90 * @var bool We have to set isPrintable(). Some pages should
91 * never be printed (ex: redirections).
93 private $mPrintable = false;
96 * @var array Contains the page subtitle. Special pages usually have some
97 * links here. Don't confuse with site subtitle added by skins.
99 private $mSubtitle = [];
102 public $mRedirect = '';
105 protected $mStatusCode;
108 * @var string Used for sending cache control.
109 * The whole caching system should probably be moved into its own class.
111 protected $mLastModified = '';
114 protected $mCategoryLinks = [];
117 protected $mCategories = [];
120 protected $mIndicators = [];
122 /** @var array Array of Interwiki Prefixed (non DB key) Titles (e.g. 'fr:Test page') */
123 private $mLanguageLinks = [];
126 * Used for JavaScript (predates ResourceLoader)
127 * @todo We should split JS / CSS.
128 * mScripts content is inserted as is in "<head>" by Skin. This might
129 * contain either a link to a stylesheet or inline CSS.
131 private $mScripts = '';
133 /** @var string Inline CSS styles. Use addInlineStyle() sparingly */
134 protected $mInlineStyles = '';
137 * @var string Used by skin template.
138 * Example: $tpl->set( 'displaytitle', $out->mPageLinkTitle );
140 public $mPageLinkTitle = '';
142 /** @var array Array of elements in "<head>". Parser might add its own headers! */
143 protected $mHeadItems = [];
146 protected $mModules = [];
149 protected $mModuleScripts = [];
152 protected $mModuleStyles = [];
154 /** @var ResourceLoader */
155 protected $mResourceLoader;
158 protected $mJsConfigVars = [];
161 protected $mTemplateIds = [];
164 protected $mImageTimeKeys = [];
167 public $mRedirectCode = '';
169 protected $mFeedLinksAppendQuery = null;
172 * What level of 'untrustworthiness' is allowed in CSS/JS modules loaded on this page?
173 * @see ResourceLoaderModule::$origin
174 * ResourceLoaderModule::ORIGIN_ALL is assumed unless overridden;
176 protected $mAllowedModules = [
177 ResourceLoaderModule
::TYPE_COMBINED
=> ResourceLoaderModule
::ORIGIN_ALL
,
180 /** @var bool Whether output is disabled. If this is true, the 'output' method will do nothing. */
181 protected $mDoNothing = false;
186 protected $mContainsNewMagic = 0;
189 * lazy initialised, use parserOptions()
192 protected $mParserOptions = null;
195 * Handles the Atom / RSS links.
196 * We probably only support Atom in 2011.
197 * @see $wgAdvertisedFeedTypes
199 private $mFeedLinks = [];
201 // Gwicke work on squid caching? Roughly from 2003.
202 protected $mEnableClientCache = true;
204 /** @var bool Flag if output should only contain the body of the article. */
205 private $mArticleBodyOnly = false;
208 protected $mNewSectionLink = false;
211 protected $mHideNewSectionLink = false;
214 * @var bool Comes from the parser. This was probably made to load CSS/JS
215 * only if we had "<gallery>". Used directly in CategoryPage.php.
216 * Looks like ResourceLoader can replace this.
218 public $mNoGallery = false;
221 private $mPageTitleActionText = '';
223 /** @var int Cache stuff. Looks like mEnableClientCache */
224 protected $mCdnMaxage = 0;
225 /** @var int Upper limit on mCdnMaxage */
226 protected $mCdnMaxageLimit = INF
;
229 * @var bool Controls if anti-clickjacking / frame-breaking headers will
230 * be sent. This should be done for pages where edit actions are possible.
231 * Setters: $this->preventClickjacking() and $this->allowClickjacking().
233 protected $mPreventClickjacking = true;
235 /** @var int To include the variable {{REVISIONID}} */
236 private $mRevisionId = null;
239 private $mRevisionTimestamp = null;
242 protected $mFileVersion = null;
245 * @var array An array of stylesheet filenames (relative from skins path),
246 * with options for CSS media, IE conditions, and RTL/LTR direction.
247 * For internal use; add settings in the skin via $this->addStyle()
249 * Style again! This seems like a code duplication since we already have
250 * mStyles. This is what makes Open Source amazing.
252 protected $styles = [];
254 private $mIndexPolicy = 'index';
255 private $mFollowPolicy = 'follow';
256 private $mVaryHeader = [
257 'Accept-Encoding' => [ 'match=gzip' ],
261 * If the current page was reached through a redirect, $mRedirectedFrom contains the Title
266 private $mRedirectedFrom = null;
269 * Additional key => value data
271 private $mProperties = [];
274 * @var string|null ResourceLoader target for load.php links. If null, will be omitted
276 private $mTarget = null;
279 * @var bool Whether parser output should contain table of contents
281 private $mEnableTOC = true;
284 * @var bool Whether parser output should contain section edit links
286 private $mEnableSectionEditLinks = true;
289 * @var string|null The URL to send in a <link> element with rel=copyright
291 private $copyrightUrl;
293 /** @var array Profiling data */
294 private $limitReportData = [];
297 * Constructor for OutputPage. This should not be called directly.
298 * Instead a new RequestContext should be created and it will implicitly create
299 * a OutputPage tied to that context.
300 * @param IContextSource|null $context
302 function __construct( IContextSource
$context = null ) {
303 if ( $context === null ) {
304 # Extensions should use `new RequestContext` instead of `new OutputPage` now.
305 wfDeprecated( __METHOD__
, '1.18' );
307 $this->setContext( $context );
312 * Redirect to $url rather than displaying the normal page
314 * @param string $url URL
315 * @param string $responsecode HTTP status code
317 public function redirect( $url, $responsecode = '302' ) {
318 # Strip newlines as a paranoia check for header injection in PHP<5.1.2
319 $this->mRedirect
= str_replace( "\n", '', $url );
320 $this->mRedirectCode
= $responsecode;
324 * Get the URL to redirect to, or an empty string if not redirect URL set
328 public function getRedirect() {
329 return $this->mRedirect
;
333 * Set the copyright URL to send with the output.
334 * Empty string to omit, null to reset.
338 * @param string|null $url
340 public function setCopyrightUrl( $url ) {
341 $this->copyrightUrl
= $url;
345 * Set the HTTP status code to send with the output.
347 * @param int $statusCode
349 public function setStatusCode( $statusCode ) {
350 $this->mStatusCode
= $statusCode;
354 * Add a new "<meta>" tag
355 * To add an http-equiv meta tag, precede the name with "http:"
357 * @param string $name Tag name
358 * @param string $val Tag value
360 function addMeta( $name, $val ) {
361 array_push( $this->mMetatags
, [ $name, $val ] );
365 * Returns the current <meta> tags
370 public function getMetaTags() {
371 return $this->mMetatags
;
375 * Add a new \<link\> tag to the page header.
377 * Note: use setCanonicalUrl() for rel=canonical.
379 * @param array $linkarr Associative array of attributes.
381 function addLink( array $linkarr ) {
382 array_push( $this->mLinktags
, $linkarr );
386 * Returns the current <link> tags
391 public function getLinkTags() {
392 return $this->mLinktags
;
396 * Add a new \<link\> with "rel" attribute set to "meta"
398 * @param array $linkarr Associative array mapping attribute names to their
399 * values, both keys and values will be escaped, and the
400 * "rel" attribute will be automatically added
402 function addMetadataLink( array $linkarr ) {
403 $linkarr['rel'] = $this->getMetadataAttribute();
404 $this->addLink( $linkarr );
408 * Set the URL to be used for the <link rel=canonical>. This should be used
409 * in preference to addLink(), to avoid duplicate link tags.
412 function setCanonicalUrl( $url ) {
413 $this->mCanonicalUrl
= $url;
417 * Returns the URL to be used for the <link rel=canonical> if
421 * @return bool|string
423 public function getCanonicalUrl() {
424 return $this->mCanonicalUrl
;
428 * Get the value of the "rel" attribute for metadata links
432 public function getMetadataAttribute() {
433 # note: buggy CC software only reads first "meta" link
434 static $haveMeta = false;
436 return 'alternate meta';
444 * Add raw HTML to the list of scripts (including \<script\> tag, etc.)
445 * Internal use only. Use OutputPage::addModules() or OutputPage::addJsConfigVars()
448 * @param string $script Raw HTML
450 function addScript( $script ) {
451 $this->mScripts
.= $script;
455 * Register and add a stylesheet from an extension directory.
457 * @deprecated since 1.27 use addModuleStyles() or addStyle() instead
458 * @param string $url Path to sheet. Provide either a full url (beginning
459 * with 'http', etc) or a relative path from the document root
460 * (beginning with '/'). Otherwise it behaves identically to
461 * addStyle() and draws from the /skins folder.
463 public function addExtensionStyle( $url ) {
464 wfDeprecated( __METHOD__
, '1.27' );
465 array_push( $this->mExtStyles
, $url );
469 * Get all styles added by extensions
471 * @deprecated since 1.27
474 function getExtStyle() {
475 wfDeprecated( __METHOD__
, '1.27' );
476 return $this->mExtStyles
;
480 * Add a JavaScript file out of skins/common, or a given relative path.
481 * Internal use only. Use OutputPage::addModules() if possible.
483 * @param string $file Filename in skins/common or complete on-server path
485 * @param string $version Style version of the file. Defaults to $wgStyleVersion
487 public function addScriptFile( $file, $version = null ) {
488 // See if $file parameter is an absolute URL or begins with a slash
489 if ( substr( $file, 0, 1 ) == '/' ||
preg_match( '#^[a-z]*://#i', $file ) ) {
492 $path = $this->getConfig()->get( 'StylePath' ) . "/common/{$file}";
494 if ( is_null( $version ) ) {
495 $version = $this->getConfig()->get( 'StyleVersion' );
497 $this->addScript( Html
::linkedScript( wfAppendQuery( $path, $version ) ) );
501 * Add a self-contained script tag with the given contents
502 * Internal use only. Use OutputPage::addModules() if possible.
504 * @param string $script JavaScript text, no "<script>" tags
506 public function addInlineScript( $script ) {
507 $this->mScripts
.= Html
::inlineScript( $script );
511 * Filter an array of modules to remove insufficiently trustworthy members, and modules
512 * which are no longer registered (eg a page is cached before an extension is disabled)
513 * @param array $modules
514 * @param string|null $position If not null, only return modules with this position
515 * @param string $type
518 protected function filterModules( array $modules, $position = null,
519 $type = ResourceLoaderModule
::TYPE_COMBINED
521 $resourceLoader = $this->getResourceLoader();
522 $filteredModules = [];
523 foreach ( $modules as $val ) {
524 $module = $resourceLoader->getModule( $val );
525 if ( $module instanceof ResourceLoaderModule
526 && $module->getOrigin() <= $this->getAllowedModules( $type )
527 && ( is_null( $position ) ||
$module->getPosition() == $position )
528 && ( !$this->mTarget ||
in_array( $this->mTarget
, $module->getTargets() ) )
530 $filteredModules[] = $val;
533 return $filteredModules;
537 * Get the list of modules to include on this page
539 * @param bool $filter Whether to filter out insufficiently trustworthy modules
540 * @param string|null $position If not null, only return modules with this position
541 * @param string $param
542 * @return array Array of module names
544 public function getModules( $filter = false, $position = null, $param = 'mModules' ) {
545 $modules = array_values( array_unique( $this->$param ) );
547 ?
$this->filterModules( $modules, $position )
552 * Add one or more modules recognized by ResourceLoader. Modules added
553 * through this function will be loaded by ResourceLoader when the
556 * @param string|array $modules Module name (string) or array of module names
558 public function addModules( $modules ) {
559 $this->mModules
= array_merge( $this->mModules
, (array)$modules );
563 * Get the list of module JS to include on this page
565 * @param bool $filter
566 * @param string|null $position
568 * @return array Array of module names
570 public function getModuleScripts( $filter = false, $position = null ) {
571 return $this->getModules( $filter, $position, 'mModuleScripts' );
575 * Add only JS of one or more modules recognized by ResourceLoader. Module
576 * scripts added through this function will be loaded by ResourceLoader when
579 * @param string|array $modules Module name (string) or array of module names
581 public function addModuleScripts( $modules ) {
582 $this->mModuleScripts
= array_merge( $this->mModuleScripts
, (array)$modules );
586 * Get the list of module CSS to include on this page
588 * @param bool $filter
589 * @param string|null $position
591 * @return array Array of module names
593 public function getModuleStyles( $filter = false, $position = null ) {
594 return $this->getModules( $filter, $position, 'mModuleStyles' );
598 * Add only CSS of one or more modules recognized by ResourceLoader.
600 * Module styles added through this function will be added using standard link CSS
601 * tags, rather than as a combined Javascript and CSS package. Thus, they will
602 * load when JavaScript is disabled (unless CSS also happens to be disabled).
604 * @param string|array $modules Module name (string) or array of module names
606 public function addModuleStyles( $modules ) {
607 $this->mModuleStyles
= array_merge( $this->mModuleStyles
, (array)$modules );
611 * @return null|string ResourceLoader target
613 public function getTarget() {
614 return $this->mTarget
;
618 * Sets ResourceLoader target for load.php links. If null, will be omitted
620 * @param string|null $target
622 public function setTarget( $target ) {
623 $this->mTarget
= $target;
627 * Get an array of head items
631 function getHeadItemsArray() {
632 return $this->mHeadItems
;
636 * Add or replace an header item to the output
638 * Whenever possible, use more specific options like ResourceLoader modules,
639 * OutputPage::addLink(), OutputPage::addMetaLink() and OutputPage::addFeedLink()
640 * Fallback options for those are: OutputPage::addStyle, OutputPage::addScript(),
641 * OutputPage::addInlineScript() and OutputPage::addInlineStyle()
642 * This would be your very LAST fallback.
644 * @param string $name Item name
645 * @param string $value Raw HTML
647 public function addHeadItem( $name, $value ) {
648 $this->mHeadItems
[$name] = $value;
652 * Check if the header item $name is already set
654 * @param string $name Item name
657 public function hasHeadItem( $name ) {
658 return isset( $this->mHeadItems
[$name] );
662 * @deprecated since 1.28 Obsolete - wgUseETag experiment was removed.
665 public function setETag( $tag ) {
669 * Set whether the output should only contain the body of the article,
670 * without any skin, sidebar, etc.
671 * Used e.g. when calling with "action=render".
673 * @param bool $only Whether to output only the body of the article
675 public function setArticleBodyOnly( $only ) {
676 $this->mArticleBodyOnly
= $only;
680 * Return whether the output will contain only the body of the article
684 public function getArticleBodyOnly() {
685 return $this->mArticleBodyOnly
;
689 * Set an additional output property
692 * @param string $name
693 * @param mixed $value
695 public function setProperty( $name, $value ) {
696 $this->mProperties
[$name] = $value;
700 * Get an additional output property
703 * @param string $name
704 * @return mixed Property value or null if not found
706 public function getProperty( $name ) {
707 if ( isset( $this->mProperties
[$name] ) ) {
708 return $this->mProperties
[$name];
715 * checkLastModified tells the client to use the client-cached page if
716 * possible. If successful, the OutputPage is disabled so that
717 * any future call to OutputPage->output() have no effect.
719 * Side effect: sets mLastModified for Last-Modified header
721 * @param string $timestamp
723 * @return bool True if cache-ok headers was sent.
725 public function checkLastModified( $timestamp ) {
726 if ( !$timestamp ||
$timestamp == '19700101000000' ) {
727 wfDebug( __METHOD__
. ": CACHE DISABLED, NO TIMESTAMP\n" );
730 $config = $this->getConfig();
731 if ( !$config->get( 'CachePages' ) ) {
732 wfDebug( __METHOD__
. ": CACHE DISABLED\n" );
736 $timestamp = wfTimestamp( TS_MW
, $timestamp );
738 'page' => $timestamp,
739 'user' => $this->getUser()->getTouched(),
740 'epoch' => $config->get( 'CacheEpoch' )
742 if ( $config->get( 'UseSquid' ) ) {
743 // bug 44570: the core page itself may not change, but resources might
744 $modifiedTimes['sepoch'] = wfTimestamp( TS_MW
, time() - $config->get( 'SquidMaxage' ) );
746 Hooks
::run( 'OutputPageCheckLastModified', [ &$modifiedTimes, $this ] );
748 $maxModified = max( $modifiedTimes );
749 $this->mLastModified
= wfTimestamp( TS_RFC2822
, $maxModified );
751 $clientHeader = $this->getRequest()->getHeader( 'If-Modified-Since' );
752 if ( $clientHeader === false ) {
753 wfDebug( __METHOD__
. ": client did not send If-Modified-Since header", 'private' );
757 # IE sends sizes after the date like this:
758 # Wed, 20 Aug 2003 06:51:19 GMT; length=5202
759 # this breaks strtotime().
760 $clientHeader = preg_replace( '/;.*$/', '', $clientHeader );
762 MediaWiki\
suppressWarnings(); // E_STRICT system time bitching
763 $clientHeaderTime = strtotime( $clientHeader );
764 MediaWiki\restoreWarnings
();
765 if ( !$clientHeaderTime ) {
767 . ": unable to parse the client's If-Modified-Since header: $clientHeader\n" );
770 $clientHeaderTime = wfTimestamp( TS_MW
, $clientHeaderTime );
774 foreach ( $modifiedTimes as $name => $value ) {
775 if ( $info !== '' ) {
778 $info .= "$name=" . wfTimestamp( TS_ISO_8601
, $value );
781 wfDebug( __METHOD__
. ": client sent If-Modified-Since: " .
782 wfTimestamp( TS_ISO_8601
, $clientHeaderTime ), 'private' );
783 wfDebug( __METHOD__
. ": effective Last-Modified: " .
784 wfTimestamp( TS_ISO_8601
, $maxModified ), 'private' );
785 if ( $clientHeaderTime < $maxModified ) {
786 wfDebug( __METHOD__
. ": STALE, $info", 'private' );
791 # Give a 304 Not Modified response code and disable body output
792 wfDebug( __METHOD__
. ": NOT MODIFIED, $info", 'private' );
793 ini_set( 'zlib.output_compression', 0 );
794 $this->getRequest()->response()->statusHeader( 304 );
795 $this->sendCacheControl();
798 // Don't output a compressed blob when using ob_gzhandler;
799 // it's technically against HTTP spec and seems to confuse
800 // Firefox when the response gets split over two packets.
801 wfClearOutputBuffers();
807 * Override the last modified timestamp
809 * @param string $timestamp New timestamp, in a format readable by
812 public function setLastModified( $timestamp ) {
813 $this->mLastModified
= wfTimestamp( TS_RFC2822
, $timestamp );
817 * Set the robot policy for the page: <http://www.robotstxt.org/meta.html>
819 * @param string $policy The literal string to output as the contents of
820 * the meta tag. Will be parsed according to the spec and output in
824 public function setRobotPolicy( $policy ) {
825 $policy = Article
::formatRobotPolicy( $policy );
827 if ( isset( $policy['index'] ) ) {
828 $this->setIndexPolicy( $policy['index'] );
830 if ( isset( $policy['follow'] ) ) {
831 $this->setFollowPolicy( $policy['follow'] );
836 * Set the index policy for the page, but leave the follow policy un-
839 * @param string $policy Either 'index' or 'noindex'.
842 public function setIndexPolicy( $policy ) {
843 $policy = trim( $policy );
844 if ( in_array( $policy, [ 'index', 'noindex' ] ) ) {
845 $this->mIndexPolicy
= $policy;
850 * Set the follow policy for the page, but leave the index policy un-
853 * @param string $policy Either 'follow' or 'nofollow'.
856 public function setFollowPolicy( $policy ) {
857 $policy = trim( $policy );
858 if ( in_array( $policy, [ 'follow', 'nofollow' ] ) ) {
859 $this->mFollowPolicy
= $policy;
864 * Set the new value of the "action text", this will be added to the
865 * "HTML title", separated from it with " - ".
867 * @param string $text New value of the "action text"
869 public function setPageTitleActionText( $text ) {
870 $this->mPageTitleActionText
= $text;
874 * Get the value of the "action text"
878 public function getPageTitleActionText() {
879 return $this->mPageTitleActionText
;
883 * "HTML title" means the contents of "<title>".
884 * It is stored as plain, unescaped text and will be run through htmlspecialchars in the skin file.
886 * @param string|Message $name
888 public function setHTMLTitle( $name ) {
889 if ( $name instanceof Message
) {
890 $this->mHTMLtitle
= $name->setContext( $this->getContext() )->text();
892 $this->mHTMLtitle
= $name;
897 * Return the "HTML title", i.e. the content of the "<title>" tag.
901 public function getHTMLTitle() {
902 return $this->mHTMLtitle
;
906 * Set $mRedirectedFrom, the Title of the page which redirected us to the current page.
910 public function setRedirectedFrom( $t ) {
911 $this->mRedirectedFrom
= $t;
915 * "Page title" means the contents of \<h1\>. It is stored as a valid HTML
916 * fragment. This function allows good tags like \<sup\> in the \<h1\> tag,
917 * but not bad tags like \<script\>. This function automatically sets
918 * \<title\> to the same content as \<h1\> but with all tags removed. Bad
919 * tags that were escaped in \<h1\> will still be escaped in \<title\>, and
920 * good tags like \<i\> will be dropped entirely.
922 * @param string|Message $name
924 public function setPageTitle( $name ) {
925 if ( $name instanceof Message
) {
926 $name = $name->setContext( $this->getContext() )->text();
929 # change "<script>foo&bar</script>" to "<script>foo&bar</script>"
930 # but leave "<i>foobar</i>" alone
931 $nameWithTags = Sanitizer
::normalizeCharReferences( Sanitizer
::removeHTMLtags( $name ) );
932 $this->mPagetitle
= $nameWithTags;
934 # change "<i>foo&bar</i>" to "foo&bar"
936 $this->msg( 'pagetitle' )->rawParams( Sanitizer
::stripAllTags( $nameWithTags ) )
937 ->inContentLanguage()
942 * Return the "page title", i.e. the content of the \<h1\> tag.
946 public function getPageTitle() {
947 return $this->mPagetitle
;
951 * Set the Title object to use
955 public function setTitle( Title
$t ) {
956 $this->getContext()->setTitle( $t );
960 * Replace the subtitle with $str
962 * @param string|Message $str New value of the subtitle. String should be safe HTML.
964 public function setSubtitle( $str ) {
965 $this->clearSubtitle();
966 $this->addSubtitle( $str );
970 * Add $str to the subtitle
972 * @param string|Message $str String or Message to add to the subtitle. String should be safe HTML.
974 public function addSubtitle( $str ) {
975 if ( $str instanceof Message
) {
976 $this->mSubtitle
[] = $str->setContext( $this->getContext() )->parse();
978 $this->mSubtitle
[] = $str;
983 * Build message object for a subtitle containing a backlink to a page
985 * @param Title $title Title to link to
986 * @param array $query Array of additional parameters to include in the link
990 public static function buildBacklinkSubtitle( Title
$title, $query = [] ) {
991 if ( $title->isRedirect() ) {
992 $query['redirect'] = 'no';
994 return wfMessage( 'backlinksubtitle' )
995 ->rawParams( Linker
::link( $title, null, [], $query ) );
999 * Add a subtitle containing a backlink to a page
1001 * @param Title $title Title to link to
1002 * @param array $query Array of additional parameters to include in the link
1004 public function addBacklinkSubtitle( Title
$title, $query = [] ) {
1005 $this->addSubtitle( self
::buildBacklinkSubtitle( $title, $query ) );
1009 * Clear the subtitles
1011 public function clearSubtitle() {
1012 $this->mSubtitle
= [];
1020 public function getSubtitle() {
1021 return implode( "<br />\n\t\t\t\t", $this->mSubtitle
);
1025 * Set the page as printable, i.e. it'll be displayed with all
1026 * print styles included
1028 public function setPrintable() {
1029 $this->mPrintable
= true;
1033 * Return whether the page is "printable"
1037 public function isPrintable() {
1038 return $this->mPrintable
;
1042 * Disable output completely, i.e. calling output() will have no effect
1044 public function disable() {
1045 $this->mDoNothing
= true;
1049 * Return whether the output will be completely disabled
1053 public function isDisabled() {
1054 return $this->mDoNothing
;
1058 * Show an "add new section" link?
1062 public function showNewSectionLink() {
1063 return $this->mNewSectionLink
;
1067 * Forcibly hide the new section link?
1071 public function forceHideNewSectionLink() {
1072 return $this->mHideNewSectionLink
;
1076 * Add or remove feed links in the page header
1077 * This is mainly kept for backward compatibility, see OutputPage::addFeedLink()
1078 * for the new version
1079 * @see addFeedLink()
1081 * @param bool $show True: add default feeds, false: remove all feeds
1083 public function setSyndicated( $show = true ) {
1085 $this->setFeedAppendQuery( false );
1087 $this->mFeedLinks
= [];
1092 * Add default feeds to the page header
1093 * This is mainly kept for backward compatibility, see OutputPage::addFeedLink()
1094 * for the new version
1095 * @see addFeedLink()
1097 * @param string $val Query to append to feed links or false to output
1100 public function setFeedAppendQuery( $val ) {
1101 $this->mFeedLinks
= [];
1103 foreach ( $this->getConfig()->get( 'AdvertisedFeedTypes' ) as $type ) {
1104 $query = "feed=$type";
1105 if ( is_string( $val ) ) {
1106 $query .= '&' . $val;
1108 $this->mFeedLinks
[$type] = $this->getTitle()->getLocalURL( $query );
1113 * Add a feed link to the page header
1115 * @param string $format Feed type, should be a key of $wgFeedClasses
1116 * @param string $href URL
1118 public function addFeedLink( $format, $href ) {
1119 if ( in_array( $format, $this->getConfig()->get( 'AdvertisedFeedTypes' ) ) ) {
1120 $this->mFeedLinks
[$format] = $href;
1125 * Should we output feed links for this page?
1128 public function isSyndicated() {
1129 return count( $this->mFeedLinks
) > 0;
1133 * Return URLs for each supported syndication format for this page.
1134 * @return array Associating format keys with URLs
1136 public function getSyndicationLinks() {
1137 return $this->mFeedLinks
;
1141 * Will currently always return null
1145 public function getFeedAppendQuery() {
1146 return $this->mFeedLinksAppendQuery
;
1150 * Set whether the displayed content is related to the source of the
1151 * corresponding article on the wiki
1152 * Setting true will cause the change "article related" toggle to true
1156 public function setArticleFlag( $v ) {
1157 $this->mIsarticle
= $v;
1159 $this->mIsArticleRelated
= $v;
1164 * Return whether the content displayed page is related to the source of
1165 * the corresponding article on the wiki
1169 public function isArticle() {
1170 return $this->mIsarticle
;
1174 * Set whether this page is related an article on the wiki
1175 * Setting false will cause the change of "article flag" toggle to false
1179 public function setArticleRelated( $v ) {
1180 $this->mIsArticleRelated
= $v;
1182 $this->mIsarticle
= false;
1187 * Return whether this page is related an article on the wiki
1191 public function isArticleRelated() {
1192 return $this->mIsArticleRelated
;
1196 * Add new language links
1198 * @param array $newLinkArray Associative array mapping language code to the page
1201 public function addLanguageLinks( array $newLinkArray ) {
1202 $this->mLanguageLinks +
= $newLinkArray;
1206 * Reset the language links and add new language links
1208 * @param array $newLinkArray Associative array mapping language code to the page
1211 public function setLanguageLinks( array $newLinkArray ) {
1212 $this->mLanguageLinks
= $newLinkArray;
1216 * Get the list of language links
1218 * @return array Array of Interwiki Prefixed (non DB key) Titles (e.g. 'fr:Test page')
1220 public function getLanguageLinks() {
1221 return $this->mLanguageLinks
;
1225 * Add an array of categories, with names in the keys
1227 * @param array $categories Mapping category name => sort key
1229 public function addCategoryLinks( array $categories ) {
1232 if ( !is_array( $categories ) ||
count( $categories ) == 0 ) {
1236 # Add the links to a LinkBatch
1237 $arr = [ NS_CATEGORY
=> $categories ];
1238 $lb = new LinkBatch
;
1239 $lb->setArray( $arr );
1241 # Fetch existence plus the hiddencat property
1242 $dbr = wfGetDB( DB_SLAVE
);
1243 $fields = array_merge(
1244 LinkCache
::getSelectFields(),
1245 [ 'page_namespace', 'page_title', 'pp_value' ]
1248 $res = $dbr->select( [ 'page', 'page_props' ],
1250 $lb->constructSet( 'page', $dbr ),
1253 [ 'page_props' => [ 'LEFT JOIN', [
1254 'pp_propname' => 'hiddencat',
1259 # Add the results to the link cache
1260 $lb->addResultToCache( LinkCache
::singleton(), $res );
1262 # Set all the values to 'normal'.
1263 $categories = array_fill_keys( array_keys( $categories ), 'normal' );
1265 # Mark hidden categories
1266 foreach ( $res as $row ) {
1267 if ( isset( $row->pp_value
) ) {
1268 $categories[$row->page_title
] = 'hidden';
1272 # Add the remaining categories to the skin
1274 'OutputPageMakeCategoryLinks',
1275 [ &$this, $categories, &$this->mCategoryLinks
] )
1277 foreach ( $categories as $category => $type ) {
1278 // array keys will cast numeric category names to ints, so cast back to string
1279 $category = (string)$category;
1280 $origcategory = $category;
1281 $title = Title
::makeTitleSafe( NS_CATEGORY
, $category );
1285 $wgContLang->findVariantLink( $category, $title, true );
1286 if ( $category != $origcategory && array_key_exists( $category, $categories ) ) {
1289 $text = $wgContLang->convertHtml( $title->getText() );
1290 $this->mCategories
[] = $title->getText();
1291 $this->mCategoryLinks
[$type][] = Linker
::link( $title, $text );
1297 * Reset the category links (but not the category list) and add $categories
1299 * @param array $categories Mapping category name => sort key
1301 public function setCategoryLinks( array $categories ) {
1302 $this->mCategoryLinks
= [];
1303 $this->addCategoryLinks( $categories );
1307 * Get the list of category links, in a 2-D array with the following format:
1308 * $arr[$type][] = $link, where $type is either "normal" or "hidden" (for
1309 * hidden categories) and $link a HTML fragment with a link to the category
1314 public function getCategoryLinks() {
1315 return $this->mCategoryLinks
;
1319 * Get the list of category names this page belongs to
1321 * @return array Array of strings
1323 public function getCategories() {
1324 return $this->mCategories
;
1328 * Add an array of indicators, with their identifiers as array
1329 * keys and HTML contents as values.
1331 * In case of duplicate keys, existing values are overwritten.
1333 * @param array $indicators
1336 public function setIndicators( array $indicators ) {
1337 $this->mIndicators
= $indicators +
$this->mIndicators
;
1338 // Keep ordered by key
1339 ksort( $this->mIndicators
);
1343 * Get the indicators associated with this page.
1345 * The array will be internally ordered by item keys.
1347 * @return array Keys: identifiers, values: HTML contents
1350 public function getIndicators() {
1351 return $this->mIndicators
;
1355 * Adds help link with an icon via page indicators.
1356 * Link target can be overridden by a local message containing a wikilink:
1357 * the message key is: lowercase action or special page name + '-helppage'.
1358 * @param string $to Target MediaWiki.org page title or encoded URL.
1359 * @param bool $overrideBaseUrl Whether $url is a full URL, to avoid MW.o.
1362 public function addHelpLink( $to, $overrideBaseUrl = false ) {
1363 $this->addModuleStyles( 'mediawiki.helplink' );
1364 $text = $this->msg( 'helppage-top-gethelp' )->escaped();
1366 if ( $overrideBaseUrl ) {
1369 $toUrlencoded = wfUrlencode( str_replace( ' ', '_', $to ) );
1370 $helpUrl = "//www.mediawiki.org/wiki/Special:MyLanguage/$toUrlencoded";
1373 $link = Html
::rawElement(
1377 'target' => '_blank',
1378 'class' => 'mw-helplink',
1383 $this->setIndicators( [ 'mw-helplink' => $link ] );
1387 * Do not allow scripts which can be modified by wiki users to load on this page;
1388 * only allow scripts bundled with, or generated by, the software.
1389 * Site-wide styles are controlled by a config setting, since they can be
1390 * used to create a custom skin/theme, but not user-specific ones.
1392 * @todo this should be given a more accurate name
1394 public function disallowUserJs() {
1395 $this->reduceAllowedModules(
1396 ResourceLoaderModule
::TYPE_SCRIPTS
,
1397 ResourceLoaderModule
::ORIGIN_CORE_INDIVIDUAL
1400 // Site-wide styles are controlled by a config setting, see bug 71621
1401 // for background on why. User styles are never allowed.
1402 if ( $this->getConfig()->get( 'AllowSiteCSSOnRestrictedPages' ) ) {
1403 $styleOrigin = ResourceLoaderModule
::ORIGIN_USER_SITEWIDE
;
1405 $styleOrigin = ResourceLoaderModule
::ORIGIN_CORE_INDIVIDUAL
;
1407 $this->reduceAllowedModules(
1408 ResourceLoaderModule
::TYPE_STYLES
,
1414 * Show what level of JavaScript / CSS untrustworthiness is allowed on this page
1415 * @see ResourceLoaderModule::$origin
1416 * @param string $type ResourceLoaderModule TYPE_ constant
1417 * @return int ResourceLoaderModule ORIGIN_ class constant
1419 public function getAllowedModules( $type ) {
1420 if ( $type == ResourceLoaderModule
::TYPE_COMBINED
) {
1421 return min( array_values( $this->mAllowedModules
) );
1423 return isset( $this->mAllowedModules
[$type] )
1424 ?
$this->mAllowedModules
[$type]
1425 : ResourceLoaderModule
::ORIGIN_ALL
;
1430 * Limit the highest level of CSS/JS untrustworthiness allowed.
1432 * If passed the same or a higher level than the current level of untrustworthiness set, the
1433 * level will remain unchanged.
1435 * @param string $type
1436 * @param int $level ResourceLoaderModule class constant
1438 public function reduceAllowedModules( $type, $level ) {
1439 $this->mAllowedModules
[$type] = min( $this->getAllowedModules( $type ), $level );
1443 * Prepend $text to the body HTML
1445 * @param string $text HTML
1447 public function prependHTML( $text ) {
1448 $this->mBodytext
= $text . $this->mBodytext
;
1452 * Append $text to the body HTML
1454 * @param string $text HTML
1456 public function addHTML( $text ) {
1457 $this->mBodytext
.= $text;
1461 * Shortcut for adding an Html::element via addHTML.
1465 * @param string $element
1466 * @param array $attribs
1467 * @param string $contents
1469 public function addElement( $element, array $attribs = [], $contents = '' ) {
1470 $this->addHTML( Html
::element( $element, $attribs, $contents ) );
1474 * Clear the body HTML
1476 public function clearHTML() {
1477 $this->mBodytext
= '';
1483 * @return string HTML
1485 public function getHTML() {
1486 return $this->mBodytext
;
1490 * Get/set the ParserOptions object to use for wikitext parsing
1492 * @param ParserOptions|null $options Either the ParserOption to use or null to only get the
1493 * current ParserOption object
1494 * @return ParserOptions
1496 public function parserOptions( $options = null ) {
1497 if ( $options !== null && !empty( $options->isBogus
) ) {
1498 // Someone is trying to set a bogus pre-$wgUser PO. Check if it has
1499 // been changed somehow, and keep it if so.
1500 $anonPO = ParserOptions
::newFromAnon();
1501 $anonPO->setEditSection( false );
1502 if ( !$options->matches( $anonPO ) ) {
1503 wfLogWarning( __METHOD__
. ': Setting a changed bogus ParserOptions: ' . wfGetAllCallers( 5 ) );
1504 $options->isBogus
= false;
1508 if ( !$this->mParserOptions
) {
1509 if ( !$this->getContext()->getUser()->isSafeToLoad() ) {
1510 // $wgUser isn't unstubbable yet, so don't try to get a
1511 // ParserOptions for it. And don't cache this ParserOptions
1513 $po = ParserOptions
::newFromAnon();
1514 $po->setEditSection( false );
1515 $po->isBogus
= true;
1516 if ( $options !== null ) {
1517 $this->mParserOptions
= empty( $options->isBogus
) ?
$options : null;
1522 $this->mParserOptions
= ParserOptions
::newFromContext( $this->getContext() );
1523 $this->mParserOptions
->setEditSection( false );
1526 if ( $options !== null && !empty( $options->isBogus
) ) {
1527 // They're trying to restore the bogus pre-$wgUser PO. Do the right
1529 return wfSetVar( $this->mParserOptions
, null, true );
1531 return wfSetVar( $this->mParserOptions
, $options );
1536 * Set the revision ID which will be seen by the wiki text parser
1537 * for things such as embedded {{REVISIONID}} variable use.
1539 * @param int|null $revid An positive integer, or null
1540 * @return mixed Previous value
1542 public function setRevisionId( $revid ) {
1543 $val = is_null( $revid ) ?
null : intval( $revid );
1544 return wfSetVar( $this->mRevisionId
, $val );
1548 * Get the displayed revision ID
1552 public function getRevisionId() {
1553 return $this->mRevisionId
;
1557 * Set the timestamp of the revision which will be displayed. This is used
1558 * to avoid a extra DB call in Skin::lastModified().
1560 * @param string|null $timestamp
1561 * @return mixed Previous value
1563 public function setRevisionTimestamp( $timestamp ) {
1564 return wfSetVar( $this->mRevisionTimestamp
, $timestamp );
1568 * Get the timestamp of displayed revision.
1569 * This will be null if not filled by setRevisionTimestamp().
1571 * @return string|null
1573 public function getRevisionTimestamp() {
1574 return $this->mRevisionTimestamp
;
1578 * Set the displayed file version
1580 * @param File|bool $file
1581 * @return mixed Previous value
1583 public function setFileVersion( $file ) {
1585 if ( $file instanceof File
&& $file->exists() ) {
1586 $val = [ 'time' => $file->getTimestamp(), 'sha1' => $file->getSha1() ];
1588 return wfSetVar( $this->mFileVersion
, $val, true );
1592 * Get the displayed file version
1594 * @return array|null ('time' => MW timestamp, 'sha1' => sha1)
1596 public function getFileVersion() {
1597 return $this->mFileVersion
;
1601 * Get the templates used on this page
1603 * @return array (namespace => dbKey => revId)
1606 public function getTemplateIds() {
1607 return $this->mTemplateIds
;
1611 * Get the files used on this page
1613 * @return array (dbKey => array('time' => MW timestamp or null, 'sha1' => sha1 or ''))
1616 public function getFileSearchOptions() {
1617 return $this->mImageTimeKeys
;
1621 * Convert wikitext to HTML and add it to the buffer
1622 * Default assumes that the current page title will be used.
1624 * @param string $text
1625 * @param bool $linestart Is this the start of a line?
1626 * @param bool $interface Is this text in the user interface language?
1627 * @throws MWException
1629 public function addWikiText( $text, $linestart = true, $interface = true ) {
1630 $title = $this->getTitle(); // Work around E_STRICT
1632 throw new MWException( 'Title is null' );
1634 $this->addWikiTextTitle( $text, $title, $linestart, /*tidy*/false, $interface );
1638 * Add wikitext with a custom Title object
1640 * @param string $text Wikitext
1641 * @param Title $title
1642 * @param bool $linestart Is this the start of a line?
1644 public function addWikiTextWithTitle( $text, &$title, $linestart = true ) {
1645 $this->addWikiTextTitle( $text, $title, $linestart );
1649 * Add wikitext with a custom Title object and tidy enabled.
1651 * @param string $text Wikitext
1652 * @param Title $title
1653 * @param bool $linestart Is this the start of a line?
1655 function addWikiTextTitleTidy( $text, &$title, $linestart = true ) {
1656 $this->addWikiTextTitle( $text, $title, $linestart, true );
1660 * Add wikitext with tidy enabled
1662 * @param string $text Wikitext
1663 * @param bool $linestart Is this the start of a line?
1665 public function addWikiTextTidy( $text, $linestart = true ) {
1666 $title = $this->getTitle();
1667 $this->addWikiTextTitleTidy( $text, $title, $linestart );
1671 * Add wikitext with a custom Title object
1673 * @param string $text Wikitext
1674 * @param Title $title
1675 * @param bool $linestart Is this the start of a line?
1676 * @param bool $tidy Whether to use tidy
1677 * @param bool $interface Whether it is an interface message
1678 * (for example disables conversion)
1680 public function addWikiTextTitle( $text, Title
$title, $linestart,
1681 $tidy = false, $interface = false
1685 $popts = $this->parserOptions();
1686 $oldTidy = $popts->setTidy( $tidy );
1687 $popts->setInterfaceMessage( (bool)$interface );
1689 $parserOutput = $wgParser->getFreshParser()->parse(
1690 $text, $title, $popts,
1691 $linestart, true, $this->mRevisionId
1694 $popts->setTidy( $oldTidy );
1696 $this->addParserOutput( $parserOutput );
1701 * Add a ParserOutput object, but without Html.
1703 * @deprecated since 1.24, use addParserOutputMetadata() instead.
1704 * @param ParserOutput $parserOutput
1706 public function addParserOutputNoText( $parserOutput ) {
1707 wfDeprecated( __METHOD__
, '1.24' );
1708 $this->addParserOutputMetadata( $parserOutput );
1712 * Add all metadata associated with a ParserOutput object, but without the actual HTML. This
1713 * includes categories, language links, ResourceLoader modules, effects of certain magic words,
1717 * @param ParserOutput $parserOutput
1719 public function addParserOutputMetadata( $parserOutput ) {
1720 $this->mLanguageLinks +
= $parserOutput->getLanguageLinks();
1721 $this->addCategoryLinks( $parserOutput->getCategories() );
1722 $this->setIndicators( $parserOutput->getIndicators() );
1723 $this->mNewSectionLink
= $parserOutput->getNewSection();
1724 $this->mHideNewSectionLink
= $parserOutput->getHideNewSection();
1726 if ( !$parserOutput->isCacheable() ) {
1727 $this->enableClientCache( false );
1729 $this->mNoGallery
= $parserOutput->getNoGallery();
1730 $this->mHeadItems
= array_merge( $this->mHeadItems
, $parserOutput->getHeadItems() );
1731 $this->addModules( $parserOutput->getModules() );
1732 $this->addModuleScripts( $parserOutput->getModuleScripts() );
1733 $this->addModuleStyles( $parserOutput->getModuleStyles() );
1734 $this->addJsConfigVars( $parserOutput->getJsConfigVars() );
1735 $this->mPreventClickjacking
= $this->mPreventClickjacking
1736 ||
$parserOutput->preventClickjacking();
1738 // Template versioning...
1739 foreach ( (array)$parserOutput->getTemplateIds() as $ns => $dbks ) {
1740 if ( isset( $this->mTemplateIds
[$ns] ) ) {
1741 $this->mTemplateIds
[$ns] = $dbks +
$this->mTemplateIds
[$ns];
1743 $this->mTemplateIds
[$ns] = $dbks;
1746 // File versioning...
1747 foreach ( (array)$parserOutput->getFileSearchOptions() as $dbk => $data ) {
1748 $this->mImageTimeKeys
[$dbk] = $data;
1751 // Hooks registered in the object
1752 $parserOutputHooks = $this->getConfig()->get( 'ParserOutputHooks' );
1753 foreach ( $parserOutput->getOutputHooks() as $hookInfo ) {
1754 list( $hookName, $data ) = $hookInfo;
1755 if ( isset( $parserOutputHooks[$hookName] ) ) {
1756 call_user_func( $parserOutputHooks[$hookName], $this, $parserOutput, $data );
1760 // Enable OOUI if requested via ParserOutput
1761 if ( $parserOutput->getEnableOOUI() ) {
1762 $this->enableOOUI();
1765 // Include profiling data
1766 $this->limitReportData
= $parserOutput->getLimitReportData();
1768 // Link flags are ignored for now, but may in the future be
1769 // used to mark individual language links.
1771 Hooks
::run( 'LanguageLinks', [ $this->getTitle(), &$this->mLanguageLinks
, &$linkFlags ] );
1772 Hooks
::run( 'OutputPageParserOutput', [ &$this, $parserOutput ] );
1776 * Add the HTML and enhancements for it (like ResourceLoader modules) associated with a
1777 * ParserOutput object, without any other metadata.
1780 * @param ParserOutput $parserOutput
1782 public function addParserOutputContent( $parserOutput ) {
1783 $this->addParserOutputText( $parserOutput );
1785 $this->addModules( $parserOutput->getModules() );
1786 $this->addModuleScripts( $parserOutput->getModuleScripts() );
1787 $this->addModuleStyles( $parserOutput->getModuleStyles() );
1789 $this->addJsConfigVars( $parserOutput->getJsConfigVars() );
1793 * Add the HTML associated with a ParserOutput object, without any metadata.
1796 * @param ParserOutput $parserOutput
1798 public function addParserOutputText( $parserOutput ) {
1799 $text = $parserOutput->getText();
1800 Hooks
::run( 'OutputPageBeforeHTML', [ &$this, &$text ] );
1801 $this->addHTML( $text );
1805 * Add everything from a ParserOutput object.
1807 * @param ParserOutput $parserOutput
1809 function addParserOutput( $parserOutput ) {
1810 $this->addParserOutputMetadata( $parserOutput );
1811 $parserOutput->setTOCEnabled( $this->mEnableTOC
);
1813 // Touch section edit links only if not previously disabled
1814 if ( $parserOutput->getEditSectionTokens() ) {
1815 $parserOutput->setEditSectionTokens( $this->mEnableSectionEditLinks
);
1818 $this->addParserOutputText( $parserOutput );
1822 * Add the output of a QuickTemplate to the output buffer
1824 * @param QuickTemplate $template
1826 public function addTemplate( &$template ) {
1827 $this->addHTML( $template->getHTML() );
1831 * Parse wikitext and return the HTML.
1833 * @param string $text
1834 * @param bool $linestart Is this the start of a line?
1835 * @param bool $interface Use interface language ($wgLang instead of
1836 * $wgContLang) while parsing language sensitive magic words like GRAMMAR and PLURAL.
1837 * This also disables LanguageConverter.
1838 * @param Language $language Target language object, will override $interface
1839 * @throws MWException
1840 * @return string HTML
1842 public function parse( $text, $linestart = true, $interface = false, $language = null ) {
1845 if ( is_null( $this->getTitle() ) ) {
1846 throw new MWException( 'Empty $mTitle in ' . __METHOD__
);
1849 $popts = $this->parserOptions();
1851 $popts->setInterfaceMessage( true );
1853 if ( $language !== null ) {
1854 $oldLang = $popts->setTargetLanguage( $language );
1857 $parserOutput = $wgParser->getFreshParser()->parse(
1858 $text, $this->getTitle(), $popts,
1859 $linestart, true, $this->mRevisionId
1863 $popts->setInterfaceMessage( false );
1865 if ( $language !== null ) {
1866 $popts->setTargetLanguage( $oldLang );
1869 return $parserOutput->getText();
1873 * Parse wikitext, strip paragraphs, and return the HTML.
1875 * @param string $text
1876 * @param bool $linestart Is this the start of a line?
1877 * @param bool $interface Use interface language ($wgLang instead of
1878 * $wgContLang) while parsing language sensitive magic
1879 * words like GRAMMAR and PLURAL
1880 * @return string HTML
1882 public function parseInline( $text, $linestart = true, $interface = false ) {
1883 $parsed = $this->parse( $text, $linestart, $interface );
1884 return Parser
::stripOuterParagraph( $parsed );
1889 * @deprecated since 1.27 Use setCdnMaxage() instead
1891 public function setSquidMaxage( $maxage ) {
1892 $this->setCdnMaxage( $maxage );
1896 * Set the value of the "s-maxage" part of the "Cache-control" HTTP header
1898 * @param int $maxage Maximum cache time on the CDN, in seconds.
1900 public function setCdnMaxage( $maxage ) {
1901 $this->mCdnMaxage
= min( $maxage, $this->mCdnMaxageLimit
);
1905 * Lower the value of the "s-maxage" part of the "Cache-control" HTTP header
1907 * @param int $maxage Maximum cache time on the CDN, in seconds
1910 public function lowerCdnMaxage( $maxage ) {
1911 $this->mCdnMaxageLimit
= min( $maxage, $this->mCdnMaxageLimit
);
1912 $this->setCdnMaxage( $this->mCdnMaxage
);
1916 * Use enableClientCache(false) to force it to send nocache headers
1918 * @param bool $state
1922 public function enableClientCache( $state ) {
1923 return wfSetVar( $this->mEnableClientCache
, $state );
1927 * Get the list of cookies that will influence on the cache
1931 function getCacheVaryCookies() {
1933 if ( $cookies === null ) {
1934 $config = $this->getConfig();
1935 $cookies = array_merge(
1936 SessionManager
::singleton()->getVaryCookies(),
1940 $config->get( 'CacheVaryCookies' )
1942 Hooks
::run( 'GetCacheVaryCookies', [ $this, &$cookies ] );
1948 * Check if the request has a cache-varying cookie header
1949 * If it does, it's very important that we don't allow public caching
1953 function haveCacheVaryCookies() {
1954 $request = $this->getRequest();
1955 foreach ( $this->getCacheVaryCookies() as $cookieName ) {
1956 if ( $request->getCookie( $cookieName, '', '' ) !== '' ) {
1957 wfDebug( __METHOD__
. ": found $cookieName\n" );
1961 wfDebug( __METHOD__
. ": no cache-varying cookies found\n" );
1966 * Add an HTTP header that will influence on the cache
1968 * @param string $header Header name
1969 * @param string[]|null $option Options for the Key header. See
1970 * https://datatracker.ietf.org/doc/draft-fielding-http-key/
1971 * for the list of valid options.
1973 public function addVaryHeader( $header, array $option = null ) {
1974 if ( !array_key_exists( $header, $this->mVaryHeader
) ) {
1975 $this->mVaryHeader
[$header] = [];
1977 if ( !is_array( $option ) ) {
1980 $this->mVaryHeader
[$header] = array_unique( array_merge( $this->mVaryHeader
[$header], $option ) );
1984 * Return a Vary: header on which to vary caches. Based on the keys of $mVaryHeader,
1985 * such as Accept-Encoding or Cookie
1989 public function getVaryHeader() {
1990 // If we vary on cookies, let's make sure it's always included here too.
1991 if ( $this->getCacheVaryCookies() ) {
1992 $this->addVaryHeader( 'Cookie' );
1995 foreach ( SessionManager
::singleton()->getVaryHeaders() as $header => $options ) {
1996 $this->addVaryHeader( $header, $options );
1998 return 'Vary: ' . implode( ', ', array_keys( $this->mVaryHeader
) );
2002 * Get a complete Key header
2006 public function getKeyHeader() {
2007 $cvCookies = $this->getCacheVaryCookies();
2009 $cookiesOption = [];
2010 foreach ( $cvCookies as $cookieName ) {
2011 $cookiesOption[] = 'param=' . $cookieName;
2013 $this->addVaryHeader( 'Cookie', $cookiesOption );
2015 foreach ( SessionManager
::singleton()->getVaryHeaders() as $header => $options ) {
2016 $this->addVaryHeader( $header, $options );
2020 foreach ( $this->mVaryHeader
as $header => $option ) {
2021 $newheader = $header;
2022 if ( is_array( $option ) && count( $option ) > 0 ) {
2023 $newheader .= ';' . implode( ';', $option );
2025 $headers[] = $newheader;
2027 $key = 'Key: ' . implode( ',', $headers );
2033 * T23672: Add Accept-Language to Vary and Key headers
2034 * if there's no 'variant' parameter existed in GET.
2037 * /w/index.php?title=Main_page should always be served; but
2038 * /w/index.php?title=Main_page&variant=zh-cn should never be served.
2040 function addAcceptLanguage() {
2041 $title = $this->getTitle();
2042 if ( !$title instanceof Title
) {
2046 $lang = $title->getPageLanguage();
2047 if ( !$this->getRequest()->getCheck( 'variant' ) && $lang->hasVariants() ) {
2048 $variants = $lang->getVariants();
2050 foreach ( $variants as $variant ) {
2051 if ( $variant === $lang->getCode() ) {
2054 $aloption[] = 'substr=' . $variant;
2056 // IE and some other browsers use BCP 47 standards in
2057 // their Accept-Language header, like "zh-CN" or "zh-Hant".
2058 // We should handle these too.
2059 $variantBCP47 = wfBCP47( $variant );
2060 if ( $variantBCP47 !== $variant ) {
2061 $aloption[] = 'substr=' . $variantBCP47;
2065 $this->addVaryHeader( 'Accept-Language', $aloption );
2070 * Set a flag which will cause an X-Frame-Options header appropriate for
2071 * edit pages to be sent. The header value is controlled by
2072 * $wgEditPageFrameOptions.
2074 * This is the default for special pages. If you display a CSRF-protected
2075 * form on an ordinary view page, then you need to call this function.
2077 * @param bool $enable
2079 public function preventClickjacking( $enable = true ) {
2080 $this->mPreventClickjacking
= $enable;
2084 * Turn off frame-breaking. Alias for $this->preventClickjacking(false).
2085 * This can be called from pages which do not contain any CSRF-protected
2088 public function allowClickjacking() {
2089 $this->mPreventClickjacking
= false;
2093 * Get the prevent-clickjacking flag
2098 public function getPreventClickjacking() {
2099 return $this->mPreventClickjacking
;
2103 * Get the X-Frame-Options header value (without the name part), or false
2104 * if there isn't one. This is used by Skin to determine whether to enable
2105 * JavaScript frame-breaking, for clients that don't support X-Frame-Options.
2109 public function getFrameOptions() {
2110 $config = $this->getConfig();
2111 if ( $config->get( 'BreakFrames' ) ) {
2113 } elseif ( $this->mPreventClickjacking
&& $config->get( 'EditPageFrameOptions' ) ) {
2114 return $config->get( 'EditPageFrameOptions' );
2120 * Send cache control HTTP headers
2122 public function sendCacheControl() {
2123 $response = $this->getRequest()->response();
2124 $config = $this->getConfig();
2126 $this->addVaryHeader( 'Cookie' );
2127 $this->addAcceptLanguage();
2129 # don't serve compressed data to clients who can't handle it
2130 # maintain different caches for logged-in users and non-logged in ones
2131 $response->header( $this->getVaryHeader() );
2133 if ( $config->get( 'UseKeyHeader' ) ) {
2134 $response->header( $this->getKeyHeader() );
2137 if ( $this->mEnableClientCache
) {
2139 $config->get( 'UseSquid' ) &&
2140 !$response->hasCookies() &&
2141 !SessionManager
::getGlobalSession()->isPersistent() &&
2142 !$this->isPrintable() &&
2143 $this->mCdnMaxage
!= 0 &&
2144 !$this->haveCacheVaryCookies()
2146 if ( $config->get( 'UseESI' ) ) {
2147 # We'll purge the proxy cache explicitly, but require end user agents
2148 # to revalidate against the proxy on each visit.
2149 # Surrogate-Control controls our CDN, Cache-Control downstream caches
2150 wfDebug( __METHOD__
. ": proxy caching with ESI; {$this->mLastModified} **", 'private' );
2151 # start with a shorter timeout for initial testing
2152 # header( 'Surrogate-Control: max-age=2678400+2678400, content="ESI/1.0"');
2153 $response->header( 'Surrogate-Control: max-age=' . $config->get( 'SquidMaxage' )
2154 . '+' . $this->mCdnMaxage
. ', content="ESI/1.0"' );
2155 $response->header( 'Cache-Control: s-maxage=0, must-revalidate, max-age=0' );
2157 # We'll purge the proxy cache for anons explicitly, but require end user agents
2158 # to revalidate against the proxy on each visit.
2159 # IMPORTANT! The CDN needs to replace the Cache-Control header with
2160 # Cache-Control: s-maxage=0, must-revalidate, max-age=0
2161 wfDebug( __METHOD__
. ": local proxy caching; {$this->mLastModified} **", 'private' );
2162 # start with a shorter timeout for initial testing
2163 # header( "Cache-Control: s-maxage=2678400, must-revalidate, max-age=0" );
2164 $response->header( 'Cache-Control: s-maxage=' . $this->mCdnMaxage
2165 . ', must-revalidate, max-age=0' );
2168 # We do want clients to cache if they can, but they *must* check for updates
2169 # on revisiting the page.
2170 wfDebug( __METHOD__
. ": private caching; {$this->mLastModified} **", 'private' );
2171 $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
2172 $response->header( "Cache-Control: private, must-revalidate, max-age=0" );
2174 if ( $this->mLastModified
) {
2175 $response->header( "Last-Modified: {$this->mLastModified}" );
2178 wfDebug( __METHOD__
. ": no caching **", 'private' );
2180 # In general, the absence of a last modified header should be enough to prevent
2181 # the client from using its cache. We send a few other things just to make sure.
2182 $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
2183 $response->header( 'Cache-Control: no-cache, no-store, max-age=0, must-revalidate' );
2184 $response->header( 'Pragma: no-cache' );
2189 * Finally, all the text has been munged and accumulated into
2190 * the object, let's actually output it:
2192 public function output() {
2193 if ( $this->mDoNothing
) {
2197 $response = $this->getRequest()->response();
2198 $config = $this->getConfig();
2200 if ( $this->mRedirect
!= '' ) {
2201 # Standards require redirect URLs to be absolute
2202 $this->mRedirect
= wfExpandUrl( $this->mRedirect
, PROTO_CURRENT
);
2204 $redirect = $this->mRedirect
;
2205 $code = $this->mRedirectCode
;
2207 if ( Hooks
::run( "BeforePageRedirect", [ $this, &$redirect, &$code ] ) ) {
2208 if ( $code == '301' ||
$code == '303' ) {
2209 if ( !$config->get( 'DebugRedirects' ) ) {
2210 $response->statusHeader( $code );
2212 $this->mLastModified
= wfTimestamp( TS_RFC2822
);
2214 if ( $config->get( 'VaryOnXFP' ) ) {
2215 $this->addVaryHeader( 'X-Forwarded-Proto' );
2217 $this->sendCacheControl();
2219 $response->header( "Content-Type: text/html; charset=utf-8" );
2220 if ( $config->get( 'DebugRedirects' ) ) {
2221 $url = htmlspecialchars( $redirect );
2222 print "<html>\n<head>\n<title>Redirect</title>\n</head>\n<body>\n";
2223 print "<p>Location: <a href=\"$url\">$url</a></p>\n";
2224 print "</body>\n</html>\n";
2226 $response->header( 'Location: ' . $redirect );
2231 } elseif ( $this->mStatusCode
) {
2232 $response->statusHeader( $this->mStatusCode
);
2235 # Buffer output; final headers may depend on later processing
2238 $response->header( 'Content-type: ' . $config->get( 'MimeType' ) . '; charset=UTF-8' );
2239 $response->header( 'Content-language: ' . $config->get( 'LanguageCode' ) );
2241 // Avoid Internet Explorer "compatibility view" in IE 8-10, so that
2242 // jQuery etc. can work correctly.
2243 $response->header( 'X-UA-Compatible: IE=Edge' );
2245 // Prevent framing, if requested
2246 $frameOptions = $this->getFrameOptions();
2247 if ( $frameOptions ) {
2248 $response->header( "X-Frame-Options: $frameOptions" );
2251 if ( $this->mArticleBodyOnly
) {
2252 echo $this->mBodytext
;
2254 $sk = $this->getSkin();
2255 // add skin specific modules
2256 $modules = $sk->getDefaultModules();
2258 // Enforce various default modules for all skins
2260 // Keep this list as small as possible
2262 'mediawiki.page.startup',
2266 // Support for high-density display images if enabled
2267 if ( $config->get( 'ResponsiveImages' ) ) {
2268 $coreModules[] = 'mediawiki.hidpi';
2271 $this->addModules( $coreModules );
2272 foreach ( $modules as $group ) {
2273 $this->addModules( $group );
2275 MWDebug
::addModules( $this );
2277 // Hook that allows last minute changes to the output page, e.g.
2278 // adding of CSS or Javascript by extensions.
2279 Hooks
::run( 'BeforePageDisplay', [ &$this, &$sk ] );
2283 } catch ( Exception
$e ) {
2284 ob_end_clean(); // bug T129657
2290 // This hook allows last minute changes to final overall output by modifying output buffer
2291 Hooks
::run( 'AfterFinalPageOutput', [ $this ] );
2292 } catch ( Exception
$e ) {
2293 ob_end_clean(); // bug T129657
2297 $this->sendCacheControl();
2304 * Prepare this object to display an error page; disable caching and
2305 * indexing, clear the current text and redirect, set the page's title
2306 * and optionally an custom HTML title (content of the "<title>" tag).
2308 * @param string|Message $pageTitle Will be passed directly to setPageTitle()
2309 * @param string|Message $htmlTitle Will be passed directly to setHTMLTitle();
2310 * optional, if not passed the "<title>" attribute will be
2311 * based on $pageTitle
2313 public function prepareErrorPage( $pageTitle, $htmlTitle = false ) {
2314 $this->setPageTitle( $pageTitle );
2315 if ( $htmlTitle !== false ) {
2316 $this->setHTMLTitle( $htmlTitle );
2318 $this->setRobotPolicy( 'noindex,nofollow' );
2319 $this->setArticleRelated( false );
2320 $this->enableClientCache( false );
2321 $this->mRedirect
= '';
2322 $this->clearSubtitle();
2327 * Output a standard error page
2329 * showErrorPage( 'titlemsg', 'pagetextmsg' );
2330 * showErrorPage( 'titlemsg', 'pagetextmsg', array( 'param1', 'param2' ) );
2331 * showErrorPage( 'titlemsg', $messageObject );
2332 * showErrorPage( $titleMessageObject, $messageObject );
2334 * @param string|Message $title Message key (string) for page title, or a Message object
2335 * @param string|Message $msg Message key (string) for page text, or a Message object
2336 * @param array $params Message parameters; ignored if $msg is a Message object
2338 public function showErrorPage( $title, $msg, $params = [] ) {
2339 if ( !$title instanceof Message
) {
2340 $title = $this->msg( $title );
2343 $this->prepareErrorPage( $title );
2345 if ( $msg instanceof Message
) {
2346 if ( $params !== [] ) {
2347 trigger_error( 'Argument ignored: $params. The message parameters argument '
2348 . 'is discarded when the $msg argument is a Message object instead of '
2349 . 'a string.', E_USER_NOTICE
);
2351 $this->addHTML( $msg->parseAsBlock() );
2353 $this->addWikiMsgArray( $msg, $params );
2356 $this->returnToMain();
2360 * Output a standard permission error page
2362 * @param array $errors Error message keys
2363 * @param string $action Action that was denied or null if unknown
2365 public function showPermissionsErrorPage( array $errors, $action = null ) {
2366 // For some action (read, edit, create and upload), display a "login to do this action"
2367 // error if all of the following conditions are met:
2368 // 1. the user is not logged in
2369 // 2. the only error is insufficient permissions (i.e. no block or something else)
2370 // 3. the error can be avoided simply by logging in
2371 if ( in_array( $action, [ 'read', 'edit', 'createpage', 'createtalk', 'upload' ] )
2372 && $this->getUser()->isAnon() && count( $errors ) == 1 && isset( $errors[0][0] )
2373 && ( $errors[0][0] == 'badaccess-groups' ||
$errors[0][0] == 'badaccess-group0' )
2374 && ( User
::groupHasPermission( 'user', $action )
2375 || User
::groupHasPermission( 'autoconfirmed', $action ) )
2377 $displayReturnto = null;
2379 # Due to bug 32276, if a user does not have read permissions,
2380 # $this->getTitle() will just give Special:Badtitle, which is
2381 # not especially useful as a returnto parameter. Use the title
2382 # from the request instead, if there was one.
2383 $request = $this->getRequest();
2384 $returnto = Title
::newFromText( $request->getVal( 'title', '' ) );
2385 if ( $action == 'edit' ) {
2386 $msg = 'whitelistedittext';
2387 $displayReturnto = $returnto;
2388 } elseif ( $action == 'createpage' ||
$action == 'createtalk' ) {
2389 $msg = 'nocreatetext';
2390 } elseif ( $action == 'upload' ) {
2391 $msg = 'uploadnologintext';
2393 $msg = 'loginreqpagetext';
2394 $displayReturnto = Title
::newMainPage();
2400 $query['returnto'] = $returnto->getPrefixedText();
2402 if ( !$request->wasPosted() ) {
2403 $returntoquery = $request->getValues();
2404 unset( $returntoquery['title'] );
2405 unset( $returntoquery['returnto'] );
2406 unset( $returntoquery['returntoquery'] );
2407 $query['returntoquery'] = wfArrayToCgi( $returntoquery );
2410 $loginLink = Linker
::linkKnown(
2411 SpecialPage
::getTitleFor( 'Userlogin' ),
2412 $this->msg( 'loginreqlink' )->escaped(),
2417 $this->prepareErrorPage( $this->msg( 'loginreqtitle' ) );
2418 $this->addHTML( $this->msg( $msg )->rawParams( $loginLink )->parse() );
2420 # Don't return to a page the user can't read otherwise
2421 # we'll end up in a pointless loop
2422 if ( $displayReturnto && $displayReturnto->userCan( 'read', $this->getUser() ) ) {
2423 $this->returnToMain( null, $displayReturnto );
2426 $this->prepareErrorPage( $this->msg( 'permissionserrors' ) );
2427 $this->addWikiText( $this->formatPermissionsErrorMessage( $errors, $action ) );
2432 * Display an error page indicating that a given version of MediaWiki is
2433 * required to use it
2435 * @param mixed $version The version of MediaWiki needed to use the page
2437 public function versionRequired( $version ) {
2438 $this->prepareErrorPage( $this->msg( 'versionrequired', $version ) );
2440 $this->addWikiMsg( 'versionrequiredtext', $version );
2441 $this->returnToMain();
2445 * Format a list of error messages
2447 * @param array $errors Array of arrays returned by Title::getUserPermissionsErrors
2448 * @param string $action Action that was denied or null if unknown
2449 * @return string The wikitext error-messages, formatted into a list.
2451 public function formatPermissionsErrorMessage( array $errors, $action = null ) {
2452 if ( $action == null ) {
2453 $text = $this->msg( 'permissionserrorstext', count( $errors ) )->plain() . "\n\n";
2455 $action_desc = $this->msg( "action-$action" )->plain();
2457 'permissionserrorstext-withaction',
2460 )->plain() . "\n\n";
2463 if ( count( $errors ) > 1 ) {
2464 $text .= '<ul class="permissions-errors">' . "\n";
2466 foreach ( $errors as $error ) {
2468 $text .= call_user_func_array( [ $this, 'msg' ], $error )->plain();
2473 $text .= "<div class=\"permissions-errors\">\n" .
2474 call_user_func_array( [ $this, 'msg' ], reset( $errors ) )->plain() .
2482 * Display a page stating that the Wiki is in read-only mode.
2483 * Should only be called after wfReadOnly() has returned true.
2485 * Historically, this function was used to show the source of the page that the user
2486 * was trying to edit and _also_ permissions error messages. The relevant code was
2487 * moved into EditPage in 1.19 (r102024 / d83c2a431c2a) and removed here in 1.25.
2489 * @deprecated since 1.25; throw the exception directly
2490 * @throws ReadOnlyError
2492 public function readOnlyPage() {
2493 if ( func_num_args() > 0 ) {
2494 throw new MWException( __METHOD__
. ' no longer accepts arguments since 1.25.' );
2497 throw new ReadOnlyError
;
2501 * Turn off regular page output and return an error response
2502 * for when rate limiting has triggered.
2504 * @deprecated since 1.25; throw the exception directly
2506 public function rateLimited() {
2507 wfDeprecated( __METHOD__
, '1.25' );
2508 throw new ThrottledError
;
2512 * Show a warning about slave lag
2514 * If the lag is higher than $wgSlaveLagCritical seconds,
2515 * then the warning is a bit more obvious. If the lag is
2516 * lower than $wgSlaveLagWarning, then no warning is shown.
2518 * @param int $lag Slave lag
2520 public function showLagWarning( $lag ) {
2521 $config = $this->getConfig();
2522 if ( $lag >= $config->get( 'SlaveLagWarning' ) ) {
2523 $message = $lag < $config->get( 'SlaveLagCritical' )
2526 $wrap = Html
::rawElement( 'div', [ 'class' => "mw-{$message}" ], "\n$1\n" );
2527 $this->wrapWikiMsg( "$wrap\n", [ $message, $this->getLanguage()->formatNum( $lag ) ] );
2531 public function showFatalError( $message ) {
2532 $this->prepareErrorPage( $this->msg( 'internalerror' ) );
2534 $this->addHTML( $message );
2537 public function showUnexpectedValueError( $name, $val ) {
2538 $this->showFatalError( $this->msg( 'unexpected', $name, $val )->text() );
2541 public function showFileCopyError( $old, $new ) {
2542 $this->showFatalError( $this->msg( 'filecopyerror', $old, $new )->text() );
2545 public function showFileRenameError( $old, $new ) {
2546 $this->showFatalError( $this->msg( 'filerenameerror', $old, $new )->text() );
2549 public function showFileDeleteError( $name ) {
2550 $this->showFatalError( $this->msg( 'filedeleteerror', $name )->text() );
2553 public function showFileNotFoundError( $name ) {
2554 $this->showFatalError( $this->msg( 'filenotfound', $name )->text() );
2558 * Add a "return to" link pointing to a specified title
2560 * @param Title $title Title to link
2561 * @param array $query Query string parameters
2562 * @param string $text Text of the link (input is not escaped)
2563 * @param array $options Options array to pass to Linker
2565 public function addReturnTo( $title, array $query = [], $text = null, $options = [] ) {
2566 $link = $this->msg( 'returnto' )->rawParams(
2567 Linker
::link( $title, $text, [], $query, $options ) )->escaped();
2568 $this->addHTML( "<p id=\"mw-returnto\">{$link}</p>\n" );
2572 * Add a "return to" link pointing to a specified title,
2573 * or the title indicated in the request, or else the main page
2575 * @param mixed $unused
2576 * @param Title|string $returnto Title or String to return to
2577 * @param string $returntoquery Query string for the return to link
2579 public function returnToMain( $unused = null, $returnto = null, $returntoquery = null ) {
2580 if ( $returnto == null ) {
2581 $returnto = $this->getRequest()->getText( 'returnto' );
2584 if ( $returntoquery == null ) {
2585 $returntoquery = $this->getRequest()->getText( 'returntoquery' );
2588 if ( $returnto === '' ) {
2589 $returnto = Title
::newMainPage();
2592 if ( is_object( $returnto ) ) {
2593 $titleObj = $returnto;
2595 $titleObj = Title
::newFromText( $returnto );
2597 if ( !is_object( $titleObj ) ) {
2598 $titleObj = Title
::newMainPage();
2601 $this->addReturnTo( $titleObj, wfCgiToArray( $returntoquery ) );
2605 * @param Skin $sk The given Skin
2606 * @param bool $includeStyle Unused
2607 * @return string The doctype, opening "<html>", and head element.
2609 public function headElement( Skin
$sk, $includeStyle = true ) {
2612 $userdir = $this->getLanguage()->getDir();
2613 $sitedir = $wgContLang->getDir();
2616 $pieces[] = Html
::htmlHeader( $sk->getHtmlElementAttributes() );
2618 if ( $this->getHTMLTitle() == '' ) {
2619 $this->setHTMLTitle( $this->msg( 'pagetitle', $this->getPageTitle() )->inContentLanguage() );
2622 $openHead = Html
::openElement( 'head' );
2624 $pieces[] = $openHead;
2627 if ( !Html
::isXmlMimeType( $this->getConfig()->get( 'MimeType' ) ) ) {
2628 // Add <meta charset="UTF-8">
2629 // This should be before <title> since it defines the charset used by
2630 // text including the text inside <title>.
2631 // The spec recommends defining XHTML5's charset using the XML declaration
2633 // Our XML declaration is output by Html::htmlHeader.
2634 // http://www.whatwg.org/html/semantics.html#attr-meta-http-equiv-content-type
2635 // http://www.whatwg.org/html/semantics.html#charset
2636 $pieces[] = Html
::element( 'meta', [ 'charset' => 'UTF-8' ] );
2639 $pieces[] = Html
::element( 'title', null, $this->getHTMLTitle() );
2640 $pieces[] = $this->getInlineHeadScripts();
2641 $pieces[] = $this->buildCssLinks();
2642 $pieces[] = $this->getExternalHeadScripts();
2644 foreach ( $this->getHeadLinksArray() as $item ) {
2648 foreach ( $this->mHeadItems
as $item ) {
2652 $closeHead = Html
::closeElement( 'head' );
2654 $pieces[] = $closeHead;
2658 $bodyClasses[] = 'mediawiki';
2660 # Classes for LTR/RTL directionality support
2661 $bodyClasses[] = $userdir;
2662 $bodyClasses[] = "sitedir-$sitedir";
2664 if ( $this->getLanguage()->capitalizeAllNouns() ) {
2665 # A <body> class is probably not the best way to do this . . .
2666 $bodyClasses[] = 'capitalize-all-nouns';
2669 // Parser feature migration class
2670 // The idea is that this will eventually be removed, after the wikitext
2671 // which requires it is cleaned up.
2672 $bodyClasses[] = 'mw-hide-empty-elt';
2674 $bodyClasses[] = $sk->getPageClasses( $this->getTitle() );
2675 $bodyClasses[] = 'skin-' . Sanitizer
::escapeClass( $sk->getSkinName() );
2677 'action-' . Sanitizer
::escapeClass( Action
::getActionName( $this->getContext() ) );
2680 // While the implode() is not strictly needed, it's used for backwards compatibility
2681 // (this used to be built as a string and hooks likely still expect that).
2682 $bodyAttrs['class'] = implode( ' ', $bodyClasses );
2684 // Allow skins and extensions to add body attributes they need
2685 $sk->addToBodyAttributes( $this, $bodyAttrs );
2686 Hooks
::run( 'OutputPageBodyAttributes', [ $this, $sk, &$bodyAttrs ] );
2688 $pieces[] = Html
::openElement( 'body', $bodyAttrs );
2690 return WrappedStringList
::join( "\n", $pieces );
2694 * Get a ResourceLoader object associated with this OutputPage
2696 * @return ResourceLoader
2698 public function getResourceLoader() {
2699 if ( is_null( $this->mResourceLoader
) ) {
2700 $this->mResourceLoader
= new ResourceLoader(
2702 LoggerFactory
::getInstance( 'resourceloader' )
2705 return $this->mResourceLoader
;
2709 * Construct neccecary html and loader preset states to load modules on a page.
2711 * Use getHtmlFromLoaderLinks() to convert this array to HTML.
2713 * @param array|string $modules One or more module names
2714 * @param string $only ResourceLoaderModule TYPE_ class constant
2715 * @param array $extraQuery [optional] Array with extra query parameters for the request
2716 * @return array A list of HTML strings and array of client loader preset states
2718 public function makeResourceLoaderLink( $modules, $only, array $extraQuery = [] ) {
2719 $modules = (array)$modules;
2722 // List of html strings
2724 // Associative array of module names and their states
2728 if ( !count( $modules ) ) {
2732 if ( count( $modules ) > 1 ) {
2733 // Remove duplicate module requests
2734 $modules = array_unique( $modules );
2735 // Sort module names so requests are more uniform
2738 if ( ResourceLoader
::inDebugMode() ) {
2739 // Recursively call us for every item
2740 foreach ( $modules as $name ) {
2741 $link = $this->makeResourceLoaderLink( $name, $only, $extraQuery );
2742 $links['html'] = array_merge( $links['html'], $link['html'] );
2743 $links['states'] +
= $link['states'];
2749 if ( !is_null( $this->mTarget
) ) {
2750 $extraQuery['target'] = $this->mTarget
;
2753 // Create keyed-by-source and then keyed-by-group list of module objects from modules list
2754 $sortedModules = [];
2755 $resourceLoader = $this->getResourceLoader();
2756 foreach ( $modules as $name ) {
2757 $module = $resourceLoader->getModule( $name );
2758 # Check that we're allowed to include this module on this page
2760 ||
( $module->getOrigin() > $this->getAllowedModules( ResourceLoaderModule
::TYPE_SCRIPTS
)
2761 && $only == ResourceLoaderModule
::TYPE_SCRIPTS
)
2762 ||
( $module->getOrigin() > $this->getAllowedModules( ResourceLoaderModule
::TYPE_STYLES
)
2763 && $only == ResourceLoaderModule
::TYPE_STYLES
)
2764 ||
( $module->getOrigin() > $this->getAllowedModules( ResourceLoaderModule
::TYPE_COMBINED
)
2765 && $only == ResourceLoaderModule
::TYPE_COMBINED
)
2766 ||
( $this->mTarget
&& !in_array( $this->mTarget
, $module->getTargets() ) )
2771 if ( $only === ResourceLoaderModule
::TYPE_STYLES
) {
2772 if ( $module->getType() !== ResourceLoaderModule
::LOAD_STYLES
) {
2773 $logger = $resourceLoader->getLogger();
2774 $logger->debug( 'Unexpected general module "{module}" in styles queue.', [
2778 $links['states'][$name] = 'ready';
2782 $sortedModules[$module->getSource()][$module->getGroup()][$name] = $module;
2785 foreach ( $sortedModules as $source => $groups ) {
2786 foreach ( $groups as $group => $grpModules ) {
2787 // Special handling for user-specific groups
2789 if ( ( $group === 'user' ||
$group === 'private' ) && $this->getUser()->isLoggedIn() ) {
2790 $user = $this->getUser()->getName();
2793 // Create a fake request based on the one we are about to make so modules return
2794 // correct timestamp and emptiness data
2795 $query = ResourceLoader
::makeLoaderQuery(
2796 [], // modules; not determined yet
2797 $this->getLanguage()->getCode(),
2798 $this->getSkin()->getSkinName(),
2800 null, // version; not determined yet
2801 ResourceLoader
::inDebugMode(),
2802 $only === ResourceLoaderModule
::TYPE_COMBINED ?
null : $only,
2803 $this->isPrintable(),
2804 $this->getRequest()->getBool( 'handheld' ),
2807 $context = new ResourceLoaderContext( $resourceLoader, new FauxRequest( $query ) );
2809 // Extract modules that know they're empty and see if we have one or more
2812 foreach ( $grpModules as $key => $module ) {
2813 // Inline empty modules: since they're empty, just mark them as 'ready' (bug 46857)
2814 // If we're only getting the styles, we don't need to do anything for empty modules.
2815 if ( $module->isKnownEmpty( $context ) ) {
2816 unset( $grpModules[$key] );
2817 if ( $only !== ResourceLoaderModule
::TYPE_STYLES
) {
2818 $links['states'][$key] = 'ready';
2822 $isRaw |
= $module->isRaw();
2825 // If there are no non-empty modules, skip this group
2826 if ( count( $grpModules ) === 0 ) {
2830 // Inline private modules. These can't be loaded through load.php for security
2831 // reasons, see bug 34907. Note that these modules should be loaded from
2832 // getExternalHeadScripts() before the first loader call. Otherwise other modules can't
2833 // properly use them as dependencies (bug 30914)
2834 if ( $group === 'private' ) {
2835 if ( $only == ResourceLoaderModule
::TYPE_STYLES
) {
2836 $links['html'][] = Html
::inlineStyle(
2837 $resourceLoader->makeModuleResponse( $context, $grpModules )
2840 $links['html'][] = ResourceLoader
::makeInlineScript(
2841 $resourceLoader->makeModuleResponse( $context, $grpModules )
2847 // Special handling for the user group; because users might change their stuff
2848 // on-wiki like user pages, or user preferences; we need to find the highest
2849 // timestamp of these user-changeable modules so we can ensure cache misses on change
2850 // This should NOT be done for the site group (bug 27564) because anons get that too
2851 // and we shouldn't be putting timestamps in CDN-cached HTML
2853 if ( $group === 'user' ) {
2854 $query['version'] = $resourceLoader->getCombinedVersion( $context, array_keys( $grpModules ) );
2857 $query['modules'] = ResourceLoader
::makePackedModulesString( array_keys( $grpModules ) );
2858 $moduleContext = new ResourceLoaderContext( $resourceLoader, new FauxRequest( $query ) );
2859 $url = $resourceLoader->createLoaderURL( $source, $moduleContext, $extraQuery );
2861 // Automatically select style/script elements
2862 if ( $only === ResourceLoaderModule
::TYPE_STYLES
) {
2863 $link = Html
::linkedStyle( $url );
2865 if ( $context->getRaw() ||
$isRaw ) {
2866 // Startup module can't load itself, needs to use <script> instead of mw.loader.load
2867 $link = Html
::element( 'script', [
2868 // In SpecialJavaScriptTest, QUnit must load synchronous
2869 'async' => !isset( $extraQuery['sync'] ),
2873 $link = ResourceLoader
::makeInlineScript(
2874 Xml
::encodeJsCall( 'mw.loader.load', [ $url ] )
2878 // For modules requested directly in the html via <script> or mw.loader.load
2879 // tell mw.loader they are being loading to prevent duplicate requests.
2880 foreach ( $grpModules as $key => $module ) {
2881 // Don't output state=loading for the startup module.
2882 if ( $key !== 'startup' ) {
2883 $links['states'][$key] = 'loading';
2888 if ( $group == 'noscript' ) {
2889 $links['html'][] = Html
::rawElement( 'noscript', [], $link );
2891 $links['html'][] = $link;
2900 * Build html output from an array of links from makeResourceLoaderLink.
2901 * @param array $links
2902 * @return string|WrappedStringList HTML
2904 protected static function getHtmlFromLoaderLinks( array $links ) {
2907 foreach ( $links as $link ) {
2908 if ( !is_array( $link ) ) {
2911 $html = array_merge( $html, $link['html'] );
2912 $states +
= $link['states'];
2915 // Filter out empty values
2916 $html = array_filter( $html, 'strlen' );
2919 array_unshift( $html, ResourceLoader
::makeInlineScript(
2920 ResourceLoader
::makeLoaderStateScript( $states )
2924 return WrappedString
::join( "\n", $html );
2928 * JS stuff to put in the "<head>". This is the startup module, config
2929 * vars and modules marked with position 'top'
2931 * @return string HTML fragment
2933 function getHeadScripts() {
2934 return $this->getInlineHeadScripts() . $this->getExternalHeadScripts();
2938 * <script src="..."> tags for "<head>".This is the startup module
2939 * and other modules marked with position 'top'.
2941 * @return string|WrappedStringList HTML
2943 function getExternalHeadScripts() {
2944 // Startup - this provides the client with the module
2945 // manifest and loads jquery and mediawiki base modules
2947 $links[] = $this->makeResourceLoaderLink( 'startup', ResourceLoaderModule
::TYPE_SCRIPTS
);
2948 return self
::getHtmlFromLoaderLinks( $links );
2952 * Inline "<script>" tags to put in "<head>".
2954 * @return string|WrappedStringList HTML
2956 function getInlineHeadScripts() {
2959 // Client profile classes for <html>. Allows for easy hiding/showing of UI components.
2960 // Must be done synchronously on every page to avoid flashes of wrong content.
2961 // Note: This class distinguishes MediaWiki-supported JavaScript from the rest.
2962 // The "rest" includes browsers that support JavaScript but not supported by our runtime.
2963 // For the performance benefit of the majority, this is added unconditionally here and is
2964 // then fixed up by the startup module for unsupported browsers.
2965 $links[] = Html
::inlineScript(
2966 'document.documentElement.className = document.documentElement.className'
2967 . '.replace( /(^|\s)client-nojs(\s|$)/, "$1client-js$2" );'
2970 // Load config before anything else
2971 $links[] = ResourceLoader
::makeInlineScript(
2972 ResourceLoader
::makeConfigSetScript( $this->getJSVars() )
2975 // Load embeddable private modules before any loader links
2976 // This needs to be TYPE_COMBINED so these modules are properly wrapped
2977 // in mw.loader.implement() calls and deferred until mw.user is available
2978 $embedScripts = [ 'user.options' ];
2979 $links[] = $this->makeResourceLoaderLink(
2981 ResourceLoaderModule
::TYPE_COMBINED
2983 // Separate user.tokens as otherwise caching will be allowed (T84960)
2984 $links[] = $this->makeResourceLoaderLink(
2986 ResourceLoaderModule
::TYPE_COMBINED
2989 // Modules requests - let the client calculate dependencies and batch requests as it likes
2990 // Only load modules that have marked themselves for loading at the top
2991 $modules = $this->getModules( true, 'top' );
2993 $links[] = ResourceLoader
::makeInlineScript(
2994 Xml
::encodeJsCall( 'mw.loader.load', [ $modules ] )
2998 // "Scripts only" modules marked for top inclusion
2999 $links[] = $this->makeResourceLoaderLink(
3000 $this->getModuleScripts( true, 'top' ),
3001 ResourceLoaderModule
::TYPE_SCRIPTS
3004 return self
::getHtmlFromLoaderLinks( $links );
3008 * JS stuff to put at the 'bottom', which goes at the bottom of the `<body>`.
3009 * These are modules marked with position 'bottom', legacy scripts ($this->mScripts),
3010 * site JS, and user JS.
3012 * @param bool $unused Previously used to let this method change its output based
3013 * on whether it was called by getExternalHeadScripts() or getBottomScripts().
3014 * @return string|WrappedStringList HTML
3016 function getScriptsForBottomQueue( $unused = null ) {
3017 // Scripts "only" requests marked for bottom inclusion
3018 // If we're in the <head>, use load() calls rather than <script src="..."> tags
3021 $links[] = $this->makeResourceLoaderLink( $this->getModuleScripts( true, 'bottom' ),
3022 ResourceLoaderModule
::TYPE_SCRIPTS
3025 // Modules requests - let the client calculate dependencies and batch requests as it likes
3026 // Only load modules that have marked themselves for loading at the bottom
3027 $modules = $this->getModules( true, 'bottom' );
3029 $links[] = ResourceLoader
::makeInlineScript(
3030 Xml
::encodeJsCall( 'mw.loader.load', [ $modules ] )
3035 $links[] = $this->mScripts
;
3037 // Add user JS if enabled
3038 // This must use TYPE_COMBINED instead of only=scripts so that its request is handled by
3039 // mw.loader.implement() which ensures that execution is scheduled after the "site" module.
3040 if ( $this->getConfig()->get( 'AllowUserJs' )
3041 && $this->getUser()->isLoggedIn()
3042 && $this->getTitle()
3043 && $this->getTitle()->isJsSubpage()
3044 && $this->userCanPreview()
3046 // We're on a preview of a JS subpage. Exclude this page from the user module (T28283)
3047 // and include the draft contents as a raw script instead.
3048 $links[] = $this->makeResourceLoaderLink( 'user', ResourceLoaderModule
::TYPE_COMBINED
,
3049 [ 'excludepage' => $this->getTitle()->getPrefixedDBkey() ]
3051 // Load the previewed JS
3052 $links[] = ResourceLoader
::makeInlineScript(
3053 Xml
::encodeJsCall( 'mw.loader.using', [
3057 . Xml
::encodeJsCall( '$.globalEval', [
3058 $this->getRequest()->getText( 'wpTextbox1' )
3065 // FIXME: If the user is previewing, say, ./vector.js, his ./common.js will be loaded
3066 // asynchronously and may arrive *after* the inline script here. So the previewed code
3067 // may execute before ./common.js runs. Normally, ./common.js runs before ./vector.js.
3068 // Similarly, when previewing ./common.js and the user module does arrive first,
3069 // it will arrive without common.js and the inline script runs after.
3070 // Thus running common after the excluded subpage.
3072 // Include the user module normally, i.e., raw to avoid it being wrapped in a closure.
3073 $links[] = $this->makeResourceLoaderLink( 'user', ResourceLoaderModule
::TYPE_COMBINED
);
3076 return self
::getHtmlFromLoaderLinks( $links );
3080 * JS stuff to put at the bottom of the "<body>"
3083 function getBottomScripts() {
3084 return $this->getScriptsForBottomQueue() .
3085 ResourceLoader
::makeInlineScript(
3086 ResourceLoader
::makeConfigSetScript(
3087 [ 'wgPageParseReport' => $this->limitReportData
],
3094 * Get the javascript config vars to include on this page
3096 * @return array Array of javascript config vars
3099 public function getJsConfigVars() {
3100 return $this->mJsConfigVars
;
3104 * Add one or more variables to be set in mw.config in JavaScript
3106 * @param string|array $keys Key or array of key/value pairs
3107 * @param mixed $value [optional] Value of the configuration variable
3109 public function addJsConfigVars( $keys, $value = null ) {
3110 if ( is_array( $keys ) ) {
3111 foreach ( $keys as $key => $value ) {
3112 $this->mJsConfigVars
[$key] = $value;
3117 $this->mJsConfigVars
[$keys] = $value;
3121 * Get an array containing the variables to be set in mw.config in JavaScript.
3123 * Do not add things here which can be evaluated in ResourceLoaderStartUpModule
3124 * - in other words, page-independent/site-wide variables (without state).
3125 * You will only be adding bloat to the html page and causing page caches to
3126 * have to be purged on configuration changes.
3129 public function getJSVars() {
3134 $canonicalSpecialPageName = false; # bug 21115
3136 $title = $this->getTitle();
3137 $ns = $title->getNamespace();
3138 $canonicalNamespace = MWNamespace
::exists( $ns )
3139 ? MWNamespace
::getCanonicalName( $ns )
3140 : $title->getNsText();
3142 $sk = $this->getSkin();
3143 // Get the relevant title so that AJAX features can use the correct page name
3144 // when making API requests from certain special pages (bug 34972).
3145 $relevantTitle = $sk->getRelevantTitle();
3146 $relevantUser = $sk->getRelevantUser();
3148 if ( $ns == NS_SPECIAL
) {
3149 list( $canonicalSpecialPageName, /*...*/ ) =
3150 SpecialPageFactory
::resolveAlias( $title->getDBkey() );
3151 } elseif ( $this->canUseWikiPage() ) {
3152 $wikiPage = $this->getWikiPage();
3153 $curRevisionId = $wikiPage->getLatest();
3154 $articleId = $wikiPage->getId();
3157 $lang = $title->getPageViewLanguage();
3159 // Pre-process information
3160 $separatorTransTable = $lang->separatorTransformTable();
3161 $separatorTransTable = $separatorTransTable ?
$separatorTransTable : [];
3162 $compactSeparatorTransTable = [
3163 implode( "\t", array_keys( $separatorTransTable ) ),
3164 implode( "\t", $separatorTransTable ),
3166 $digitTransTable = $lang->digitTransformTable();
3167 $digitTransTable = $digitTransTable ?
$digitTransTable : [];
3168 $compactDigitTransTable = [
3169 implode( "\t", array_keys( $digitTransTable ) ),
3170 implode( "\t", $digitTransTable ),
3173 $user = $this->getUser();
3176 'wgCanonicalNamespace' => $canonicalNamespace,
3177 'wgCanonicalSpecialPageName' => $canonicalSpecialPageName,
3178 'wgNamespaceNumber' => $title->getNamespace(),
3179 'wgPageName' => $title->getPrefixedDBkey(),
3180 'wgTitle' => $title->getText(),
3181 'wgCurRevisionId' => $curRevisionId,
3182 'wgRevisionId' => (int)$this->getRevisionId(),
3183 'wgArticleId' => $articleId,
3184 'wgIsArticle' => $this->isArticle(),
3185 'wgIsRedirect' => $title->isRedirect(),
3186 'wgAction' => Action
::getActionName( $this->getContext() ),
3187 'wgUserName' => $user->isAnon() ?
null : $user->getName(),
3188 'wgUserGroups' => $user->getEffectiveGroups(),
3189 'wgCategories' => $this->getCategories(),
3190 'wgBreakFrames' => $this->getFrameOptions() == 'DENY',
3191 'wgPageContentLanguage' => $lang->getCode(),
3192 'wgPageContentModel' => $title->getContentModel(),
3193 'wgSeparatorTransformTable' => $compactSeparatorTransTable,
3194 'wgDigitTransformTable' => $compactDigitTransTable,
3195 'wgDefaultDateFormat' => $lang->getDefaultDateFormat(),
3196 'wgMonthNames' => $lang->getMonthNamesArray(),
3197 'wgMonthNamesShort' => $lang->getMonthAbbreviationsArray(),
3198 'wgRelevantPageName' => $relevantTitle->getPrefixedDBkey(),
3199 'wgRelevantArticleId' => $relevantTitle->getArticleID(),
3200 'wgRequestId' => WebRequest
::getRequestId(),
3203 if ( $user->isLoggedIn() ) {
3204 $vars['wgUserId'] = $user->getId();
3205 $vars['wgUserEditCount'] = $user->getEditCount();
3206 $userReg = wfTimestampOrNull( TS_UNIX
, $user->getRegistration() );
3207 $vars['wgUserRegistration'] = $userReg !== null ?
( $userReg * 1000 ) : null;
3208 // Get the revision ID of the oldest new message on the user's talk
3209 // page. This can be used for constructing new message alerts on
3211 $vars['wgUserNewMsgRevisionId'] = $user->getNewMessageRevisionId();
3214 if ( $wgContLang->hasVariants() ) {
3215 $vars['wgUserVariant'] = $wgContLang->getPreferredVariant();
3217 // Same test as SkinTemplate
3218 $vars['wgIsProbablyEditable'] = $title->quickUserCan( 'edit', $user )
3219 && ( $title->exists() ||
$title->quickUserCan( 'create', $user ) );
3221 foreach ( $title->getRestrictionTypes() as $type ) {
3222 $vars['wgRestriction' . ucfirst( $type )] = $title->getRestrictions( $type );
3225 if ( $title->isMainPage() ) {
3226 $vars['wgIsMainPage'] = true;
3229 if ( $this->mRedirectedFrom
) {
3230 $vars['wgRedirectedFrom'] = $this->mRedirectedFrom
->getPrefixedDBkey();
3233 if ( $relevantUser ) {
3234 $vars['wgRelevantUserName'] = $relevantUser->getName();
3237 // Allow extensions to add their custom variables to the mw.config map.
3238 // Use the 'ResourceLoaderGetConfigVars' hook if the variable is not
3239 // page-dependant but site-wide (without state).
3240 // Alternatively, you may want to use OutputPage->addJsConfigVars() instead.
3241 Hooks
::run( 'MakeGlobalVariablesScript', [ &$vars, $this ] );
3243 // Merge in variables from addJsConfigVars last
3244 return array_merge( $vars, $this->getJsConfigVars() );
3248 * To make it harder for someone to slip a user a fake
3249 * user-JavaScript or user-CSS preview, a random token
3250 * is associated with the login session. If it's not
3251 * passed back with the preview request, we won't render
3256 public function userCanPreview() {
3257 $request = $this->getRequest();
3259 $request->getVal( 'action' ) !== 'submit' ||
3260 !$request->getCheck( 'wpPreview' ) ||
3261 !$request->wasPosted()
3266 $user = $this->getUser();
3267 if ( !$user->matchEditToken( $request->getVal( 'wpEditToken' ) ) ) {
3271 $title = $this->getTitle();
3272 if ( !$title->isJsSubpage() && !$title->isCssSubpage() ) {
3275 if ( !$title->isSubpageOf( $user->getUserPage() ) ) {
3276 // Don't execute another user's CSS or JS on preview (T85855)
3280 $errors = $title->getUserPermissionsErrors( 'edit', $user );
3281 if ( count( $errors ) !== 0 ) {
3289 * @return array Array in format "link name or number => 'link html'".
3291 public function getHeadLinksArray() {
3295 $config = $this->getConfig();
3297 $canonicalUrl = $this->mCanonicalUrl
;
3299 $tags['meta-generator'] = Html
::element( 'meta', [
3300 'name' => 'generator',
3301 'content' => "MediaWiki $wgVersion",
3304 if ( $config->get( 'ReferrerPolicy' ) !== false ) {
3305 $tags['meta-referrer'] = Html
::element( 'meta', [
3306 'name' => 'referrer',
3307 'content' => $config->get( 'ReferrerPolicy' )
3311 $p = "{$this->mIndexPolicy},{$this->mFollowPolicy}";
3312 if ( $p !== 'index,follow' ) {
3313 // http://www.robotstxt.org/wc/meta-user.html
3314 // Only show if it's different from the default robots policy
3315 $tags['meta-robots'] = Html
::element( 'meta', [
3321 foreach ( $this->mMetatags
as $tag ) {
3322 if ( 0 == strcasecmp( 'http:', substr( $tag[0], 0, 5 ) ) ) {
3324 $tag[0] = substr( $tag[0], 5 );
3328 $tagName = "meta-{$tag[0]}";
3329 if ( isset( $tags[$tagName] ) ) {
3330 $tagName .= $tag[1];
3332 $tags[$tagName] = Html
::element( 'meta',
3335 'content' => $tag[1]
3340 foreach ( $this->mLinktags
as $tag ) {
3341 $tags[] = Html
::element( 'link', $tag );
3344 # Universal edit button
3345 if ( $config->get( 'UniversalEditButton' ) && $this->isArticleRelated() ) {
3346 $user = $this->getUser();
3347 if ( $this->getTitle()->quickUserCan( 'edit', $user )
3348 && ( $this->getTitle()->exists() ||
3349 $this->getTitle()->quickUserCan( 'create', $user ) )
3351 // Original UniversalEditButton
3352 $msg = $this->msg( 'edit' )->text();
3353 $tags['universal-edit-button'] = Html
::element( 'link', [
3354 'rel' => 'alternate',
3355 'type' => 'application/x-wiki',
3357 'href' => $this->getTitle()->getEditURL(),
3359 // Alternate edit link
3360 $tags['alternative-edit'] = Html
::element( 'link', [
3363 'href' => $this->getTitle()->getEditURL(),
3368 # Generally the order of the favicon and apple-touch-icon links
3369 # should not matter, but Konqueror (3.5.9 at least) incorrectly
3370 # uses whichever one appears later in the HTML source. Make sure
3371 # apple-touch-icon is specified first to avoid this.
3372 if ( $config->get( 'AppleTouchIcon' ) !== false ) {
3373 $tags['apple-touch-icon'] = Html
::element( 'link', [
3374 'rel' => 'apple-touch-icon',
3375 'href' => $config->get( 'AppleTouchIcon' )
3379 if ( $config->get( 'Favicon' ) !== false ) {
3380 $tags['favicon'] = Html
::element( 'link', [
3381 'rel' => 'shortcut icon',
3382 'href' => $config->get( 'Favicon' )
3386 # OpenSearch description link
3387 $tags['opensearch'] = Html
::element( 'link', [
3389 'type' => 'application/opensearchdescription+xml',
3390 'href' => wfScript( 'opensearch_desc' ),
3391 'title' => $this->msg( 'opensearch-desc' )->inContentLanguage()->text(),
3394 if ( $config->get( 'EnableAPI' ) ) {
3395 # Real Simple Discovery link, provides auto-discovery information
3396 # for the MediaWiki API (and potentially additional custom API
3397 # support such as WordPress or Twitter-compatible APIs for a
3398 # blogging extension, etc)
3399 $tags['rsd'] = Html
::element( 'link', [
3401 'type' => 'application/rsd+xml',
3402 // Output a protocol-relative URL here if $wgServer is protocol-relative.
3403 // Whether RSD accepts relative or protocol-relative URLs is completely
3404 // undocumented, though.
3405 'href' => wfExpandUrl( wfAppendQuery(
3407 [ 'action' => 'rsd' ] ),
3414 if ( !$config->get( 'DisableLangConversion' ) ) {
3415 $lang = $this->getTitle()->getPageLanguage();
3416 if ( $lang->hasVariants() ) {
3417 $variants = $lang->getVariants();
3418 foreach ( $variants as $variant ) {
3419 $tags["variant-$variant"] = Html
::element( 'link', [
3420 'rel' => 'alternate',
3421 'hreflang' => wfBCP47( $variant ),
3422 'href' => $this->getTitle()->getLocalURL(
3423 [ 'variant' => $variant ] )
3427 # x-default link per https://support.google.com/webmasters/answer/189077?hl=en
3428 $tags["variant-x-default"] = Html
::element( 'link', [
3429 'rel' => 'alternate',
3430 'hreflang' => 'x-default',
3431 'href' => $this->getTitle()->getLocalURL() ] );
3436 if ( $this->copyrightUrl
!== null ) {
3437 $copyright = $this->copyrightUrl
;
3440 if ( $config->get( 'RightsPage' ) ) {
3441 $copy = Title
::newFromText( $config->get( 'RightsPage' ) );
3444 $copyright = $copy->getLocalURL();
3448 if ( !$copyright && $config->get( 'RightsUrl' ) ) {
3449 $copyright = $config->get( 'RightsUrl' );
3454 $tags['copyright'] = Html
::element( 'link', [
3455 'rel' => 'copyright',
3456 'href' => $copyright ]
3461 if ( $config->get( 'Feed' ) ) {
3464 foreach ( $this->getSyndicationLinks() as $format => $link ) {
3465 # Use the page name for the title. In principle, this could
3466 # lead to issues with having the same name for different feeds
3467 # corresponding to the same page, but we can't avoid that at
3470 $feedLinks[] = $this->feedLink(
3473 # Used messages: 'page-rss-feed' and 'page-atom-feed' (for an easier grep)
3475 "page-{$format}-feed", $this->getTitle()->getPrefixedText()
3480 # Recent changes feed should appear on every page (except recentchanges,
3481 # that would be redundant). Put it after the per-page feed to avoid
3482 # changing existing behavior. It's still available, probably via a
3483 # menu in your browser. Some sites might have a different feed they'd
3484 # like to promote instead of the RC feed (maybe like a "Recent New Articles"
3485 # or "Breaking news" one). For this, we see if $wgOverrideSiteFeed is defined.
3486 # If so, use it instead.
3487 $sitename = $config->get( 'Sitename' );
3488 if ( $config->get( 'OverrideSiteFeed' ) ) {
3489 foreach ( $config->get( 'OverrideSiteFeed' ) as $type => $feedUrl ) {
3490 // Note, this->feedLink escapes the url.
3491 $feedLinks[] = $this->feedLink(
3494 $this->msg( "site-{$type}-feed", $sitename )->text()
3497 } elseif ( !$this->getTitle()->isSpecial( 'Recentchanges' ) ) {
3498 $rctitle = SpecialPage
::getTitleFor( 'Recentchanges' );
3499 foreach ( $config->get( 'AdvertisedFeedTypes' ) as $format ) {
3500 $feedLinks[] = $this->feedLink(
3502 $rctitle->getLocalURL( [ 'feed' => $format ] ),
3503 # For grep: 'site-rss-feed', 'site-atom-feed'
3504 $this->msg( "site-{$format}-feed", $sitename )->text()
3509 # Allow extensions to change the list pf feeds. This hook is primarily for changing,
3510 # manipulating or removing existing feed tags. If you want to add new feeds, you should
3511 # use OutputPage::addFeedLink() instead.
3512 Hooks
::run( 'AfterBuildFeedLinks', [ &$feedLinks ] );
3514 $tags +
= $feedLinks;
3518 if ( $config->get( 'EnableCanonicalServerLink' ) ) {
3519 if ( $canonicalUrl !== false ) {
3520 $canonicalUrl = wfExpandUrl( $canonicalUrl, PROTO_CANONICAL
);
3522 if ( $this->isArticleRelated() ) {
3523 // This affects all requests where "setArticleRelated" is true. This is
3524 // typically all requests that show content (query title, curid, oldid, diff),
3525 // and all wikipage actions (edit, delete, purge, info, history etc.).
3526 // It does not apply to File pages and Special pages.
3527 // 'history' and 'info' actions address page metadata rather than the page
3528 // content itself, so they may not be canonicalized to the view page url.
3529 // TODO: this ought to be better encapsulated in the Action class.
3530 $action = Action
::getActionName( $this->getContext() );
3531 if ( in_array( $action, [ 'history', 'info' ] ) ) {
3532 $query = "action={$action}";
3536 $canonicalUrl = $this->getTitle()->getCanonicalURL( $query );
3538 $reqUrl = $this->getRequest()->getRequestURL();
3539 $canonicalUrl = wfExpandUrl( $reqUrl, PROTO_CANONICAL
);
3543 if ( $canonicalUrl !== false ) {
3544 $tags[] = Html
::element( 'link', [
3545 'rel' => 'canonical',
3546 'href' => $canonicalUrl
3554 * @return string HTML tag links to be put in the header.
3555 * @deprecated since 1.24 Use OutputPage::headElement or if you have to,
3556 * OutputPage::getHeadLinksArray directly.
3558 public function getHeadLinks() {
3559 wfDeprecated( __METHOD__
, '1.24' );
3560 return implode( "\n", $this->getHeadLinksArray() );
3564 * Generate a "<link rel/>" for a feed.
3566 * @param string $type Feed type
3567 * @param string $url URL to the feed
3568 * @param string $text Value of the "title" attribute
3569 * @return string HTML fragment
3571 private function feedLink( $type, $url, $text ) {
3572 return Html
::element( 'link', [
3573 'rel' => 'alternate',
3574 'type' => "application/$type+xml",
3581 * Add a local or specified stylesheet, with the given media options.
3582 * Internal use only. Use OutputPage::addModuleStyles() if possible.
3584 * @param string $style URL to the file
3585 * @param string $media To specify a media type, 'screen', 'printable', 'handheld' or any.
3586 * @param string $condition For IE conditional comments, specifying an IE version
3587 * @param string $dir Set to 'rtl' or 'ltr' for direction-specific sheets
3589 public function addStyle( $style, $media = '', $condition = '', $dir = '' ) {
3592 $options['media'] = $media;
3595 $options['condition'] = $condition;
3598 $options['dir'] = $dir;
3600 $this->styles
[$style] = $options;
3604 * Adds inline CSS styles
3605 * Internal use only. Use OutputPage::addModuleStyles() if possible.
3607 * @param mixed $style_css Inline CSS
3608 * @param string $flip Set to 'flip' to flip the CSS if needed
3610 public function addInlineStyle( $style_css, $flip = 'noflip' ) {
3611 if ( $flip === 'flip' && $this->getLanguage()->isRTL() ) {
3612 # If wanted, and the interface is right-to-left, flip the CSS
3613 $style_css = CSSJanus
::transform( $style_css, true, false );
3615 $this->mInlineStyles
.= Html
::inlineStyle( $style_css );
3619 * Build a set of "<link>" elements for stylesheets specified in the $this->styles array.
3621 * @return string|WrappedStringList HTML
3623 public function buildCssLinks() {
3626 $this->getSkin()->setupSkinUserCss( $this );
3628 // Add ResourceLoader styles
3629 // Split the styles into these groups
3638 $otherTags = []; // Tags to append after the normal <link> tags
3639 $resourceLoader = $this->getResourceLoader();
3641 $moduleStyles = $this->getModuleStyles();
3643 // Per-site custom styles
3644 $moduleStyles[] = 'site.styles';
3645 $moduleStyles[] = 'noscript';
3647 // Per-user custom styles
3648 if ( $this->getConfig()->get( 'AllowUserCss' ) && $this->getTitle()->isCssSubpage()
3649 && $this->userCanPreview()
3651 // We're on a preview of a CSS subpage
3652 // Exclude this page from the user module in case it's in there (bug 26283)
3653 $link = $this->makeResourceLoaderLink( 'user', ResourceLoaderModule
::TYPE_STYLES
,
3654 [ 'excludepage' => $this->getTitle()->getPrefixedDBkey() ]
3656 $otherTags = array_merge( $otherTags, $link['html'] );
3658 // Load the previewed CSS
3659 // If needed, Janus it first. This is user-supplied CSS, so it's
3660 // assumed to be right for the content language directionality.
3661 $previewedCSS = $this->getRequest()->getText( 'wpTextbox1' );
3662 if ( $this->getLanguage()->getDir() !== $wgContLang->getDir() ) {
3663 $previewedCSS = CSSJanus
::transform( $previewedCSS, true, false );
3665 $otherTags[] = Html
::inlineStyle( $previewedCSS );
3667 // Load the user styles normally
3668 $moduleStyles[] = 'user';
3671 // Per-user preference styles
3672 $moduleStyles[] = 'user.cssprefs';
3674 foreach ( $moduleStyles as $name ) {
3675 $module = $resourceLoader->getModule( $name );
3679 if ( $name === 'site.styles' ) {
3680 // HACK: The site module shouldn't be fragmented with a cache group and
3681 // http request. But in order to ensure its styles are separated and after the
3682 // ResourceLoaderDynamicStyles marker, pretend it is in a group called 'site'.
3683 // The scripts remain ungrouped and rides the bottom queue.
3684 $styles['site'][] = $name;
3687 $group = $module->getGroup();
3688 // Modules in groups other than the ones needing special treatment
3689 // (see $styles assignment)
3690 // will be placed in the "other" style category.
3691 $styles[isset( $styles[$group] ) ?
$group : 'other'][] = $name;
3694 // We want site, private and user styles to override dynamically added
3695 // styles from modules, but we want dynamically added styles to override
3696 // statically added styles from other modules. So the order has to be
3697 // other, dynamic, site, private, user. Add statically added styles for
3699 $links[] = $this->makeResourceLoaderLink(
3701 ResourceLoaderModule
::TYPE_STYLES
3703 // Add normal styles added through addStyle()/addInlineStyle() here
3704 $links[] = implode( '', $this->buildCssLinksArray() ) . $this->mInlineStyles
;
3705 // Add marker tag to mark the place where the client-side
3706 // loader should inject dynamic styles
3707 // We use a <meta> tag with a made-up name for this because that's valid HTML
3708 $links[] = Html
::element(
3710 [ 'name' => 'ResourceLoaderDynamicStyles', 'content' => '' ]
3713 // Add site-specific and user-specific styles
3714 // 'private' at present only contains user.options, so put that before 'user'
3715 // Any future private modules will likely have a similar user-specific character
3716 foreach ( [ 'site', 'noscript', 'private', 'user' ] as $group ) {
3717 $links[] = $this->makeResourceLoaderLink( $styles[$group],
3718 ResourceLoaderModule
::TYPE_STYLES
3722 // Add stuff in $otherTags (previewed user CSS if applicable)
3723 $links[] = implode( '', $otherTags );
3725 return self
::getHtmlFromLoaderLinks( $links );
3731 public function buildCssLinksArray() {
3734 // Add any extension CSS
3735 foreach ( $this->mExtStyles
as $url ) {
3736 $this->addStyle( $url );
3738 $this->mExtStyles
= [];
3740 foreach ( $this->styles
as $file => $options ) {
3741 $link = $this->styleLink( $file, $options );
3743 $links[$file] = $link;
3750 * Generate \<link\> tags for stylesheets
3752 * @param string $style URL to the file
3753 * @param array $options Option, can contain 'condition', 'dir', 'media' keys
3754 * @return string HTML fragment
3756 protected function styleLink( $style, array $options ) {
3757 if ( isset( $options['dir'] ) ) {
3758 if ( $this->getLanguage()->getDir() != $options['dir'] ) {
3763 if ( isset( $options['media'] ) ) {
3764 $media = self
::transformCssMedia( $options['media'] );
3765 if ( is_null( $media ) ) {
3772 if ( substr( $style, 0, 1 ) == '/' ||
3773 substr( $style, 0, 5 ) == 'http:' ||
3774 substr( $style, 0, 6 ) == 'https:' ) {
3777 $config = $this->getConfig();
3778 $url = $config->get( 'StylePath' ) . '/' . $style . '?' .
3779 $config->get( 'StyleVersion' );
3782 $link = Html
::linkedStyle( $url, $media );
3784 if ( isset( $options['condition'] ) ) {
3785 $condition = htmlspecialchars( $options['condition'] );
3786 $link = "<!--[if $condition]>$link<![endif]-->";
3792 * Transform path to web-accessible static resource.
3794 * This is used to add a validation hash as query string.
3795 * This aids various behaviors:
3797 * - Put long Cache-Control max-age headers on responses for improved
3798 * cache performance.
3799 * - Get the correct version of a file as expected by the current page.
3800 * - Instantly get the updated version of a file after deployment.
3802 * Avoid using this for urls included in HTML as otherwise clients may get different
3803 * versions of a resource when navigating the site depending on when the page was cached.
3804 * If changes to the url propagate, this is not a problem (e.g. if the url is in
3805 * an external stylesheet).
3808 * @param Config $config
3809 * @param string $path Path-absolute URL to file (from document root, must start with "/")
3810 * @return string URL
3812 public static function transformResourcePath( Config
$config, $path ) {
3814 $remotePathPrefix = $config->get( 'ResourceBasePath' );
3815 if ( $remotePathPrefix === '' ) {
3816 // The configured base path is required to be empty string for
3817 // wikis in the domain root
3820 $remotePath = $remotePathPrefix;
3822 if ( strpos( $path, $remotePath ) !== 0 ) {
3823 // Path is outside wgResourceBasePath, ignore.
3826 $path = RelPath\
getRelativePath( $path, $remotePath );
3827 return self
::transformFilePath( $remotePathPrefix, $IP, $path );
3831 * Utility method for transformResourceFilePath().
3833 * Caller is responsible for ensuring the file exists. Emits a PHP warning otherwise.
3836 * @param string $remotePath URL path prefix that points to $localPath
3837 * @param string $localPath File directory exposed at $remotePath
3838 * @param string $file Path to target file relative to $localPath
3839 * @return string URL
3841 public static function transformFilePath( $remotePathPrefix, $localPath, $file ) {
3842 $hash = md5_file( "$localPath/$file" );
3843 if ( $hash === false ) {
3844 wfLogWarning( __METHOD__
. ": Failed to hash $localPath/$file" );
3847 return "$remotePathPrefix/$file?" . substr( $hash, 0, 5 );
3851 * Transform "media" attribute based on request parameters
3853 * @param string $media Current value of the "media" attribute
3854 * @return string Modified value of the "media" attribute, or null to skip
3857 public static function transformCssMedia( $media ) {
3860 // http://www.w3.org/TR/css3-mediaqueries/#syntax
3861 $screenMediaQueryRegex = '/^(?:only\s+)?screen\b/i';
3863 // Switch in on-screen display for media testing
3865 'printable' => 'print',
3866 'handheld' => 'handheld',
3868 foreach ( $switches as $switch => $targetMedia ) {
3869 if ( $wgRequest->getBool( $switch ) ) {
3870 if ( $media == $targetMedia ) {
3872 } elseif ( preg_match( $screenMediaQueryRegex, $media ) === 1 ) {
3873 /* This regex will not attempt to understand a comma-separated media_query_list
3875 * Example supported values for $media:
3876 * 'screen', 'only screen', 'screen and (min-width: 982px)' ),
3877 * Example NOT supported value for $media:
3878 * '3d-glasses, screen, print and resolution > 90dpi'
3880 * If it's a print request, we never want any kind of screen stylesheets
3881 * If it's a handheld request (currently the only other choice with a switch),
3882 * we don't want simple 'screen' but we might want screen queries that
3883 * have a max-width or something, so we'll pass all others on and let the
3884 * client do the query.
3886 if ( $targetMedia == 'print' ||
$media == 'screen' ) {
3897 * Add a wikitext-formatted message to the output.
3898 * This is equivalent to:
3900 * $wgOut->addWikiText( wfMessage( ... )->plain() )
3902 public function addWikiMsg( /*...*/ ) {
3903 $args = func_get_args();
3904 $name = array_shift( $args );
3905 $this->addWikiMsgArray( $name, $args );
3909 * Add a wikitext-formatted message to the output.
3910 * Like addWikiMsg() except the parameters are taken as an array
3911 * instead of a variable argument list.
3913 * @param string $name
3914 * @param array $args
3916 public function addWikiMsgArray( $name, $args ) {
3917 $this->addHTML( $this->msg( $name, $args )->parseAsBlock() );
3921 * This function takes a number of message/argument specifications, wraps them in
3922 * some overall structure, and then parses the result and adds it to the output.
3924 * In the $wrap, $1 is replaced with the first message, $2 with the second,
3925 * and so on. The subsequent arguments may be either
3926 * 1) strings, in which case they are message names, or
3927 * 2) arrays, in which case, within each array, the first element is the message
3928 * name, and subsequent elements are the parameters to that message.
3930 * Don't use this for messages that are not in the user's interface language.
3934 * $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>", 'some-error' );
3938 * $wgOut->addWikiText( "<div class='error'>\n"
3939 * . wfMessage( 'some-error' )->plain() . "\n</div>" );
3941 * The newline after the opening div is needed in some wikitext. See bug 19226.
3943 * @param string $wrap
3945 public function wrapWikiMsg( $wrap /*, ...*/ ) {
3946 $msgSpecs = func_get_args();
3947 array_shift( $msgSpecs );
3948 $msgSpecs = array_values( $msgSpecs );
3950 foreach ( $msgSpecs as $n => $spec ) {
3951 if ( is_array( $spec ) ) {
3953 $name = array_shift( $args );
3954 if ( isset( $args['options'] ) ) {
3955 unset( $args['options'] );
3957 'Adding "options" to ' . __METHOD__
. ' is no longer supported',
3965 $s = str_replace( '$' . ( $n +
1 ), $this->msg( $name, $args )->plain(), $s );
3967 $this->addWikiText( $s );
3971 * Enables/disables TOC, doesn't override __NOTOC__
3975 public function enableTOC( $flag = true ) {
3976 $this->mEnableTOC
= $flag;
3983 public function isTOCEnabled() {
3984 return $this->mEnableTOC
;
3988 * Enables/disables section edit links, doesn't override __NOEDITSECTION__
3992 public function enableSectionEditLinks( $flag = true ) {
3993 $this->mEnableSectionEditLinks
= $flag;
4000 public function sectionEditLinksEnabled() {
4001 return $this->mEnableSectionEditLinks
;
4005 * Helper function to setup the PHP implementation of OOUI to use in this request.
4008 * @param String $skinName The Skin name to determine the correct OOUI theme
4009 * @param String $dir Language direction
4011 public static function setupOOUI( $skinName = '', $dir = 'ltr' ) {
4012 $themes = ExtensionRegistry
::getInstance()->getAttribute( 'SkinOOUIThemes' );
4013 // Make keys (skin names) lowercase for case-insensitive matching.
4014 $themes = array_change_key_case( $themes, CASE_LOWER
);
4015 $theme = isset( $themes[$skinName] ) ?
$themes[$skinName] : 'MediaWiki';
4016 // For example, 'OOUI\MediaWikiTheme'.
4017 $themeClass = "OOUI\\{$theme}Theme";
4018 OOUI\Theme
::setSingleton( new $themeClass() );
4019 OOUI\Element
::setDefaultDir( $dir );
4023 * Add ResourceLoader module styles for OOUI and set up the PHP implementation of it for use with
4024 * MediaWiki and this OutputPage instance.
4028 public function enableOOUI() {
4030 strtolower( $this->getSkin()->getSkinName() ),
4031 $this->getLanguage()->getDir()
4033 $this->addModuleStyles( [
4034 'oojs-ui-core.styles',
4035 'oojs-ui.styles.icons',
4036 'oojs-ui.styles.indicators',
4037 'oojs-ui.styles.textures',
4038 'mediawiki.widgets.styles',
4040 // Used by 'skipFunction' of the four 'oojs-ui.styles.*' modules. Please don't treat this as a
4041 // public API or you'll be severely disappointed when T87871 is fixed and it disappears.
4042 $this->addMeta( 'X-OOUI-PHP', '1' );