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
24 * This class should be covered by a general architecture document which does
25 * not exist as of January 2011. This is one of the Core classes and should
26 * be read at least once by any new developers.
28 * This class is used to prepare the final rendering. A skin is then
29 * applied to the output parameters (links, javascript, html, categories ...).
31 * @todo FIXME: Another class handles sending the whole page to the client.
33 * Some comments comes from a pairing session between Zak Greant and Antoine Musso
38 class OutputPage
extends ContextSource
{
39 /** @var array Should be private. Used with addMeta() which adds "<meta>" */
40 protected $mMetatags = array();
43 protected $mLinktags = array();
46 protected $mCanonicalUrl = false;
49 * @var array Additional stylesheets. Looks like this is for extensions.
50 * Might be replaced by resource loader.
52 protected $mExtStyles = array();
55 * @var string Should be private - has getter and setter. Contains
57 public $mPagetitle = '';
60 * @var string Contains all of the "<body>" content. Should be private we
61 * got set/get accessors and the append() method.
63 public $mBodytext = '';
66 * Holds the debug lines that will be output as comments in page source if
67 * $wgDebugComments is enabled. See also $wgShowDebug.
68 * @deprecated since 1.20; use MWDebug class instead.
70 public $mDebugtext = '';
72 /** @var string Stores contents of "<title>" tag */
73 private $mHTMLtitle = '';
76 * @var bool Is the displayed content related to the source of the
77 * corresponding wiki article.
79 private $mIsarticle = false;
81 /** @var bool Stores "article flag" toggle. */
82 private $mIsArticleRelated = true;
85 * @var bool We have to set isPrintable(). Some pages should
86 * never be printed (ex: redirections).
88 private $mPrintable = false;
91 * @var array Contains the page subtitle. Special pages usually have some
92 * links here. Don't confuse with site subtitle added by skins.
94 private $mSubtitle = array();
97 public $mRedirect = '';
100 protected $mStatusCode;
103 * @var string Variable mLastModified and mEtag are used for sending cache control.
104 * The whole caching system should probably be moved into its own class.
106 protected $mLastModified = '';
109 * Contains an HTTP Entity Tags (see RFC 2616 section 3.13) which is used
110 * as a unique identifier for the content. It is later used by the client
111 * to compare its cached version with the server version. Client sends
112 * headers If-Match and If-None-Match containing its locally cached ETAG value.
114 * To get more information, you will have to look at HTTP/1.1 protocol which
115 * is properly described in RFC 2616 : http://tools.ietf.org/html/rfc2616
117 private $mETag = false;
120 protected $mCategoryLinks = array();
123 protected $mCategories = array();
126 protected $mIndicators = array();
128 /** @var array Array of Interwiki Prefixed (non DB key) Titles (e.g. 'fr:Test page') */
129 private $mLanguageLinks = array();
132 * Used for JavaScript (pre resource loader)
133 * @todo We should split JS / CSS.
134 * mScripts content is inserted as is in "<head>" by Skin. This might
135 * contain either a link to a stylesheet or inline CSS.
137 private $mScripts = '';
139 /** @var string Inline CSS styles. Use addInlineStyle() sparingly */
140 protected $mInlineStyles = '';
143 private $mLinkColours;
146 * @var string Used by skin template.
147 * Example: $tpl->set( 'displaytitle', $out->mPageLinkTitle );
149 public $mPageLinkTitle = '';
151 /** @var array Array of elements in "<head>". Parser might add its own headers! */
152 protected $mHeadItems = array();
154 // @todo FIXME: Next 5 variables probably come from the resource loader
157 protected $mModules = array();
160 protected $mModuleScripts = array();
163 protected $mModuleStyles = array();
166 protected $mModuleMessages = array();
168 /** @var ResourceLoader */
169 protected $mResourceLoader;
172 protected $mJsConfigVars = array();
175 protected $mTemplateIds = array();
178 protected $mImageTimeKeys = array();
181 public $mRedirectCode = '';
183 protected $mFeedLinksAppendQuery = null;
186 * What level of 'untrustworthiness' is allowed in CSS/JS modules loaded on this page?
187 * @see ResourceLoaderModule::$origin
188 * ResourceLoaderModule::ORIGIN_ALL is assumed unless overridden;
190 protected $mAllowedModules = array(
191 ResourceLoaderModule
::TYPE_COMBINED
=> ResourceLoaderModule
::ORIGIN_ALL
,
194 /** @var bool Whether output is disabled. If this is true, the 'output' method will do nothing. */
195 protected $mDoNothing = false;
200 protected $mContainsNewMagic = 0;
203 * lazy initialised, use parserOptions()
206 protected $mParserOptions = null;
209 * Handles the Atom / RSS links.
210 * We probably only support Atom in 2011.
211 * @see $wgAdvertisedFeedTypes
213 private $mFeedLinks = array();
215 // Gwicke work on squid caching? Roughly from 2003.
216 protected $mEnableClientCache = true;
218 /** @var bool Flag if output should only contain the body of the article. */
219 private $mArticleBodyOnly = false;
222 protected $mNewSectionLink = false;
225 protected $mHideNewSectionLink = false;
228 * @var bool Comes from the parser. This was probably made to load CSS/JS
229 * only if we had "<gallery>". Used directly in CategoryPage.php.
230 * Looks like resource loader can replace this.
232 public $mNoGallery = false;
235 private $mPageTitleActionText = '';
238 private $mParseWarnings = array();
240 /** @var int Cache stuff. Looks like mEnableClientCache */
241 protected $mSquidMaxage = 0;
244 * @var bool Controls if anti-clickjacking / frame-breaking headers will
245 * be sent. This should be done for pages where edit actions are possible.
246 * Setters: $this->preventClickjacking() and $this->allowClickjacking().
248 protected $mPreventClickjacking = true;
250 /** @var int To include the variable {{REVISIONID}} */
251 private $mRevisionId = null;
254 private $mRevisionTimestamp = null;
257 protected $mFileVersion = null;
260 * @var array An array of stylesheet filenames (relative from skins path),
261 * with options for CSS media, IE conditions, and RTL/LTR direction.
262 * For internal use; add settings in the skin via $this->addStyle()
264 * Style again! This seems like a code duplication since we already have
265 * mStyles. This is what makes Open Source amazing.
267 protected $styles = array();
270 * Whether jQuery is already handled.
272 protected $mJQueryDone = false;
274 private $mIndexPolicy = 'index';
275 private $mFollowPolicy = 'follow';
276 private $mVaryHeader = array(
277 'Accept-Encoding' => array( 'list-contains=gzip' ),
281 * If the current page was reached through a redirect, $mRedirectedFrom contains the Title
286 private $mRedirectedFrom = null;
289 * Additional key => value data
291 private $mProperties = array();
294 * @var string|null ResourceLoader target for load.php links. If null, will be omitted
296 private $mTarget = null;
299 * @var bool Whether parser output should contain table of contents
301 private $mEnableTOC = true;
304 * @var bool Whether parser output should contain section edit links
306 private $mEnableSectionEditLinks = true;
309 * Constructor for OutputPage. This should not be called directly.
310 * Instead a new RequestContext should be created and it will implicitly create
311 * a OutputPage tied to that context.
312 * @param IContextSource|null $context
314 function __construct( IContextSource
$context = null ) {
315 if ( $context === null ) {
316 # Extensions should use `new RequestContext` instead of `new OutputPage` now.
317 wfDeprecated( __METHOD__
, '1.18' );
319 $this->setContext( $context );
324 * Redirect to $url rather than displaying the normal page
326 * @param string $url URL
327 * @param string $responsecode HTTP status code
329 public function redirect( $url, $responsecode = '302' ) {
330 # Strip newlines as a paranoia check for header injection in PHP<5.1.2
331 $this->mRedirect
= str_replace( "\n", '', $url );
332 $this->mRedirectCode
= $responsecode;
336 * Get the URL to redirect to, or an empty string if not redirect URL set
340 public function getRedirect() {
341 return $this->mRedirect
;
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
, array( $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.)
446 * @param string $script Raw HTML
448 function addScript( $script ) {
449 $this->mScripts
.= $script . "\n";
453 * Register and add a stylesheet from an extension directory.
455 * @param string $url Path to sheet. Provide either a full url (beginning
456 * with 'http', etc) or a relative path from the document root
457 * (beginning with '/'). Otherwise it behaves identically to
458 * addStyle() and draws from the /skins folder.
460 public function addExtensionStyle( $url ) {
461 array_push( $this->mExtStyles
, $url );
465 * Get all styles added by extensions
469 function getExtStyle() {
470 return $this->mExtStyles
;
474 * Add a JavaScript file out of skins/common, or a given relative path.
476 * @param string $file Filename in skins/common or complete on-server path
478 * @param string $version Style version of the file. Defaults to $wgStyleVersion
480 public function addScriptFile( $file, $version = null ) {
481 // See if $file parameter is an absolute URL or begins with a slash
482 if ( substr( $file, 0, 1 ) == '/' ||
preg_match( '#^[a-z]*://#i', $file ) ) {
485 $path = $this->getConfig()->get( 'StylePath' ) . "/common/{$file}";
487 if ( is_null( $version ) ) {
488 $version = $this->getConfig()->get( 'StyleVersion' );
490 $this->addScript( Html
::linkedScript( wfAppendQuery( $path, $version ) ) );
494 * Add a self-contained script tag with the given contents
496 * @param string $script JavaScript text, no "<script>" tags
498 public function addInlineScript( $script ) {
499 $this->mScripts
.= Html
::inlineScript( "\n$script\n" ) . "\n";
503 * Get all registered JS and CSS tags for the header.
506 * @deprecated since 1.24 Use OutputPage::headElement to build the full header.
508 function getScript() {
509 wfDeprecated( __METHOD__
, '1.24' );
510 return $this->mScripts
. $this->getHeadItems();
514 * Filter an array of modules to remove insufficiently trustworthy members, and modules
515 * which are no longer registered (eg a page is cached before an extension is disabled)
516 * @param array $modules
517 * @param string|null $position If not null, only return modules with this position
518 * @param string $type
521 protected function filterModules( array $modules, $position = null,
522 $type = ResourceLoaderModule
::TYPE_COMBINED
524 $resourceLoader = $this->getResourceLoader();
525 $filteredModules = array();
526 foreach ( $modules as $val ) {
527 $module = $resourceLoader->getModule( $val );
528 if ( $module instanceof ResourceLoaderModule
529 && $module->getOrigin() <= $this->getAllowedModules( $type )
530 && ( is_null( $position ) ||
$module->getPosition() == $position )
531 && ( !$this->mTarget ||
in_array( $this->mTarget
, $module->getTargets() ) )
533 $filteredModules[] = $val;
536 return $filteredModules;
540 * Get the list of modules to include on this page
542 * @param bool $filter Whether to filter out insufficiently trustworthy modules
543 * @param string|null $position If not null, only return modules with this position
544 * @param string $param
545 * @return array Array of module names
547 public function getModules( $filter = false, $position = null, $param = 'mModules' ) {
548 $modules = array_values( array_unique( $this->$param ) );
550 ?
$this->filterModules( $modules, $position )
555 * Add one or more modules recognized by the resource loader. Modules added
556 * through this function will be loaded by the resource loader when the
559 * @param string|array $modules Module name (string) or array of module names
561 public function addModules( $modules ) {
562 $this->mModules
= array_merge( $this->mModules
, (array)$modules );
566 * Get the list of module JS to include on this page
568 * @param bool $filter
569 * @param string|null $position
571 * @return array Array of module names
573 public function getModuleScripts( $filter = false, $position = null ) {
574 return $this->getModules( $filter, $position, 'mModuleScripts' );
578 * Add only JS of one or more modules recognized by the resource loader. Module
579 * scripts added through this function will be loaded by the resource loader when
582 * @param string|array $modules Module name (string) or array of module names
584 public function addModuleScripts( $modules ) {
585 $this->mModuleScripts
= array_merge( $this->mModuleScripts
, (array)$modules );
589 * Get the list of module CSS to include on this page
591 * @param bool $filter
592 * @param string|null $position
594 * @return array Array of module names
596 public function getModuleStyles( $filter = false, $position = null ) {
597 return $this->getModules( $filter, $position, 'mModuleStyles' );
601 * Add only CSS of one or more modules recognized by the resource loader.
603 * Module styles added through this function will be added using standard link CSS
604 * tags, rather than as a combined Javascript and CSS package. Thus, they will
605 * load when JavaScript is disabled (unless CSS also happens to be disabled).
607 * @param string|array $modules Module name (string) or array of module names
609 public function addModuleStyles( $modules ) {
610 $this->mModuleStyles
= array_merge( $this->mModuleStyles
, (array)$modules );
614 * Get the list of module messages to include on this page
616 * @param bool $filter
617 * @param string|null $position
619 * @return array Array of module names
621 public function getModuleMessages( $filter = false, $position = null ) {
622 return $this->getModules( $filter, $position, 'mModuleMessages' );
626 * Add only messages of one or more modules recognized by the resource loader.
627 * Module messages added through this function will be loaded by the resource
628 * loader when the page loads.
630 * @param string|array $modules Module name (string) or array of module names
632 public function addModuleMessages( $modules ) {
633 $this->mModuleMessages
= array_merge( $this->mModuleMessages
, (array)$modules );
637 * @return null|string ResourceLoader target
639 public function getTarget() {
640 return $this->mTarget
;
644 * Sets ResourceLoader target for load.php links. If null, will be omitted
646 * @param string|null $target
648 public function setTarget( $target ) {
649 $this->mTarget
= $target;
653 * Get an array of head items
657 function getHeadItemsArray() {
658 return $this->mHeadItems
;
662 * Get all header items in a string
665 * @deprecated since 1.24 Use OutputPage::headElement or
666 * if absolutely necessary use OutputPage::getHeadItemsArray
668 function getHeadItems() {
669 wfDeprecated( __METHOD__
, '1.24' );
671 foreach ( $this->mHeadItems
as $item ) {
678 * Add or replace an header item to the output
680 * @param string $name Item name
681 * @param string $value Raw HTML
683 public function addHeadItem( $name, $value ) {
684 $this->mHeadItems
[$name] = $value;
688 * Check if the header item $name is already set
690 * @param string $name Item name
693 public function hasHeadItem( $name ) {
694 return isset( $this->mHeadItems
[$name] );
698 * Set the value of the ETag HTTP header, only used if $wgUseETag is true
700 * @param string $tag Value of "ETag" header
702 function setETag( $tag ) {
707 * Set whether the output should only contain the body of the article,
708 * without any skin, sidebar, etc.
709 * Used e.g. when calling with "action=render".
711 * @param bool $only Whether to output only the body of the article
713 public function setArticleBodyOnly( $only ) {
714 $this->mArticleBodyOnly
= $only;
718 * Return whether the output will contain only the body of the article
722 public function getArticleBodyOnly() {
723 return $this->mArticleBodyOnly
;
727 * Set an additional output property
730 * @param string $name
731 * @param mixed $value
733 public function setProperty( $name, $value ) {
734 $this->mProperties
[$name] = $value;
738 * Get an additional output property
741 * @param string $name
742 * @return mixed Property value or null if not found
744 public function getProperty( $name ) {
745 if ( isset( $this->mProperties
[$name] ) ) {
746 return $this->mProperties
[$name];
753 * checkLastModified tells the client to use the client-cached page if
754 * possible. If successful, the OutputPage is disabled so that
755 * any future call to OutputPage->output() have no effect.
757 * Side effect: sets mLastModified for Last-Modified header
759 * @param string $timestamp
761 * @return bool True if cache-ok headers was sent.
763 public function checkLastModified( $timestamp ) {
764 if ( !$timestamp ||
$timestamp == '19700101000000' ) {
765 wfDebug( __METHOD__
. ": CACHE DISABLED, NO TIMESTAMP\n" );
768 $config = $this->getConfig();
769 if ( !$config->get( 'CachePages' ) ) {
770 wfDebug( __METHOD__
. ": CACHE DISABLED\n" );
774 $timestamp = wfTimestamp( TS_MW
, $timestamp );
775 $modifiedTimes = array(
776 'page' => $timestamp,
777 'user' => $this->getUser()->getTouched(),
778 'epoch' => $config->get( 'CacheEpoch' )
780 if ( $config->get( 'UseSquid' ) ) {
781 // bug 44570: the core page itself may not change, but resources might
782 $modifiedTimes['sepoch'] = wfTimestamp( TS_MW
, time() - $config->get( 'SquidMaxage' ) );
784 Hooks
::run( 'OutputPageCheckLastModified', array( &$modifiedTimes ) );
786 $maxModified = max( $modifiedTimes );
787 $this->mLastModified
= wfTimestamp( TS_RFC2822
, $maxModified );
789 $clientHeader = $this->getRequest()->getHeader( 'If-Modified-Since' );
790 if ( $clientHeader === false ) {
791 wfDebug( __METHOD__
. ": client did not send If-Modified-Since header\n", 'log' );
795 # IE sends sizes after the date like this:
796 # Wed, 20 Aug 2003 06:51:19 GMT; length=5202
797 # this breaks strtotime().
798 $clientHeader = preg_replace( '/;.*$/', '', $clientHeader );
800 wfSuppressWarnings(); // E_STRICT system time bitching
801 $clientHeaderTime = strtotime( $clientHeader );
803 if ( !$clientHeaderTime ) {
805 . ": unable to parse the client's If-Modified-Since header: $clientHeader\n" );
808 $clientHeaderTime = wfTimestamp( TS_MW
, $clientHeaderTime );
812 foreach ( $modifiedTimes as $name => $value ) {
813 if ( $info !== '' ) {
816 $info .= "$name=" . wfTimestamp( TS_ISO_8601
, $value );
819 wfDebug( __METHOD__
. ": client sent If-Modified-Since: " .
820 wfTimestamp( TS_ISO_8601
, $clientHeaderTime ) . "\n", 'log' );
821 wfDebug( __METHOD__
. ": effective Last-Modified: " .
822 wfTimestamp( TS_ISO_8601
, $maxModified ) . "\n", 'log' );
823 if ( $clientHeaderTime < $maxModified ) {
824 wfDebug( __METHOD__
. ": STALE, $info\n", 'log' );
829 # Give a 304 response code and disable body output
830 wfDebug( __METHOD__
. ": NOT MODIFIED, $info\n", 'log' );
831 ini_set( 'zlib.output_compression', 0 );
832 $this->getRequest()->response()->header( "HTTP/1.1 304 Not Modified" );
833 $this->sendCacheControl();
836 // Don't output a compressed blob when using ob_gzhandler;
837 // it's technically against HTTP spec and seems to confuse
838 // Firefox when the response gets split over two packets.
839 wfClearOutputBuffers();
845 * Override the last modified timestamp
847 * @param string $timestamp New timestamp, in a format readable by
850 public function setLastModified( $timestamp ) {
851 $this->mLastModified
= wfTimestamp( TS_RFC2822
, $timestamp );
855 * Set the robot policy for the page: <http://www.robotstxt.org/meta.html>
857 * @param string $policy The literal string to output as the contents of
858 * the meta tag. Will be parsed according to the spec and output in
862 public function setRobotPolicy( $policy ) {
863 $policy = Article
::formatRobotPolicy( $policy );
865 if ( isset( $policy['index'] ) ) {
866 $this->setIndexPolicy( $policy['index'] );
868 if ( isset( $policy['follow'] ) ) {
869 $this->setFollowPolicy( $policy['follow'] );
874 * Set the index policy for the page, but leave the follow policy un-
877 * @param string $policy Either 'index' or 'noindex'.
880 public function setIndexPolicy( $policy ) {
881 $policy = trim( $policy );
882 if ( in_array( $policy, array( 'index', 'noindex' ) ) ) {
883 $this->mIndexPolicy
= $policy;
888 * Set the follow policy for the page, but leave the index policy un-
891 * @param string $policy Either 'follow' or 'nofollow'.
894 public function setFollowPolicy( $policy ) {
895 $policy = trim( $policy );
896 if ( in_array( $policy, array( 'follow', 'nofollow' ) ) ) {
897 $this->mFollowPolicy
= $policy;
902 * Set the new value of the "action text", this will be added to the
903 * "HTML title", separated from it with " - ".
905 * @param string $text New value of the "action text"
907 public function setPageTitleActionText( $text ) {
908 $this->mPageTitleActionText
= $text;
912 * Get the value of the "action text"
916 public function getPageTitleActionText() {
917 return $this->mPageTitleActionText
;
921 * "HTML title" means the contents of "<title>".
922 * It is stored as plain, unescaped text and will be run through htmlspecialchars in the skin file.
924 * @param string|Message $name
926 public function setHTMLTitle( $name ) {
927 if ( $name instanceof Message
) {
928 $this->mHTMLtitle
= $name->setContext( $this->getContext() )->text();
930 $this->mHTMLtitle
= $name;
935 * Return the "HTML title", i.e. the content of the "<title>" tag.
939 public function getHTMLTitle() {
940 return $this->mHTMLtitle
;
944 * Set $mRedirectedFrom, the Title of the page which redirected us to the current page.
948 public function setRedirectedFrom( $t ) {
949 $this->mRedirectedFrom
= $t;
953 * "Page title" means the contents of \<h1\>. It is stored as a valid HTML
954 * fragment. This function allows good tags like \<sup\> in the \<h1\> tag,
955 * but not bad tags like \<script\>. This function automatically sets
956 * \<title\> to the same content as \<h1\> but with all tags removed. Bad
957 * tags that were escaped in \<h1\> will still be escaped in \<title\>, and
958 * good tags like \<i\> will be dropped entirely.
960 * @param string|Message $name
962 public function setPageTitle( $name ) {
963 if ( $name instanceof Message
) {
964 $name = $name->setContext( $this->getContext() )->text();
967 # change "<script>foo&bar</script>" to "<script>foo&bar</script>"
968 # but leave "<i>foobar</i>" alone
969 $nameWithTags = Sanitizer
::normalizeCharReferences( Sanitizer
::removeHTMLtags( $name ) );
970 $this->mPagetitle
= $nameWithTags;
972 # change "<i>foo&bar</i>" to "foo&bar"
974 $this->msg( 'pagetitle' )->rawParams( Sanitizer
::stripAllTags( $nameWithTags ) )
975 ->inContentLanguage()
980 * Return the "page title", i.e. the content of the \<h1\> tag.
984 public function getPageTitle() {
985 return $this->mPagetitle
;
989 * Set the Title object to use
993 public function setTitle( Title
$t ) {
994 $this->getContext()->setTitle( $t );
998 * Replace the subtitle with $str
1000 * @param string|Message $str New value of the subtitle. String should be safe HTML.
1002 public function setSubtitle( $str ) {
1003 $this->clearSubtitle();
1004 $this->addSubtitle( $str );
1008 * Add $str to the subtitle
1010 * @deprecated since 1.19; use addSubtitle() instead
1011 * @param string|Message $str String or Message to add to the subtitle
1013 public function appendSubtitle( $str ) {
1014 $this->addSubtitle( $str );
1018 * Add $str to the subtitle
1020 * @param string|Message $str String or Message to add to the subtitle. String should be safe HTML.
1022 public function addSubtitle( $str ) {
1023 if ( $str instanceof Message
) {
1024 $this->mSubtitle
[] = $str->setContext( $this->getContext() )->parse();
1026 $this->mSubtitle
[] = $str;
1031 * Build message object for a subtitle containing a backlink to a page
1033 * @param Title $title Title to link to
1034 * @param array $query Array of additional parameters to include in the link
1038 public static function buildBacklinkSubtitle( Title
$title, $query = array() ) {
1039 if ( $title->isRedirect() ) {
1040 $query['redirect'] = 'no';
1042 return wfMessage( 'backlinksubtitle' )
1043 ->rawParams( Linker
::link( $title, null, array(), $query ) );
1047 * Add a subtitle containing a backlink to a page
1049 * @param Title $title Title to link to
1050 * @param array $query Array of additional parameters to include in the link
1052 public function addBacklinkSubtitle( Title
$title, $query = array() ) {
1053 $this->addSubtitle( self
::buildBacklinkSubtitle( $title, $query ) );
1057 * Clear the subtitles
1059 public function clearSubtitle() {
1060 $this->mSubtitle
= array();
1068 public function getSubtitle() {
1069 return implode( "<br />\n\t\t\t\t", $this->mSubtitle
);
1073 * Set the page as printable, i.e. it'll be displayed with all
1074 * print styles included
1076 public function setPrintable() {
1077 $this->mPrintable
= true;
1081 * Return whether the page is "printable"
1085 public function isPrintable() {
1086 return $this->mPrintable
;
1090 * Disable output completely, i.e. calling output() will have no effect
1092 public function disable() {
1093 $this->mDoNothing
= true;
1097 * Return whether the output will be completely disabled
1101 public function isDisabled() {
1102 return $this->mDoNothing
;
1106 * Show an "add new section" link?
1110 public function showNewSectionLink() {
1111 return $this->mNewSectionLink
;
1115 * Forcibly hide the new section link?
1119 public function forceHideNewSectionLink() {
1120 return $this->mHideNewSectionLink
;
1124 * Add or remove feed links in the page header
1125 * This is mainly kept for backward compatibility, see OutputPage::addFeedLink()
1126 * for the new version
1127 * @see addFeedLink()
1129 * @param bool $show True: add default feeds, false: remove all feeds
1131 public function setSyndicated( $show = true ) {
1133 $this->setFeedAppendQuery( false );
1135 $this->mFeedLinks
= array();
1140 * Add default feeds to the page header
1141 * This is mainly kept for backward compatibility, see OutputPage::addFeedLink()
1142 * for the new version
1143 * @see addFeedLink()
1145 * @param string $val Query to append to feed links or false to output
1148 public function setFeedAppendQuery( $val ) {
1149 $this->mFeedLinks
= array();
1151 foreach ( $this->getConfig()->get( 'AdvertisedFeedTypes' ) as $type ) {
1152 $query = "feed=$type";
1153 if ( is_string( $val ) ) {
1154 $query .= '&' . $val;
1156 $this->mFeedLinks
[$type] = $this->getTitle()->getLocalURL( $query );
1161 * Add a feed link to the page header
1163 * @param string $format Feed type, should be a key of $wgFeedClasses
1164 * @param string $href URL
1166 public function addFeedLink( $format, $href ) {
1167 if ( in_array( $format, $this->getConfig()->get( 'AdvertisedFeedTypes' ) ) ) {
1168 $this->mFeedLinks
[$format] = $href;
1173 * Should we output feed links for this page?
1176 public function isSyndicated() {
1177 return count( $this->mFeedLinks
) > 0;
1181 * Return URLs for each supported syndication format for this page.
1182 * @return array Associating format keys with URLs
1184 public function getSyndicationLinks() {
1185 return $this->mFeedLinks
;
1189 * Will currently always return null
1193 public function getFeedAppendQuery() {
1194 return $this->mFeedLinksAppendQuery
;
1198 * Set whether the displayed content is related to the source of the
1199 * corresponding article on the wiki
1200 * Setting true will cause the change "article related" toggle to true
1204 public function setArticleFlag( $v ) {
1205 $this->mIsarticle
= $v;
1207 $this->mIsArticleRelated
= $v;
1212 * Return whether the content displayed page is related to the source of
1213 * the corresponding article on the wiki
1217 public function isArticle() {
1218 return $this->mIsarticle
;
1222 * Set whether this page is related an article on the wiki
1223 * Setting false will cause the change of "article flag" toggle to false
1227 public function setArticleRelated( $v ) {
1228 $this->mIsArticleRelated
= $v;
1230 $this->mIsarticle
= false;
1235 * Return whether this page is related an article on the wiki
1239 public function isArticleRelated() {
1240 return $this->mIsArticleRelated
;
1244 * Add new language links
1246 * @param array $newLinkArray Associative array mapping language code to the page
1249 public function addLanguageLinks( array $newLinkArray ) {
1250 $this->mLanguageLinks +
= $newLinkArray;
1254 * Reset the language links and add new language links
1256 * @param array $newLinkArray Associative array mapping language code to the page
1259 public function setLanguageLinks( array $newLinkArray ) {
1260 $this->mLanguageLinks
= $newLinkArray;
1264 * Get the list of language links
1266 * @return array Array of Interwiki Prefixed (non DB key) Titles (e.g. 'fr:Test page')
1268 public function getLanguageLinks() {
1269 return $this->mLanguageLinks
;
1273 * Add an array of categories, with names in the keys
1275 * @param array $categories Mapping category name => sort key
1277 public function addCategoryLinks( array $categories ) {
1280 if ( !is_array( $categories ) ||
count( $categories ) == 0 ) {
1284 # Add the links to a LinkBatch
1285 $arr = array( NS_CATEGORY
=> $categories );
1286 $lb = new LinkBatch
;
1287 $lb->setArray( $arr );
1289 # Fetch existence plus the hiddencat property
1290 $dbr = wfGetDB( DB_SLAVE
);
1291 $fields = array( 'page_id', 'page_namespace', 'page_title', 'page_len',
1292 'page_is_redirect', 'page_latest', 'pp_value' );
1294 if ( $this->getConfig()->get( 'ContentHandlerUseDB' ) ) {
1295 $fields[] = 'page_content_model';
1298 $res = $dbr->select( array( 'page', 'page_props' ),
1300 $lb->constructSet( 'page', $dbr ),
1303 array( 'page_props' => array( 'LEFT JOIN', array(
1304 'pp_propname' => 'hiddencat',
1309 # Add the results to the link cache
1310 $lb->addResultToCache( LinkCache
::singleton(), $res );
1312 # Set all the values to 'normal'.
1313 $categories = array_fill_keys( array_keys( $categories ), 'normal' );
1315 # Mark hidden categories
1316 foreach ( $res as $row ) {
1317 if ( isset( $row->pp_value
) ) {
1318 $categories[$row->page_title
] = 'hidden';
1322 # Add the remaining categories to the skin
1324 'OutputPageMakeCategoryLinks',
1325 array( &$this, $categories, &$this->mCategoryLinks
) )
1327 foreach ( $categories as $category => $type ) {
1328 $origcategory = $category;
1329 $title = Title
::makeTitleSafe( NS_CATEGORY
, $category );
1333 $wgContLang->findVariantLink( $category, $title, true );
1334 if ( $category != $origcategory && array_key_exists( $category, $categories ) ) {
1337 $text = $wgContLang->convertHtml( $title->getText() );
1338 $this->mCategories
[] = $title->getText();
1339 $this->mCategoryLinks
[$type][] = Linker
::link( $title, $text );
1345 * Reset the category links (but not the category list) and add $categories
1347 * @param array $categories Mapping category name => sort key
1349 public function setCategoryLinks( array $categories ) {
1350 $this->mCategoryLinks
= array();
1351 $this->addCategoryLinks( $categories );
1355 * Get the list of category links, in a 2-D array with the following format:
1356 * $arr[$type][] = $link, where $type is either "normal" or "hidden" (for
1357 * hidden categories) and $link a HTML fragment with a link to the category
1362 public function getCategoryLinks() {
1363 return $this->mCategoryLinks
;
1367 * Get the list of category names this page belongs to
1369 * @return array Array of strings
1371 public function getCategories() {
1372 return $this->mCategories
;
1376 * Add an array of indicators, with their identifiers as array
1377 * keys and HTML contents as values.
1379 * In case of duplicate keys, existing values are overwritten.
1381 * @param array $indicators
1384 public function setIndicators( array $indicators ) {
1385 $this->mIndicators
= $indicators +
$this->mIndicators
;
1386 // Keep ordered by key
1387 ksort( $this->mIndicators
);
1391 * Get the indicators associated with this page.
1393 * The array will be internally ordered by item keys.
1395 * @return array Keys: identifiers, values: HTML contents
1398 public function getIndicators() {
1399 return $this->mIndicators
;
1403 * Adds help link with an icon via page indicators.
1404 * Link target can be overridden by a local message containing a wikilink:
1405 * the message key is: lowercase action or special page name + '-helppage'.
1406 * @param string $to Target MediaWiki.org page title or encoded URL.
1407 * @param bool $overrideBaseUrl Whether $url is a full URL, to avoid MW.o.
1410 public function addHelpLink( $to, $overrideBaseUrl = false ) {
1411 $this->addModuleStyles( 'mediawiki.helplink' );
1412 $text = $this->msg( 'helppage-top-gethelp' )->escaped();
1414 if ( $overrideBaseUrl ) {
1417 $toUrlencoded = wfUrlencode( str_replace( ' ', '_', $to ) );
1418 $helpUrl = "//www.mediawiki.org/wiki/Special:MyLanguage/$toUrlencoded";
1421 $link = Html
::rawElement(
1425 'target' => '_blank',
1426 'class' => 'mw-helplink',
1431 $this->setIndicators( array( 'mw-helplink' => $link ) );
1435 * Do not allow scripts which can be modified by wiki users to load on this page;
1436 * only allow scripts bundled with, or generated by, the software.
1437 * Site-wide styles are controlled by a config setting, since they can be
1438 * used to create a custom skin/theme, but not user-specific ones.
1440 * @todo this should be given a more accurate name
1442 public function disallowUserJs() {
1443 $this->reduceAllowedModules(
1444 ResourceLoaderModule
::TYPE_SCRIPTS
,
1445 ResourceLoaderModule
::ORIGIN_CORE_INDIVIDUAL
1448 // Site-wide styles are controlled by a config setting, see bug 71621
1449 // for background on why. User styles are never allowed.
1450 if ( $this->getConfig()->get( 'AllowSiteCSSOnRestrictedPages' ) ) {
1451 $styleOrigin = ResourceLoaderModule
::ORIGIN_USER_SITEWIDE
;
1453 $styleOrigin = ResourceLoaderModule
::ORIGIN_CORE_INDIVIDUAL
;
1455 $this->reduceAllowedModules(
1456 ResourceLoaderModule
::TYPE_STYLES
,
1462 * Show what level of JavaScript / CSS untrustworthiness is allowed on this page
1463 * @see ResourceLoaderModule::$origin
1464 * @param string $type ResourceLoaderModule TYPE_ constant
1465 * @return int ResourceLoaderModule ORIGIN_ class constant
1467 public function getAllowedModules( $type ) {
1468 if ( $type == ResourceLoaderModule
::TYPE_COMBINED
) {
1469 return min( array_values( $this->mAllowedModules
) );
1471 return isset( $this->mAllowedModules
[$type] )
1472 ?
$this->mAllowedModules
[$type]
1473 : ResourceLoaderModule
::ORIGIN_ALL
;
1478 * Set the highest level of CSS/JS untrustworthiness allowed
1480 * @deprecated since 1.24 Raising level of allowed untrusted content is no longer supported.
1481 * Use reduceAllowedModules() instead
1482 * @param string $type ResourceLoaderModule TYPE_ constant
1483 * @param int $level ResourceLoaderModule class constant
1485 public function setAllowedModules( $type, $level ) {
1486 wfDeprecated( __METHOD__
, '1.24' );
1487 $this->reduceAllowedModules( $type, $level );
1491 * Limit the highest level of CSS/JS untrustworthiness allowed.
1493 * If passed the same or a higher level than the current level of untrustworthiness set, the
1494 * level will remain unchanged.
1496 * @param string $type
1497 * @param int $level ResourceLoaderModule class constant
1499 public function reduceAllowedModules( $type, $level ) {
1500 $this->mAllowedModules
[$type] = min( $this->getAllowedModules( $type ), $level );
1504 * Prepend $text to the body HTML
1506 * @param string $text HTML
1508 public function prependHTML( $text ) {
1509 $this->mBodytext
= $text . $this->mBodytext
;
1513 * Append $text to the body HTML
1515 * @param string $text HTML
1517 public function addHTML( $text ) {
1518 $this->mBodytext
.= $text;
1522 * Shortcut for adding an Html::element via addHTML.
1526 * @param string $element
1527 * @param array $attribs
1528 * @param string $contents
1530 public function addElement( $element, array $attribs = array(), $contents = '' ) {
1531 $this->addHTML( Html
::element( $element, $attribs, $contents ) );
1535 * Clear the body HTML
1537 public function clearHTML() {
1538 $this->mBodytext
= '';
1544 * @return string HTML
1546 public function getHTML() {
1547 return $this->mBodytext
;
1551 * Get/set the ParserOptions object to use for wikitext parsing
1553 * @param ParserOptions|null $options Either the ParserOption to use or null to only get the
1554 * current ParserOption object
1555 * @return ParserOptions
1557 public function parserOptions( $options = null ) {
1558 if ( !$this->mParserOptions
) {
1559 $this->mParserOptions
= ParserOptions
::newFromContext( $this->getContext() );
1560 $this->mParserOptions
->setEditSection( false );
1562 return wfSetVar( $this->mParserOptions
, $options );
1566 * Set the revision ID which will be seen by the wiki text parser
1567 * for things such as embedded {{REVISIONID}} variable use.
1569 * @param int|null $revid An positive integer, or null
1570 * @return mixed Previous value
1572 public function setRevisionId( $revid ) {
1573 $val = is_null( $revid ) ?
null : intval( $revid );
1574 return wfSetVar( $this->mRevisionId
, $val );
1578 * Get the displayed revision ID
1582 public function getRevisionId() {
1583 return $this->mRevisionId
;
1587 * Set the timestamp of the revision which will be displayed. This is used
1588 * to avoid a extra DB call in Skin::lastModified().
1590 * @param string|null $timestamp
1591 * @return mixed Previous value
1593 public function setRevisionTimestamp( $timestamp ) {
1594 return wfSetVar( $this->mRevisionTimestamp
, $timestamp );
1598 * Get the timestamp of displayed revision.
1599 * This will be null if not filled by setRevisionTimestamp().
1601 * @return string|null
1603 public function getRevisionTimestamp() {
1604 return $this->mRevisionTimestamp
;
1608 * Set the displayed file version
1610 * @param File|bool $file
1611 * @return mixed Previous value
1613 public function setFileVersion( $file ) {
1615 if ( $file instanceof File
&& $file->exists() ) {
1616 $val = array( 'time' => $file->getTimestamp(), 'sha1' => $file->getSha1() );
1618 return wfSetVar( $this->mFileVersion
, $val, true );
1622 * Get the displayed file version
1624 * @return array|null ('time' => MW timestamp, 'sha1' => sha1)
1626 public function getFileVersion() {
1627 return $this->mFileVersion
;
1631 * Get the templates used on this page
1633 * @return array (namespace => dbKey => revId)
1636 public function getTemplateIds() {
1637 return $this->mTemplateIds
;
1641 * Get the files used on this page
1643 * @return array (dbKey => array('time' => MW timestamp or null, 'sha1' => sha1 or ''))
1646 public function getFileSearchOptions() {
1647 return $this->mImageTimeKeys
;
1651 * Convert wikitext to HTML and add it to the buffer
1652 * Default assumes that the current page title will be used.
1654 * @param string $text
1655 * @param bool $linestart Is this the start of a line?
1656 * @param bool $interface Is this text in the user interface language?
1657 * @throws MWException
1659 public function addWikiText( $text, $linestart = true, $interface = true ) {
1660 $title = $this->getTitle(); // Work around E_STRICT
1662 throw new MWException( 'Title is null' );
1664 $this->addWikiTextTitle( $text, $title, $linestart, /*tidy*/false, $interface );
1668 * Add wikitext with a custom Title object
1670 * @param string $text Wikitext
1671 * @param Title $title
1672 * @param bool $linestart Is this the start of a line?
1674 public function addWikiTextWithTitle( $text, &$title, $linestart = true ) {
1675 $this->addWikiTextTitle( $text, $title, $linestart );
1679 * Add wikitext with a custom Title object and tidy enabled.
1681 * @param string $text Wikitext
1682 * @param Title $title
1683 * @param bool $linestart Is this the start of a line?
1685 function addWikiTextTitleTidy( $text, &$title, $linestart = true ) {
1686 $this->addWikiTextTitle( $text, $title, $linestart, true );
1690 * Add wikitext with tidy enabled
1692 * @param string $text Wikitext
1693 * @param bool $linestart Is this the start of a line?
1695 public function addWikiTextTidy( $text, $linestart = true ) {
1696 $title = $this->getTitle();
1697 $this->addWikiTextTitleTidy( $text, $title, $linestart );
1701 * Add wikitext with a custom Title object
1703 * @param string $text Wikitext
1704 * @param Title $title
1705 * @param bool $linestart Is this the start of a line?
1706 * @param bool $tidy Whether to use tidy
1707 * @param bool $interface Whether it is an interface message
1708 * (for example disables conversion)
1710 public function addWikiTextTitle( $text, Title
$title, $linestart,
1711 $tidy = false, $interface = false
1715 $popts = $this->parserOptions();
1716 $oldTidy = $popts->setTidy( $tidy );
1717 $popts->setInterfaceMessage( (bool)$interface );
1719 $parserOutput = $wgParser->getFreshParser()->parse(
1720 $text, $title, $popts,
1721 $linestart, true, $this->mRevisionId
1724 $popts->setTidy( $oldTidy );
1726 $this->addParserOutput( $parserOutput );
1731 * Add a ParserOutput object, but without Html.
1733 * @deprecated since 1.24, use addParserOutputMetadata() instead.
1734 * @param ParserOutput $parserOutput
1736 public function addParserOutputNoText( $parserOutput ) {
1737 $this->addParserOutputMetadata( $parserOutput );
1741 * Add all metadata associated with a ParserOutput object, but without the actual HTML. This
1742 * includes categories, language links, ResourceLoader modules, effects of certain magic words,
1746 * @param ParserOutput $parserOutput
1748 public function addParserOutputMetadata( $parserOutput ) {
1749 $this->mLanguageLinks +
= $parserOutput->getLanguageLinks();
1750 $this->addCategoryLinks( $parserOutput->getCategories() );
1751 $this->setIndicators( $parserOutput->getIndicators() );
1752 $this->mNewSectionLink
= $parserOutput->getNewSection();
1753 $this->mHideNewSectionLink
= $parserOutput->getHideNewSection();
1755 $this->mParseWarnings
= $parserOutput->getWarnings();
1756 if ( !$parserOutput->isCacheable() ) {
1757 $this->enableClientCache( false );
1759 $this->mNoGallery
= $parserOutput->getNoGallery();
1760 $this->mHeadItems
= array_merge( $this->mHeadItems
, $parserOutput->getHeadItems() );
1761 $this->addModules( $parserOutput->getModules() );
1762 $this->addModuleScripts( $parserOutput->getModuleScripts() );
1763 $this->addModuleStyles( $parserOutput->getModuleStyles() );
1764 $this->addModuleMessages( $parserOutput->getModuleMessages() );
1765 $this->addJsConfigVars( $parserOutput->getJsConfigVars() );
1766 $this->mPreventClickjacking
= $this->mPreventClickjacking
1767 ||
$parserOutput->preventClickjacking();
1769 // Template versioning...
1770 foreach ( (array)$parserOutput->getTemplateIds() as $ns => $dbks ) {
1771 if ( isset( $this->mTemplateIds
[$ns] ) ) {
1772 $this->mTemplateIds
[$ns] = $dbks +
$this->mTemplateIds
[$ns];
1774 $this->mTemplateIds
[$ns] = $dbks;
1777 // File versioning...
1778 foreach ( (array)$parserOutput->getFileSearchOptions() as $dbk => $data ) {
1779 $this->mImageTimeKeys
[$dbk] = $data;
1782 // Hooks registered in the object
1783 $parserOutputHooks = $this->getConfig()->get( 'ParserOutputHooks' );
1784 foreach ( $parserOutput->getOutputHooks() as $hookInfo ) {
1785 list( $hookName, $data ) = $hookInfo;
1786 if ( isset( $parserOutputHooks[$hookName] ) ) {
1787 call_user_func( $parserOutputHooks[$hookName], $this, $parserOutput, $data );
1791 // Link flags are ignored for now, but may in the future be
1792 // used to mark individual language links.
1793 $linkFlags = array();
1794 Hooks
::run( 'LanguageLinks', array( $this->getTitle(), &$this->mLanguageLinks
, &$linkFlags ) );
1795 Hooks
::run( 'OutputPageParserOutput', array( &$this, $parserOutput ) );
1799 * Add the HTML and enhancements for it (like ResourceLoader modules) associated with a
1800 * ParserOutput object, without any other metadata.
1803 * @param ParserOutput $parserOutput
1805 public function addParserOutputContent( $parserOutput ) {
1806 $this->addParserOutputText( $parserOutput );
1808 $this->addModules( $parserOutput->getModules() );
1809 $this->addModuleScripts( $parserOutput->getModuleScripts() );
1810 $this->addModuleStyles( $parserOutput->getModuleStyles() );
1811 $this->addModuleMessages( $parserOutput->getModuleMessages() );
1813 $this->addJsConfigVars( $parserOutput->getJsConfigVars() );
1817 * Add the HTML associated with a ParserOutput object, without any metadata.
1820 * @param ParserOutput $parserOutput
1822 public function addParserOutputText( $parserOutput ) {
1823 $text = $parserOutput->getText();
1824 Hooks
::run( 'OutputPageBeforeHTML', array( &$this, &$text ) );
1825 $this->addHTML( $text );
1829 * Add everything from a ParserOutput object.
1831 * @param ParserOutput $parserOutput
1833 function addParserOutput( $parserOutput ) {
1834 $this->addParserOutputMetadata( $parserOutput );
1835 $parserOutput->setTOCEnabled( $this->mEnableTOC
);
1837 // Touch section edit links only if not previously disabled
1838 if ( $parserOutput->getEditSectionTokens() ) {
1839 $parserOutput->setEditSectionTokens( $this->mEnableSectionEditLinks
);
1842 $this->addParserOutputText( $parserOutput );
1846 * Add the output of a QuickTemplate to the output buffer
1848 * @param QuickTemplate $template
1850 public function addTemplate( &$template ) {
1851 $this->addHTML( $template->getHTML() );
1855 * Parse wikitext and return the HTML.
1857 * @param string $text
1858 * @param bool $linestart Is this the start of a line?
1859 * @param bool $interface Use interface language ($wgLang instead of
1860 * $wgContLang) while parsing language sensitive magic words like GRAMMAR and PLURAL.
1861 * This also disables LanguageConverter.
1862 * @param Language $language Target language object, will override $interface
1863 * @throws MWException
1864 * @return string HTML
1866 public function parse( $text, $linestart = true, $interface = false, $language = null ) {
1869 if ( is_null( $this->getTitle() ) ) {
1870 throw new MWException( 'Empty $mTitle in ' . __METHOD__
);
1873 $popts = $this->parserOptions();
1875 $popts->setInterfaceMessage( true );
1877 if ( $language !== null ) {
1878 $oldLang = $popts->setTargetLanguage( $language );
1881 $parserOutput = $wgParser->getFreshParser()->parse(
1882 $text, $this->getTitle(), $popts,
1883 $linestart, true, $this->mRevisionId
1887 $popts->setInterfaceMessage( false );
1889 if ( $language !== null ) {
1890 $popts->setTargetLanguage( $oldLang );
1893 return $parserOutput->getText();
1897 * Parse wikitext, strip paragraphs, and return the HTML.
1899 * @param string $text
1900 * @param bool $linestart Is this the start of a line?
1901 * @param bool $interface Use interface language ($wgLang instead of
1902 * $wgContLang) while parsing language sensitive magic
1903 * words like GRAMMAR and PLURAL
1904 * @return string HTML
1906 public function parseInline( $text, $linestart = true, $interface = false ) {
1907 $parsed = $this->parse( $text, $linestart, $interface );
1908 return Parser
::stripOuterParagraph( $parsed );
1912 * Set the value of the "s-maxage" part of the "Cache-control" HTTP header
1914 * @param int $maxage Maximum cache time on the Squid, in seconds.
1916 public function setSquidMaxage( $maxage ) {
1917 $this->mSquidMaxage
= $maxage;
1921 * Use enableClientCache(false) to force it to send nocache headers
1923 * @param bool $state
1927 public function enableClientCache( $state ) {
1928 return wfSetVar( $this->mEnableClientCache
, $state );
1932 * Get the list of cookies that will influence on the cache
1936 function getCacheVaryCookies() {
1938 if ( $cookies === null ) {
1939 $config = $this->getConfig();
1940 $cookies = array_merge(
1942 $config->get( 'CookiePrefix' ) . 'Token',
1943 $config->get( 'CookiePrefix' ) . 'LoggedOut',
1947 $config->get( 'CacheVaryCookies' )
1949 Hooks
::run( 'GetCacheVaryCookies', array( $this, &$cookies ) );
1955 * Check if the request has a cache-varying cookie header
1956 * If it does, it's very important that we don't allow public caching
1960 function haveCacheVaryCookies() {
1961 $cookieHeader = $this->getRequest()->getHeader( 'cookie' );
1962 if ( $cookieHeader === false ) {
1965 $cvCookies = $this->getCacheVaryCookies();
1966 foreach ( $cvCookies as $cookieName ) {
1967 # Check for a simple string match, like the way squid does it
1968 if ( strpos( $cookieHeader, $cookieName ) !== false ) {
1969 wfDebug( __METHOD__
. ": found $cookieName\n" );
1973 wfDebug( __METHOD__
. ": no cache-varying cookies found\n" );
1978 * Add an HTTP header that will influence on the cache
1980 * @param string $header Header name
1981 * @param array|null $option
1982 * @todo FIXME: Document the $option parameter; it appears to be for
1983 * X-Vary-Options but what format is acceptable?
1985 public function addVaryHeader( $header, $option = null ) {
1986 if ( !array_key_exists( $header, $this->mVaryHeader
) ) {
1987 $this->mVaryHeader
[$header] = (array)$option;
1988 } elseif ( is_array( $option ) ) {
1989 if ( is_array( $this->mVaryHeader
[$header] ) ) {
1990 $this->mVaryHeader
[$header] = array_merge( $this->mVaryHeader
[$header], $option );
1992 $this->mVaryHeader
[$header] = $option;
1995 $this->mVaryHeader
[$header] = array_unique( (array)$this->mVaryHeader
[$header] );
1999 * Return a Vary: header on which to vary caches. Based on the keys of $mVaryHeader,
2000 * such as Accept-Encoding or Cookie
2004 public function getVaryHeader() {
2005 return 'Vary: ' . join( ', ', array_keys( $this->mVaryHeader
) );
2009 * Get a complete X-Vary-Options header
2013 public function getXVO() {
2014 $cvCookies = $this->getCacheVaryCookies();
2016 $cookiesOption = array();
2017 foreach ( $cvCookies as $cookieName ) {
2018 $cookiesOption[] = 'string-contains=' . $cookieName;
2020 $this->addVaryHeader( 'Cookie', $cookiesOption );
2023 foreach ( $this->mVaryHeader
as $header => $option ) {
2024 $newheader = $header;
2025 if ( is_array( $option ) && count( $option ) > 0 ) {
2026 $newheader .= ';' . implode( ';', $option );
2028 $headers[] = $newheader;
2030 $xvo = 'X-Vary-Options: ' . implode( ',', $headers );
2036 * bug 21672: Add Accept-Language to Vary and XVO headers
2037 * if there's no 'variant' parameter existed in GET.
2040 * /w/index.php?title=Main_page should always be served; but
2041 * /w/index.php?title=Main_page&variant=zh-cn should never be served.
2043 function addAcceptLanguage() {
2044 $title = $this->getTitle();
2045 if ( !$title instanceof Title
) {
2049 $lang = $title->getPageLanguage();
2050 if ( !$this->getRequest()->getCheck( 'variant' ) && $lang->hasVariants() ) {
2051 $variants = $lang->getVariants();
2052 $aloption = array();
2053 foreach ( $variants as $variant ) {
2054 if ( $variant === $lang->getCode() ) {
2057 $aloption[] = 'string-contains=' . $variant;
2059 // IE and some other browsers use BCP 47 standards in
2060 // their Accept-Language header, like "zh-CN" or "zh-Hant".
2061 // We should handle these too.
2062 $variantBCP47 = wfBCP47( $variant );
2063 if ( $variantBCP47 !== $variant ) {
2064 $aloption[] = 'string-contains=' . $variantBCP47;
2068 $this->addVaryHeader( 'Accept-Language', $aloption );
2073 * Set a flag which will cause an X-Frame-Options header appropriate for
2074 * edit pages to be sent. The header value is controlled by
2075 * $wgEditPageFrameOptions.
2077 * This is the default for special pages. If you display a CSRF-protected
2078 * form on an ordinary view page, then you need to call this function.
2080 * @param bool $enable
2082 public function preventClickjacking( $enable = true ) {
2083 $this->mPreventClickjacking
= $enable;
2087 * Turn off frame-breaking. Alias for $this->preventClickjacking(false).
2088 * This can be called from pages which do not contain any CSRF-protected
2091 public function allowClickjacking() {
2092 $this->mPreventClickjacking
= false;
2096 * Get the prevent-clickjacking flag
2101 public function getPreventClickjacking() {
2102 return $this->mPreventClickjacking
;
2106 * Get the X-Frame-Options header value (without the name part), or false
2107 * if there isn't one. This is used by Skin to determine whether to enable
2108 * JavaScript frame-breaking, for clients that don't support X-Frame-Options.
2112 public function getFrameOptions() {
2113 $config = $this->getConfig();
2114 if ( $config->get( 'BreakFrames' ) ) {
2116 } elseif ( $this->mPreventClickjacking
&& $config->get( 'EditPageFrameOptions' ) ) {
2117 return $config->get( 'EditPageFrameOptions' );
2123 * Send cache control HTTP headers
2125 public function sendCacheControl() {
2126 $response = $this->getRequest()->response();
2127 $config = $this->getConfig();
2128 if ( $config->get( 'UseETag' ) && $this->mETag
) {
2129 $response->header( "ETag: $this->mETag" );
2132 $this->addVaryHeader( 'Cookie' );
2133 $this->addAcceptLanguage();
2135 # don't serve compressed data to clients who can't handle it
2136 # maintain different caches for logged-in users and non-logged in ones
2137 $response->header( $this->getVaryHeader() );
2139 if ( $config->get( 'UseXVO' ) ) {
2140 # Add an X-Vary-Options header for Squid with Wikimedia patches
2141 $response->header( $this->getXVO() );
2144 if ( $this->mEnableClientCache
) {
2146 $config->get( 'UseSquid' ) && session_id() == '' && !$this->isPrintable() &&
2147 $this->mSquidMaxage
!= 0 && !$this->haveCacheVaryCookies()
2149 if ( $config->get( 'UseESI' ) ) {
2150 # We'll purge the proxy cache explicitly, but require end user agents
2151 # to revalidate against the proxy on each visit.
2152 # Surrogate-Control controls our Squid, Cache-Control downstream caches
2153 wfDebug( __METHOD__
. ": proxy caching with ESI; {$this->mLastModified} **\n", 'log' );
2154 # start with a shorter timeout for initial testing
2155 # header( 'Surrogate-Control: max-age=2678400+2678400, content="ESI/1.0"');
2156 $response->header( 'Surrogate-Control: max-age=' . $config->get( 'SquidMaxage' )
2157 . '+' . $this->mSquidMaxage
. ', content="ESI/1.0"' );
2158 $response->header( 'Cache-Control: s-maxage=0, must-revalidate, max-age=0' );
2160 # We'll purge the proxy cache for anons explicitly, but require end user agents
2161 # to revalidate against the proxy on each visit.
2162 # IMPORTANT! The Squid needs to replace the Cache-Control header with
2163 # Cache-Control: s-maxage=0, must-revalidate, max-age=0
2164 wfDebug( __METHOD__
. ": local proxy caching; {$this->mLastModified} **\n", 'log' );
2165 # start with a shorter timeout for initial testing
2166 # header( "Cache-Control: s-maxage=2678400, must-revalidate, max-age=0" );
2167 $response->header( 'Cache-Control: s-maxage=' . $this->mSquidMaxage
2168 . ', must-revalidate, max-age=0' );
2171 # We do want clients to cache if they can, but they *must* check for updates
2172 # on revisiting the page.
2173 wfDebug( __METHOD__
. ": private caching; {$this->mLastModified} **\n", 'log' );
2174 $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
2175 $response->header( "Cache-Control: private, must-revalidate, max-age=0" );
2177 if ( $this->mLastModified
) {
2178 $response->header( "Last-Modified: {$this->mLastModified}" );
2181 wfDebug( __METHOD__
. ": no caching **\n", 'log' );
2183 # In general, the absence of a last modified header should be enough to prevent
2184 # the client from using its cache. We send a few other things just to make sure.
2185 $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
2186 $response->header( 'Cache-Control: no-cache, no-store, max-age=0, must-revalidate' );
2187 $response->header( 'Pragma: no-cache' );
2192 * Finally, all the text has been munged and accumulated into
2193 * the object, let's actually output it:
2195 public function output() {
2196 if ( $this->mDoNothing
) {
2200 $response = $this->getRequest()->response();
2201 $config = $this->getConfig();
2203 if ( $this->mRedirect
!= '' ) {
2204 # Standards require redirect URLs to be absolute
2205 $this->mRedirect
= wfExpandUrl( $this->mRedirect
, PROTO_CURRENT
);
2207 $redirect = $this->mRedirect
;
2208 $code = $this->mRedirectCode
;
2210 if ( Hooks
::run( "BeforePageRedirect", array( $this, &$redirect, &$code ) ) ) {
2211 if ( $code == '301' ||
$code == '303' ) {
2212 if ( !$config->get( 'DebugRedirects' ) ) {
2213 $message = HttpStatus
::getMessage( $code );
2214 $response->header( "HTTP/1.1 $code $message" );
2216 $this->mLastModified
= wfTimestamp( TS_RFC2822
);
2218 if ( $config->get( 'VaryOnXFP' ) ) {
2219 $this->addVaryHeader( 'X-Forwarded-Proto' );
2221 $this->sendCacheControl();
2223 $response->header( "Content-Type: text/html; charset=utf-8" );
2224 if ( $config->get( 'DebugRedirects' ) ) {
2225 $url = htmlspecialchars( $redirect );
2226 print "<html>\n<head>\n<title>Redirect</title>\n</head>\n<body>\n";
2227 print "<p>Location: <a href=\"$url\">$url</a></p>\n";
2228 print "</body>\n</html>\n";
2230 $response->header( 'Location: ' . $redirect );
2235 } elseif ( $this->mStatusCode
) {
2236 $message = HttpStatus
::getMessage( $this->mStatusCode
);
2238 $response->header( 'HTTP/1.1 ' . $this->mStatusCode
. ' ' . $message );
2242 # Buffer output; final headers may depend on later processing
2245 $response->header( 'Content-type: ' . $config->get( 'MimeType' ) . '; charset=UTF-8' );
2246 $response->header( 'Content-language: ' . $config->get( 'LanguageCode' ) );
2248 // Avoid Internet Explorer "compatibility view" in IE 8-10, so that
2249 // jQuery etc. can work correctly.
2250 $response->header( 'X-UA-Compatible: IE=Edge' );
2252 // Prevent framing, if requested
2253 $frameOptions = $this->getFrameOptions();
2254 if ( $frameOptions ) {
2255 $response->header( "X-Frame-Options: $frameOptions" );
2258 if ( $this->mArticleBodyOnly
) {
2259 echo $this->mBodytext
;
2262 $sk = $this->getSkin();
2263 // add skin specific modules
2264 $modules = $sk->getDefaultModules();
2266 // enforce various default modules for all skins
2267 $coreModules = array(
2268 // keep this list as small as possible
2269 'mediawiki.page.startup',
2273 // Support for high-density display images if enabled
2274 if ( $config->get( 'ResponsiveImages' ) ) {
2275 $coreModules[] = 'mediawiki.hidpi';
2278 $this->addModules( $coreModules );
2279 foreach ( $modules as $group ) {
2280 $this->addModules( $group );
2282 MWDebug
::addModules( $this );
2284 // Hook that allows last minute changes to the output page, e.g.
2285 // adding of CSS or Javascript by extensions.
2286 Hooks
::run( 'BeforePageDisplay', array( &$this, &$sk ) );
2291 // This hook allows last minute changes to final overall output by modifying output buffer
2292 Hooks
::run( 'AfterFinalPageOutput', array( $this ) );
2294 $this->sendCacheControl();
2301 * Actually output something with print.
2303 * @param string $ins The string to output
2304 * @deprecated since 1.22 Use echo yourself.
2306 public function out( $ins ) {
2307 wfDeprecated( __METHOD__
, '1.22' );
2312 * Produce a "user is blocked" page.
2313 * @deprecated since 1.18
2315 function blockedPage() {
2316 throw new UserBlockedError( $this->getUser()->mBlock
);
2320 * Prepare this object to display an error page; disable caching and
2321 * indexing, clear the current text and redirect, set the page's title
2322 * and optionally an custom HTML title (content of the "<title>" tag).
2324 * @param string|Message $pageTitle Will be passed directly to setPageTitle()
2325 * @param string|Message $htmlTitle Will be passed directly to setHTMLTitle();
2326 * optional, if not passed the "<title>" attribute will be
2327 * based on $pageTitle
2329 public function prepareErrorPage( $pageTitle, $htmlTitle = false ) {
2330 $this->setPageTitle( $pageTitle );
2331 if ( $htmlTitle !== false ) {
2332 $this->setHTMLTitle( $htmlTitle );
2334 $this->setRobotPolicy( 'noindex,nofollow' );
2335 $this->setArticleRelated( false );
2336 $this->enableClientCache( false );
2337 $this->mRedirect
= '';
2338 $this->clearSubtitle();
2343 * Output a standard error page
2345 * showErrorPage( 'titlemsg', 'pagetextmsg' );
2346 * showErrorPage( 'titlemsg', 'pagetextmsg', array( 'param1', 'param2' ) );
2347 * showErrorPage( 'titlemsg', $messageObject );
2348 * showErrorPage( $titleMessageObject, $messageObject );
2350 * @param string|Message $title Message key (string) for page title, or a Message object
2351 * @param string|Message $msg Message key (string) for page text, or a Message object
2352 * @param array $params Message parameters; ignored if $msg is a Message object
2354 public function showErrorPage( $title, $msg, $params = array() ) {
2355 if ( !$title instanceof Message
) {
2356 $title = $this->msg( $title );
2359 $this->prepareErrorPage( $title );
2361 if ( $msg instanceof Message
) {
2362 if ( $params !== array() ) {
2363 trigger_error( 'Argument ignored: $params. The message parameters argument '
2364 . 'is discarded when the $msg argument is a Message object instead of '
2365 . 'a string.', E_USER_NOTICE
);
2367 $this->addHTML( $msg->parseAsBlock() );
2369 $this->addWikiMsgArray( $msg, $params );
2372 $this->returnToMain();
2376 * Output a standard permission error page
2378 * @param array $errors Error message keys
2379 * @param string $action Action that was denied or null if unknown
2381 public function showPermissionsErrorPage( array $errors, $action = null ) {
2382 // For some action (read, edit, create and upload), display a "login to do this action"
2383 // error if all of the following conditions are met:
2384 // 1. the user is not logged in
2385 // 2. the only error is insufficient permissions (i.e. no block or something else)
2386 // 3. the error can be avoided simply by logging in
2387 if ( in_array( $action, array( 'read', 'edit', 'createpage', 'createtalk', 'upload' ) )
2388 && $this->getUser()->isAnon() && count( $errors ) == 1 && isset( $errors[0][0] )
2389 && ( $errors[0][0] == 'badaccess-groups' ||
$errors[0][0] == 'badaccess-group0' )
2390 && ( User
::groupHasPermission( 'user', $action )
2391 || User
::groupHasPermission( 'autoconfirmed', $action ) )
2393 $displayReturnto = null;
2395 # Due to bug 32276, if a user does not have read permissions,
2396 # $this->getTitle() will just give Special:Badtitle, which is
2397 # not especially useful as a returnto parameter. Use the title
2398 # from the request instead, if there was one.
2399 $request = $this->getRequest();
2400 $returnto = Title
::newFromURL( $request->getVal( 'title', '' ) );
2401 if ( $action == 'edit' ) {
2402 $msg = 'whitelistedittext';
2403 $displayReturnto = $returnto;
2404 } elseif ( $action == 'createpage' ||
$action == 'createtalk' ) {
2405 $msg = 'nocreatetext';
2406 } elseif ( $action == 'upload' ) {
2407 $msg = 'uploadnologintext';
2409 $msg = 'loginreqpagetext';
2410 $displayReturnto = Title
::newMainPage();
2416 $query['returnto'] = $returnto->getPrefixedText();
2418 if ( !$request->wasPosted() ) {
2419 $returntoquery = $request->getValues();
2420 unset( $returntoquery['title'] );
2421 unset( $returntoquery['returnto'] );
2422 unset( $returntoquery['returntoquery'] );
2423 $query['returntoquery'] = wfArrayToCgi( $returntoquery );
2426 $loginLink = Linker
::linkKnown(
2427 SpecialPage
::getTitleFor( 'Userlogin' ),
2428 $this->msg( 'loginreqlink' )->escaped(),
2433 $this->prepareErrorPage( $this->msg( 'loginreqtitle' ) );
2434 $this->addHTML( $this->msg( $msg )->rawParams( $loginLink )->parse() );
2436 # Don't return to a page the user can't read otherwise
2437 # we'll end up in a pointless loop
2438 if ( $displayReturnto && $displayReturnto->userCan( 'read', $this->getUser() ) ) {
2439 $this->returnToMain( null, $displayReturnto );
2442 $this->prepareErrorPage( $this->msg( 'permissionserrors' ) );
2443 $this->addWikiText( $this->formatPermissionsErrorMessage( $errors, $action ) );
2448 * Display an error page indicating that a given version of MediaWiki is
2449 * required to use it
2451 * @param mixed $version The version of MediaWiki needed to use the page
2453 public function versionRequired( $version ) {
2454 $this->prepareErrorPage( $this->msg( 'versionrequired', $version ) );
2456 $this->addWikiMsg( 'versionrequiredtext', $version );
2457 $this->returnToMain();
2461 * Display an error page noting that a given permission bit is required.
2462 * @deprecated since 1.18, just throw the exception directly
2463 * @param string $permission Key required
2464 * @throws PermissionsError
2466 public function permissionRequired( $permission ) {
2467 throw new PermissionsError( $permission );
2471 * Produce the stock "please login to use the wiki" page
2473 * @deprecated since 1.19; throw the exception directly
2475 public function loginToUse() {
2476 throw new PermissionsError( 'read' );
2480 * Format a list of error messages
2482 * @param array $errors Array of arrays returned by Title::getUserPermissionsErrors
2483 * @param string $action Action that was denied or null if unknown
2484 * @return string The wikitext error-messages, formatted into a list.
2486 public function formatPermissionsErrorMessage( array $errors, $action = null ) {
2487 if ( $action == null ) {
2488 $text = $this->msg( 'permissionserrorstext', count( $errors ) )->plain() . "\n\n";
2490 $action_desc = $this->msg( "action-$action" )->plain();
2492 'permissionserrorstext-withaction',
2495 )->plain() . "\n\n";
2498 if ( count( $errors ) > 1 ) {
2499 $text .= '<ul class="permissions-errors">' . "\n";
2501 foreach ( $errors as $error ) {
2503 $text .= call_user_func_array( array( $this, 'msg' ), $error )->plain();
2508 $text .= "<div class=\"permissions-errors\">\n" .
2509 call_user_func_array( array( $this, 'msg' ), reset( $errors ) )->plain() .
2517 * Display a page stating that the Wiki is in read-only mode.
2518 * Should only be called after wfReadOnly() has returned true.
2520 * Historically, this function was used to show the source of the page that the user
2521 * was trying to edit and _also_ permissions error messages. The relevant code was
2522 * moved into EditPage in 1.19 (r102024 / d83c2a431c2a) and removed here in 1.25.
2524 * @deprecated since 1.25; throw the exception directly
2525 * @throws ReadOnlyError
2527 public function readOnlyPage() {
2528 if ( func_num_args() > 0 ) {
2529 throw new MWException( __METHOD__
. ' no longer accepts arguments since 1.25.' );
2532 throw new ReadOnlyError
;
2536 * Turn off regular page output and return an error response
2537 * for when rate limiting has triggered.
2539 * @deprecated since 1.25; throw the exception directly
2541 public function rateLimited() {
2542 wfDeprecated( __METHOD__
, '1.25' );
2543 throw new ThrottledError
;
2547 * Show a warning about slave lag
2549 * If the lag is higher than $wgSlaveLagCritical seconds,
2550 * then the warning is a bit more obvious. If the lag is
2551 * lower than $wgSlaveLagWarning, then no warning is shown.
2553 * @param int $lag Slave lag
2555 public function showLagWarning( $lag ) {
2556 $config = $this->getConfig();
2557 if ( $lag >= $config->get( 'SlaveLagWarning' ) ) {
2558 $message = $lag < $config->get( 'SlaveLagCritical' )
2561 $wrap = Html
::rawElement( 'div', array( 'class' => "mw-{$message}" ), "\n$1\n" );
2562 $this->wrapWikiMsg( "$wrap\n", array( $message, $this->getLanguage()->formatNum( $lag ) ) );
2566 public function showFatalError( $message ) {
2567 $this->prepareErrorPage( $this->msg( 'internalerror' ) );
2569 $this->addHTML( $message );
2572 public function showUnexpectedValueError( $name, $val ) {
2573 $this->showFatalError( $this->msg( 'unexpected', $name, $val )->text() );
2576 public function showFileCopyError( $old, $new ) {
2577 $this->showFatalError( $this->msg( 'filecopyerror', $old, $new )->text() );
2580 public function showFileRenameError( $old, $new ) {
2581 $this->showFatalError( $this->msg( 'filerenameerror', $old, $new )->text() );
2584 public function showFileDeleteError( $name ) {
2585 $this->showFatalError( $this->msg( 'filedeleteerror', $name )->text() );
2588 public function showFileNotFoundError( $name ) {
2589 $this->showFatalError( $this->msg( 'filenotfound', $name )->text() );
2593 * Add a "return to" link pointing to a specified title
2595 * @param Title $title Title to link
2596 * @param array $query Query string parameters
2597 * @param string $text Text of the link (input is not escaped)
2598 * @param array $options Options array to pass to Linker
2600 public function addReturnTo( $title, array $query = array(), $text = null, $options = array() ) {
2601 $link = $this->msg( 'returnto' )->rawParams(
2602 Linker
::link( $title, $text, array(), $query, $options ) )->escaped();
2603 $this->addHTML( "<p id=\"mw-returnto\">{$link}</p>\n" );
2607 * Add a "return to" link pointing to a specified title,
2608 * or the title indicated in the request, or else the main page
2610 * @param mixed $unused
2611 * @param Title|string $returnto Title or String to return to
2612 * @param string $returntoquery Query string for the return to link
2614 public function returnToMain( $unused = null, $returnto = null, $returntoquery = null ) {
2615 if ( $returnto == null ) {
2616 $returnto = $this->getRequest()->getText( 'returnto' );
2619 if ( $returntoquery == null ) {
2620 $returntoquery = $this->getRequest()->getText( 'returntoquery' );
2623 if ( $returnto === '' ) {
2624 $returnto = Title
::newMainPage();
2627 if ( is_object( $returnto ) ) {
2628 $titleObj = $returnto;
2630 $titleObj = Title
::newFromText( $returnto );
2632 if ( !is_object( $titleObj ) ) {
2633 $titleObj = Title
::newMainPage();
2636 $this->addReturnTo( $titleObj, wfCgiToArray( $returntoquery ) );
2640 * @param Skin $sk The given Skin
2641 * @param bool $includeStyle Unused
2642 * @return string The doctype, opening "<html>", and head element.
2644 public function headElement( Skin
$sk, $includeStyle = true ) {
2647 $userdir = $this->getLanguage()->getDir();
2648 $sitedir = $wgContLang->getDir();
2650 $ret = Html
::htmlHeader( $sk->getHtmlElementAttributes() );
2652 if ( $this->getHTMLTitle() == '' ) {
2653 $this->setHTMLTitle( $this->msg( 'pagetitle', $this->getPageTitle() )->inContentLanguage() );
2656 $openHead = Html
::openElement( 'head' );
2658 # Don't bother with the newline if $head == ''
2659 $ret .= "$openHead\n";
2662 if ( !Html
::isXmlMimeType( $this->getConfig()->get( 'MimeType' ) ) ) {
2663 // Add <meta charset="UTF-8">
2664 // This should be before <title> since it defines the charset used by
2665 // text including the text inside <title>.
2666 // The spec recommends defining XHTML5's charset using the XML declaration
2668 // Our XML declaration is output by Html::htmlHeader.
2669 // http://www.whatwg.org/html/semantics.html#attr-meta-http-equiv-content-type
2670 // http://www.whatwg.org/html/semantics.html#charset
2671 $ret .= Html
::element( 'meta', array( 'charset' => 'UTF-8' ) ) . "\n";
2674 $ret .= Html
::element( 'title', null, $this->getHTMLTitle() ) . "\n";
2676 foreach ( $this->getHeadLinksArray() as $item ) {
2677 $ret .= $item . "\n";
2680 // No newline after buildCssLinks since makeResourceLoaderLink did that already
2681 $ret .= $this->buildCssLinks();
2683 $ret .= $this->getHeadScripts() . "\n";
2685 foreach ( $this->mHeadItems
as $item ) {
2686 $ret .= $item . "\n";
2689 $closeHead = Html
::closeElement( 'head' );
2691 $ret .= "$closeHead\n";
2694 $bodyClasses = array();
2695 $bodyClasses[] = 'mediawiki';
2697 # Classes for LTR/RTL directionality support
2698 $bodyClasses[] = $userdir;
2699 $bodyClasses[] = "sitedir-$sitedir";
2701 if ( $this->getLanguage()->capitalizeAllNouns() ) {
2702 # A <body> class is probably not the best way to do this . . .
2703 $bodyClasses[] = 'capitalize-all-nouns';
2706 $bodyClasses[] = $sk->getPageClasses( $this->getTitle() );
2707 $bodyClasses[] = 'skin-' . Sanitizer
::escapeClass( $sk->getSkinName() );
2709 'action-' . Sanitizer
::escapeClass( Action
::getActionName( $this->getContext() ) );
2711 $bodyAttrs = array();
2712 // While the implode() is not strictly needed, it's used for backwards compatibility
2713 // (this used to be built as a string and hooks likely still expect that).
2714 $bodyAttrs['class'] = implode( ' ', $bodyClasses );
2716 // Allow skins and extensions to add body attributes they need
2717 $sk->addToBodyAttributes( $this, $bodyAttrs );
2718 Hooks
::run( 'OutputPageBodyAttributes', array( $this, $sk, &$bodyAttrs ) );
2720 $ret .= Html
::openElement( 'body', $bodyAttrs ) . "\n";
2726 * Get a ResourceLoader object associated with this OutputPage
2728 * @return ResourceLoader
2730 public function getResourceLoader() {
2731 if ( is_null( $this->mResourceLoader
) ) {
2732 $this->mResourceLoader
= new ResourceLoader( $this->getConfig() );
2734 return $this->mResourceLoader
;
2739 * @param array|string $modules One or more module names
2740 * @param string $only ResourceLoaderModule TYPE_ class constant
2741 * @param bool $useESI
2742 * @param array $extraQuery Array with extra query parameters to add to each
2743 * request. array( param => value ).
2744 * @param bool $loadCall If true, output an (asynchronous) mw.loader.load()
2745 * call rather than a "<script src='...'>" tag.
2746 * @return string The html "<script>", "<link>" and "<style>" tags
2748 public function makeResourceLoaderLink( $modules, $only, $useESI = false,
2749 array $extraQuery = array(), $loadCall = false
2751 $modules = (array)$modules;
2755 'states' => array(),
2758 if ( !count( $modules ) ) {
2762 if ( count( $modules ) > 1 ) {
2763 // Remove duplicate module requests
2764 $modules = array_unique( $modules );
2765 // Sort module names so requests are more uniform
2768 if ( ResourceLoader
::inDebugMode() ) {
2769 // Recursively call us for every item
2770 foreach ( $modules as $name ) {
2771 $link = $this->makeResourceLoaderLink( $name, $only, $useESI );
2772 $links['html'] .= $link['html'];
2773 $links['states'] +
= $link['states'];
2779 if ( !is_null( $this->mTarget
) ) {
2780 $extraQuery['target'] = $this->mTarget
;
2783 // Create keyed-by-source and then keyed-by-group list of module objects from modules list
2784 $sortedModules = array();
2785 $resourceLoader = $this->getResourceLoader();
2786 $resourceLoaderUseESI = $this->getConfig()->get( 'ResourceLoaderUseESI' );
2787 foreach ( $modules as $name ) {
2788 $module = $resourceLoader->getModule( $name );
2789 # Check that we're allowed to include this module on this page
2791 ||
( $module->getOrigin() > $this->getAllowedModules( ResourceLoaderModule
::TYPE_SCRIPTS
)
2792 && $only == ResourceLoaderModule
::TYPE_SCRIPTS
)
2793 ||
( $module->getOrigin() > $this->getAllowedModules( ResourceLoaderModule
::TYPE_STYLES
)
2794 && $only == ResourceLoaderModule
::TYPE_STYLES
)
2795 ||
( $module->getOrigin() > $this->getAllowedModules( ResourceLoaderModule
::TYPE_COMBINED
)
2796 && $only == ResourceLoaderModule
::TYPE_COMBINED
)
2797 ||
( $this->mTarget
&& !in_array( $this->mTarget
, $module->getTargets() ) )
2802 $sortedModules[$module->getSource()][$module->getGroup()][$name] = $module;
2805 foreach ( $sortedModules as $source => $groups ) {
2806 foreach ( $groups as $group => $grpModules ) {
2807 // Special handling for user-specific groups
2809 if ( ( $group === 'user' ||
$group === 'private' ) && $this->getUser()->isLoggedIn() ) {
2810 $user = $this->getUser()->getName();
2813 // Create a fake request based on the one we are about to make so modules return
2814 // correct timestamp and emptiness data
2815 $query = ResourceLoader
::makeLoaderQuery(
2816 array(), // modules; not determined yet
2817 $this->getLanguage()->getCode(),
2818 $this->getSkin()->getSkinName(),
2820 null, // version; not determined yet
2821 ResourceLoader
::inDebugMode(),
2822 $only === ResourceLoaderModule
::TYPE_COMBINED ?
null : $only,
2823 $this->isPrintable(),
2824 $this->getRequest()->getBool( 'handheld' ),
2827 $context = new ResourceLoaderContext( $resourceLoader, new FauxRequest( $query ) );
2829 // Extract modules that know they're empty and see if we have one or more
2832 foreach ( $grpModules as $key => $module ) {
2833 // Inline empty modules: since they're empty, just mark them as 'ready' (bug 46857)
2834 // If we're only getting the styles, we don't need to do anything for empty modules.
2835 if ( $module->isKnownEmpty( $context ) ) {
2836 unset( $grpModules[$key] );
2837 if ( $only !== ResourceLoaderModule
::TYPE_STYLES
) {
2838 $links['states'][$key] = 'ready';
2842 $isRaw |
= $module->isRaw();
2845 // If there are no non-empty modules, skip this group
2846 if ( count( $grpModules ) === 0 ) {
2850 // Inline private modules. These can't be loaded through load.php for security
2851 // reasons, see bug 34907. Note that these modules should be loaded from
2852 // getHeadScripts() before the first loader call. Otherwise other modules can't
2853 // properly use them as dependencies (bug 30914)
2854 if ( $group === 'private' ) {
2855 if ( $only == ResourceLoaderModule
::TYPE_STYLES
) {
2856 $links['html'] .= Html
::inlineStyle(
2857 $resourceLoader->makeModuleResponse( $context, $grpModules )
2860 $links['html'] .= ResourceLoader
::makeInlineScript(
2861 $resourceLoader->makeModuleResponse( $context, $grpModules )
2864 $links['html'] .= "\n";
2868 // Special handling for the user group; because users might change their stuff
2869 // on-wiki like user pages, or user preferences; we need to find the highest
2870 // timestamp of these user-changeable modules so we can ensure cache misses on change
2871 // This should NOT be done for the site group (bug 27564) because anons get that too
2872 // and we shouldn't be putting timestamps in Squid-cached HTML
2874 if ( $group === 'user' ) {
2875 // Get the maximum timestamp
2877 foreach ( $grpModules as $module ) {
2878 $timestamp = max( $timestamp, $module->getModifiedTime( $context ) );
2880 // Add a version parameter so cache will break when things change
2881 $query['version'] = wfTimestamp( TS_ISO_8601_BASIC
, $timestamp );
2884 $query['modules'] = ResourceLoader
::makePackedModulesString( array_keys( $grpModules ) );
2885 $moduleContext = new ResourceLoaderContext( $resourceLoader, new FauxRequest( $query ) );
2886 $url = $resourceLoader->createLoaderURL( $source, $moduleContext, $extraQuery );
2888 if ( $useESI && $resourceLoaderUseESI ) {
2889 $esi = Xml
::element( 'esi:include', array( 'src' => $url ) );
2890 if ( $only == ResourceLoaderModule
::TYPE_STYLES
) {
2891 $link = Html
::inlineStyle( $esi );
2893 $link = Html
::inlineScript( $esi );
2896 // Automatically select style/script elements
2897 if ( $only === ResourceLoaderModule
::TYPE_STYLES
) {
2898 $link = Html
::linkedStyle( $url );
2899 } elseif ( $loadCall ) {
2900 $link = ResourceLoader
::makeInlineScript(
2901 Xml
::encodeJsCall( 'mw.loader.load', array( $url, 'text/javascript', true ) )
2904 $link = Html
::linkedScript( $url );
2905 if ( !$context->getRaw() && !$isRaw ) {
2906 // Wrap only=script / only=combined requests in a conditional as
2907 // browsers not supported by the startup module would unconditionally
2908 // execute this module. Otherwise users will get "ReferenceError: mw is
2909 // undefined" or "jQuery is undefined" from e.g. a "site" module.
2910 $link = ResourceLoader
::makeInlineScript(
2911 Xml
::encodeJsCall( 'document.write', array( $link ) )
2915 // For modules requested directly in the html via <link> or <script>,
2916 // tell mw.loader they are being loading to prevent duplicate requests.
2917 foreach ( $grpModules as $key => $module ) {
2918 // Don't output state=loading for the startup module..
2919 if ( $key !== 'startup' ) {
2920 $links['states'][$key] = 'loading';
2926 if ( $group == 'noscript' ) {
2927 $links['html'] .= Html
::rawElement( 'noscript', array(), $link ) . "\n";
2929 $links['html'] .= $link . "\n";
2938 * Build html output from an array of links from makeResourceLoaderLink.
2939 * @param array $links
2940 * @return string HTML
2942 protected static function getHtmlFromLoaderLinks( array $links ) {
2945 foreach ( $links as $link ) {
2946 if ( !is_array( $link ) ) {
2949 $html .= $link['html'];
2950 $states +
= $link['states'];
2954 if ( count( $states ) ) {
2955 $html = ResourceLoader
::makeInlineScript(
2956 ResourceLoader
::makeLoaderStateScript( $states )
2964 * JS stuff to put in the "<head>". This is the startup module, config
2965 * vars and modules marked with position 'top'
2967 * @return string HTML fragment
2969 function getHeadScripts() {
2970 // Startup - this will immediately load jquery and mediawiki modules
2972 $links[] = $this->makeResourceLoaderLink( 'startup', ResourceLoaderModule
::TYPE_SCRIPTS
, true );
2974 // Load config before anything else
2975 $links[] = ResourceLoader
::makeInlineScript(
2976 ResourceLoader
::makeConfigSetScript( $this->getJSVars() )
2979 // Load embeddable private modules before any loader links
2980 // This needs to be TYPE_COMBINED so these modules are properly wrapped
2981 // in mw.loader.implement() calls and deferred until mw.user is available
2982 $embedScripts = array( 'user.options', 'user.tokens' );
2983 $links[] = $this->makeResourceLoaderLink( $embedScripts, ResourceLoaderModule
::TYPE_COMBINED
);
2985 // Scripts and messages "only" requests marked for top inclusion
2986 // Messages should go first
2987 $links[] = $this->makeResourceLoaderLink(
2988 $this->getModuleMessages( true, 'top' ),
2989 ResourceLoaderModule
::TYPE_MESSAGES
2991 $links[] = $this->makeResourceLoaderLink(
2992 $this->getModuleScripts( true, 'top' ),
2993 ResourceLoaderModule
::TYPE_SCRIPTS
2996 // Modules requests - let the client calculate dependencies and batch requests as it likes
2997 // Only load modules that have marked themselves for loading at the top
2998 $modules = $this->getModules( true, 'top' );
3000 $links[] = ResourceLoader
::makeInlineScript(
3001 Xml
::encodeJsCall( 'mw.loader.load', array( $modules ) )
3005 if ( $this->getConfig()->get( 'ResourceLoaderExperimentalAsyncLoading' ) ) {
3006 $links[] = $this->getScriptsForBottomQueue( true );
3009 return self
::getHtmlFromLoaderLinks( $links );
3013 * JS stuff to put at the 'bottom', which can either be the bottom of the
3014 * "<body>" or the bottom of the "<head>" depending on
3015 * $wgResourceLoaderExperimentalAsyncLoading: modules marked with position
3016 * 'bottom', legacy scripts ($this->mScripts), user preferences, site JS
3019 * @param bool $inHead If true, this HTML goes into the "<head>",
3020 * if false it goes into the "<body>".
3023 function getScriptsForBottomQueue( $inHead ) {
3024 // Scripts and messages "only" requests marked for bottom inclusion
3025 // If we're in the <head>, use load() calls rather than <script src="..."> tags
3026 // Messages should go first
3028 $links[] = $this->makeResourceLoaderLink( $this->getModuleMessages( true, 'bottom' ),
3029 ResourceLoaderModule
::TYPE_MESSAGES
, /* $useESI = */ false, /* $extraQuery = */ array(),
3030 /* $loadCall = */ $inHead
3032 $links[] = $this->makeResourceLoaderLink( $this->getModuleScripts( true, 'bottom' ),
3033 ResourceLoaderModule
::TYPE_SCRIPTS
, /* $useESI = */ false, /* $extraQuery = */ array(),
3034 /* $loadCall = */ $inHead
3037 // Modules requests - let the client calculate dependencies and batch requests as it likes
3038 // Only load modules that have marked themselves for loading at the bottom
3039 $modules = $this->getModules( true, 'bottom' );
3041 $links[] = ResourceLoader
::makeInlineScript(
3042 Xml
::encodeJsCall( 'mw.loader.load', array( $modules, null, true ) )
3047 $links[] = "\n" . $this->mScripts
;
3049 // Add site JS if enabled
3050 $links[] = $this->makeResourceLoaderLink( 'site', ResourceLoaderModule
::TYPE_SCRIPTS
,
3051 /* $useESI = */ false, /* $extraQuery = */ array(), /* $loadCall = */ $inHead
3054 // Add user JS if enabled
3055 if ( $this->getConfig()->get( 'AllowUserJs' )
3056 && $this->getUser()->isLoggedIn()
3057 && $this->getTitle()
3058 && $this->getTitle()->isJsSubpage()
3059 && $this->userCanPreview()
3061 # XXX: additional security check/prompt?
3062 // We're on a preview of a JS subpage
3063 // Exclude this page from the user module in case it's in there (bug 26283)
3064 $links[] = $this->makeResourceLoaderLink( 'user', ResourceLoaderModule
::TYPE_SCRIPTS
, false,
3065 array( 'excludepage' => $this->getTitle()->getPrefixedDBkey() ), $inHead
3067 // Load the previewed JS
3068 $links[] = Html
::inlineScript( "\n"
3069 . $this->getRequest()->getText( 'wpTextbox1' ) . "\n" ) . "\n";
3071 // FIXME: If the user is previewing, say, ./vector.js, his ./common.js will be loaded
3072 // asynchronously and may arrive *after* the inline script here. So the previewed code
3073 // may execute before ./common.js runs. Normally, ./common.js runs before ./vector.js...
3075 // Include the user module normally, i.e., raw to avoid it being wrapped in a closure.
3076 $links[] = $this->makeResourceLoaderLink( 'user', ResourceLoaderModule
::TYPE_SCRIPTS
,
3077 /* $useESI = */ false, /* $extraQuery = */ array(), /* $loadCall = */ $inHead
3081 // Group JS is only enabled if site JS is enabled.
3082 $links[] = $this->makeResourceLoaderLink( 'user.groups', ResourceLoaderModule
::TYPE_COMBINED
,
3083 /* $useESI = */ false, /* $extraQuery = */ array(), /* $loadCall = */ $inHead
3086 return self
::getHtmlFromLoaderLinks( $links );
3090 * JS stuff to put at the bottom of the "<body>"
3093 function getBottomScripts() {
3094 // Optimise jQuery ready event cross-browser.
3095 // This also enforces $.isReady to be true at </body> which fixes the
3096 // mw.loader bug in Firefox with using document.write between </body>
3097 // and the DOMContentReady event (bug 47457).
3098 $html = Html
::inlineScript( 'if(window.jQuery)jQuery.ready();' );
3100 if ( !$this->getConfig()->get( 'ResourceLoaderExperimentalAsyncLoading' ) ) {
3101 $html .= $this->getScriptsForBottomQueue( false );
3108 * Get the javascript config vars to include on this page
3110 * @return array Array of javascript config vars
3113 public function getJsConfigVars() {
3114 return $this->mJsConfigVars
;
3118 * Add one or more variables to be set in mw.config in JavaScript
3120 * @param string|array $keys Key or array of key/value pairs
3121 * @param mixed $value [optional] Value of the configuration variable
3123 public function addJsConfigVars( $keys, $value = null ) {
3124 if ( is_array( $keys ) ) {
3125 foreach ( $keys as $key => $value ) {
3126 $this->mJsConfigVars
[$key] = $value;
3131 $this->mJsConfigVars
[$keys] = $value;
3135 * Get an array containing the variables to be set in mw.config in JavaScript.
3137 * Do not add things here which can be evaluated in ResourceLoaderStartUpModule
3138 * - in other words, page-independent/site-wide variables (without state).
3139 * You will only be adding bloat to the html page and causing page caches to
3140 * have to be purged on configuration changes.
3143 public function getJSVars() {
3148 $canonicalSpecialPageName = false; # bug 21115
3150 $title = $this->getTitle();
3151 $ns = $title->getNamespace();
3152 $canonicalNamespace = MWNamespace
::exists( $ns )
3153 ? MWNamespace
::getCanonicalName( $ns )
3154 : $title->getNsText();
3156 $sk = $this->getSkin();
3157 // Get the relevant title so that AJAX features can use the correct page name
3158 // when making API requests from certain special pages (bug 34972).
3159 $relevantTitle = $sk->getRelevantTitle();
3160 $relevantUser = $sk->getRelevantUser();
3162 if ( $ns == NS_SPECIAL
) {
3163 list( $canonicalSpecialPageName, /*...*/ ) =
3164 SpecialPageFactory
::resolveAlias( $title->getDBkey() );
3165 } elseif ( $this->canUseWikiPage() ) {
3166 $wikiPage = $this->getWikiPage();
3167 $curRevisionId = $wikiPage->getLatest();
3168 $articleId = $wikiPage->getId();
3171 $lang = $title->getPageLanguage();
3173 // Pre-process information
3174 $separatorTransTable = $lang->separatorTransformTable();
3175 $separatorTransTable = $separatorTransTable ?
$separatorTransTable : array();
3176 $compactSeparatorTransTable = array(
3177 implode( "\t", array_keys( $separatorTransTable ) ),
3178 implode( "\t", $separatorTransTable ),
3180 $digitTransTable = $lang->digitTransformTable();
3181 $digitTransTable = $digitTransTable ?
$digitTransTable : array();
3182 $compactDigitTransTable = array(
3183 implode( "\t", array_keys( $digitTransTable ) ),
3184 implode( "\t", $digitTransTable ),
3187 $user = $this->getUser();
3190 'wgCanonicalNamespace' => $canonicalNamespace,
3191 'wgCanonicalSpecialPageName' => $canonicalSpecialPageName,
3192 'wgNamespaceNumber' => $title->getNamespace(),
3193 'wgPageName' => $title->getPrefixedDBkey(),
3194 'wgTitle' => $title->getText(),
3195 'wgCurRevisionId' => $curRevisionId,
3196 'wgRevisionId' => (int)$this->getRevisionId(),
3197 'wgArticleId' => $articleId,
3198 'wgIsArticle' => $this->isArticle(),
3199 'wgIsRedirect' => $title->isRedirect(),
3200 'wgAction' => Action
::getActionName( $this->getContext() ),
3201 'wgUserName' => $user->isAnon() ?
null : $user->getName(),
3202 'wgUserGroups' => $user->getEffectiveGroups(),
3203 'wgCategories' => $this->getCategories(),
3204 'wgBreakFrames' => $this->getFrameOptions() == 'DENY',
3205 'wgPageContentLanguage' => $lang->getCode(),
3206 'wgPageContentModel' => $title->getContentModel(),
3207 'wgSeparatorTransformTable' => $compactSeparatorTransTable,
3208 'wgDigitTransformTable' => $compactDigitTransTable,
3209 'wgDefaultDateFormat' => $lang->getDefaultDateFormat(),
3210 'wgMonthNames' => $lang->getMonthNamesArray(),
3211 'wgMonthNamesShort' => $lang->getMonthAbbreviationsArray(),
3212 'wgRelevantPageName' => $relevantTitle->getPrefixedDBkey(),
3213 'wgRelevantArticleId' => $relevantTitle->getArticleId(),
3216 if ( $user->isLoggedIn() ) {
3217 $vars['wgUserId'] = $user->getId();
3218 $vars['wgUserEditCount'] = $user->getEditCount();
3219 $userReg = wfTimestampOrNull( TS_UNIX
, $user->getRegistration() );
3220 $vars['wgUserRegistration'] = $userReg !== null ?
( $userReg * 1000 ) : null;
3221 // Get the revision ID of the oldest new message on the user's talk
3222 // page. This can be used for constructing new message alerts on
3224 $vars['wgUserNewMsgRevisionId'] = $user->getNewMessageRevisionId();
3227 if ( $wgContLang->hasVariants() ) {
3228 $vars['wgUserVariant'] = $wgContLang->getPreferredVariant();
3230 // Same test as SkinTemplate
3231 $vars['wgIsProbablyEditable'] = $title->quickUserCan( 'edit', $user )
3232 && ( $title->exists() ||
$title->quickUserCan( 'create', $user ) );
3234 foreach ( $title->getRestrictionTypes() as $type ) {
3235 $vars['wgRestriction' . ucfirst( $type )] = $title->getRestrictions( $type );
3238 if ( $title->isMainPage() ) {
3239 $vars['wgIsMainPage'] = true;
3242 if ( $this->mRedirectedFrom
) {
3243 $vars['wgRedirectedFrom'] = $this->mRedirectedFrom
->getPrefixedDBkey();
3246 if ( $relevantUser ) {
3247 $vars['wgRelevantUserName'] = $relevantUser->getName();
3250 // Allow extensions to add their custom variables to the mw.config map.
3251 // Use the 'ResourceLoaderGetConfigVars' hook if the variable is not
3252 // page-dependant but site-wide (without state).
3253 // Alternatively, you may want to use OutputPage->addJsConfigVars() instead.
3254 Hooks
::run( 'MakeGlobalVariablesScript', array( &$vars, $this ) );
3256 // Merge in variables from addJsConfigVars last
3257 return array_merge( $vars, $this->getJsConfigVars() );
3261 * To make it harder for someone to slip a user a fake
3262 * user-JavaScript or user-CSS preview, a random token
3263 * is associated with the login session. If it's not
3264 * passed back with the preview request, we won't render
3269 public function userCanPreview() {
3270 if ( $this->getRequest()->getVal( 'action' ) != 'submit'
3271 ||
!$this->getRequest()->wasPosted()
3272 ||
!$this->getUser()->matchEditToken(
3273 $this->getRequest()->getVal( 'wpEditToken' ) )
3277 if ( !$this->getTitle()->isJsSubpage() && !$this->getTitle()->isCssSubpage() ) {
3280 if ( !$this->getTitle()->isSubpageOf( $this->getUser()->getUserPage() ) ) {
3281 // Don't execute another user's CSS or JS on preview (T85855)
3285 return !count( $this->getTitle()->getUserPermissionsErrors( 'edit', $this->getUser() ) );
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', array(
3300 'name' => 'generator',
3301 'content' => "MediaWiki $wgVersion",
3304 if ( $config->get( 'ReferrerPolicy' ) !== false ) {
3305 $tags['meta-referrer'] = Html
::element( 'meta', array(
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', array(
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() ||
$this->getTitle()->quickUserCan( 'create', $user ) ) ) {
3349 // Original UniversalEditButton
3350 $msg = $this->msg( 'edit' )->text();
3351 $tags['universal-edit-button'] = Html
::element( 'link', array(
3352 'rel' => 'alternate',
3353 'type' => 'application/x-wiki',
3355 'href' => $this->getTitle()->getEditURL(),
3357 // Alternate edit link
3358 $tags['alternative-edit'] = Html
::element( 'link', array(
3361 'href' => $this->getTitle()->getEditURL(),
3366 # Generally the order of the favicon and apple-touch-icon links
3367 # should not matter, but Konqueror (3.5.9 at least) incorrectly
3368 # uses whichever one appears later in the HTML source. Make sure
3369 # apple-touch-icon is specified first to avoid this.
3370 if ( $config->get( 'AppleTouchIcon' ) !== false ) {
3371 $tags['apple-touch-icon'] = Html
::element( 'link', array(
3372 'rel' => 'apple-touch-icon',
3373 'href' => $config->get( 'AppleTouchIcon' )
3377 if ( $config->get( 'Favicon' ) !== false ) {
3378 $tags['favicon'] = Html
::element( 'link', array(
3379 'rel' => 'shortcut icon',
3380 'href' => $config->get( 'Favicon' )
3384 # OpenSearch description link
3385 $tags['opensearch'] = Html
::element( 'link', array(
3387 'type' => 'application/opensearchdescription+xml',
3388 'href' => wfScript( 'opensearch_desc' ),
3389 'title' => $this->msg( 'opensearch-desc' )->inContentLanguage()->text(),
3392 if ( $config->get( 'EnableAPI' ) ) {
3393 # Real Simple Discovery link, provides auto-discovery information
3394 # for the MediaWiki API (and potentially additional custom API
3395 # support such as WordPress or Twitter-compatible APIs for a
3396 # blogging extension, etc)
3397 $tags['rsd'] = Html
::element( 'link', array(
3399 'type' => 'application/rsd+xml',
3400 // Output a protocol-relative URL here if $wgServer is protocol-relative
3401 // Whether RSD accepts relative or protocol-relative URLs is completely undocumented, though
3402 'href' => wfExpandUrl( wfAppendQuery(
3404 array( 'action' => 'rsd' ) ),
3411 if ( !$config->get( 'DisableLangConversion' ) ) {
3412 $lang = $this->getTitle()->getPageLanguage();
3413 if ( $lang->hasVariants() ) {
3414 $variants = $lang->getVariants();
3415 foreach ( $variants as $_v ) {
3416 $tags["variant-$_v"] = Html
::element( 'link', array(
3417 'rel' => 'alternate',
3418 'hreflang' => wfBCP47( $_v ),
3419 'href' => $this->getTitle()->getLocalURL( array( 'variant' => $_v ) ) )
3423 # x-default link per https://support.google.com/webmasters/answer/189077?hl=en
3424 $tags["variant-x-default"] = Html
::element( 'link', array(
3425 'rel' => 'alternate',
3426 'hreflang' => 'x-default',
3427 'href' => $this->getTitle()->getLocalURL() ) );
3432 if ( $config->get( 'RightsPage' ) ) {
3433 $copy = Title
::newFromText( $config->get( 'RightsPage' ) );
3436 $copyright = $copy->getLocalURL();
3440 if ( !$copyright && $config->get( 'RightsUrl' ) ) {
3441 $copyright = $config->get( 'RightsUrl' );
3445 $tags['copyright'] = Html
::element( 'link', array(
3446 'rel' => 'copyright',
3447 'href' => $copyright )
3452 if ( $config->get( 'Feed' ) ) {
3453 foreach ( $this->getSyndicationLinks() as $format => $link ) {
3454 # Use the page name for the title. In principle, this could
3455 # lead to issues with having the same name for different feeds
3456 # corresponding to the same page, but we can't avoid that at
3459 $tags[] = $this->feedLink(
3462 # Used messages: 'page-rss-feed' and 'page-atom-feed' (for an easier grep)
3463 $this->msg( "page-{$format}-feed", $this->getTitle()->getPrefixedText() )->text()
3467 # Recent changes feed should appear on every page (except recentchanges,
3468 # that would be redundant). Put it after the per-page feed to avoid
3469 # changing existing behavior. It's still available, probably via a
3470 # menu in your browser. Some sites might have a different feed they'd
3471 # like to promote instead of the RC feed (maybe like a "Recent New Articles"
3472 # or "Breaking news" one). For this, we see if $wgOverrideSiteFeed is defined.
3473 # If so, use it instead.
3474 $sitename = $config->get( 'Sitename' );
3475 if ( $config->get( 'OverrideSiteFeed' ) ) {
3476 foreach ( $config->get( 'OverrideSiteFeed' ) as $type => $feedUrl ) {
3477 // Note, this->feedLink escapes the url.
3478 $tags[] = $this->feedLink(
3481 $this->msg( "site-{$type}-feed", $sitename )->text()
3484 } elseif ( !$this->getTitle()->isSpecial( 'Recentchanges' ) ) {
3485 $rctitle = SpecialPage
::getTitleFor( 'Recentchanges' );
3486 foreach ( $config->get( 'AdvertisedFeedTypes' ) as $format ) {
3487 $tags[] = $this->feedLink(
3489 $rctitle->getLocalURL( array( 'feed' => $format ) ),
3490 # For grep: 'site-rss-feed', 'site-atom-feed'
3491 $this->msg( "site-{$format}-feed", $sitename )->text()
3498 if ( $config->get( 'EnableCanonicalServerLink' ) ) {
3499 if ( $canonicalUrl !== false ) {
3500 $canonicalUrl = wfExpandUrl( $canonicalUrl, PROTO_CANONICAL
);
3502 $reqUrl = $this->getRequest()->getRequestURL();
3503 $canonicalUrl = wfExpandUrl( $reqUrl, PROTO_CANONICAL
);
3506 if ( $canonicalUrl !== false ) {
3507 $tags[] = Html
::element( 'link', array(
3508 'rel' => 'canonical',
3509 'href' => $canonicalUrl
3517 * @return string HTML tag links to be put in the header.
3518 * @deprecated since 1.24 Use OutputPage::headElement or if you have to,
3519 * OutputPage::getHeadLinksArray directly.
3521 public function getHeadLinks() {
3522 wfDeprecated( __METHOD__
, '1.24' );
3523 return implode( "\n", $this->getHeadLinksArray() );
3527 * Generate a "<link rel/>" for a feed.
3529 * @param string $type Feed type
3530 * @param string $url URL to the feed
3531 * @param string $text Value of the "title" attribute
3532 * @return string HTML fragment
3534 private function feedLink( $type, $url, $text ) {
3535 return Html
::element( 'link', array(
3536 'rel' => 'alternate',
3537 'type' => "application/$type+xml",
3544 * Add a local or specified stylesheet, with the given media options.
3545 * Meant primarily for internal use...
3547 * @param string $style URL to the file
3548 * @param string $media To specify a media type, 'screen', 'printable', 'handheld' or any.
3549 * @param string $condition For IE conditional comments, specifying an IE version
3550 * @param string $dir Set to 'rtl' or 'ltr' for direction-specific sheets
3552 public function addStyle( $style, $media = '', $condition = '', $dir = '' ) {
3554 // Even though we expect the media type to be lowercase, but here we
3555 // force it to lowercase to be safe.
3557 $options['media'] = $media;
3560 $options['condition'] = $condition;
3563 $options['dir'] = $dir;
3565 $this->styles
[$style] = $options;
3569 * Adds inline CSS styles
3570 * @param mixed $style_css Inline CSS
3571 * @param string $flip Set to 'flip' to flip the CSS if needed
3573 public function addInlineStyle( $style_css, $flip = 'noflip' ) {
3574 if ( $flip === 'flip' && $this->getLanguage()->isRTL() ) {
3575 # If wanted, and the interface is right-to-left, flip the CSS
3576 $style_css = CSSJanus
::transform( $style_css, true, false );
3578 $this->mInlineStyles
.= Html
::inlineStyle( $style_css ) . "\n";
3582 * Build a set of "<link>" elements for the stylesheets specified in the $this->styles array.
3583 * These will be applied to various media & IE conditionals.
3587 public function buildCssLinks() {
3590 $this->getSkin()->setupSkinUserCss( $this );
3592 // Add ResourceLoader styles
3593 // Split the styles into these groups
3598 'private' => array(),
3599 'noscript' => array()
3602 $otherTags = ''; // Tags to append after the normal <link> tags
3603 $resourceLoader = $this->getResourceLoader();
3605 $moduleStyles = $this->getModuleStyles();
3607 // Per-site custom styles
3608 $moduleStyles[] = 'site';
3609 $moduleStyles[] = 'noscript';
3610 $moduleStyles[] = 'user.groups';
3612 // Per-user custom styles
3613 if ( $this->getConfig()->get( 'AllowUserCss' ) && $this->getTitle()->isCssSubpage()
3614 && $this->userCanPreview()
3616 // We're on a preview of a CSS subpage
3617 // Exclude this page from the user module in case it's in there (bug 26283)
3618 $link = $this->makeResourceLoaderLink( 'user', ResourceLoaderModule
::TYPE_STYLES
, false,
3619 array( 'excludepage' => $this->getTitle()->getPrefixedDBkey() )
3621 $otherTags .= $link['html'];
3623 // Load the previewed CSS
3624 // If needed, Janus it first. This is user-supplied CSS, so it's
3625 // assumed to be right for the content language directionality.
3626 $previewedCSS = $this->getRequest()->getText( 'wpTextbox1' );
3627 if ( $this->getLanguage()->getDir() !== $wgContLang->getDir() ) {
3628 $previewedCSS = CSSJanus
::transform( $previewedCSS, true, false );
3630 $otherTags .= Html
::inlineStyle( $previewedCSS ) . "\n";
3632 // Load the user styles normally
3633 $moduleStyles[] = 'user';
3636 // Per-user preference styles
3637 $moduleStyles[] = 'user.cssprefs';
3639 foreach ( $moduleStyles as $name ) {
3640 $module = $resourceLoader->getModule( $name );
3644 $group = $module->getGroup();
3645 // Modules in groups different than the ones listed on top (see $styles assignment)
3646 // will be placed in the "other" group
3647 $styles[isset( $styles[$group] ) ?
$group : 'other'][] = $name;
3650 // We want site, private and user styles to override dynamically added
3651 // styles from modules, but we want dynamically added styles to override
3652 // statically added styles from other modules. So the order has to be
3653 // other, dynamic, site, private, user. Add statically added styles for
3655 $links[] = $this->makeResourceLoaderLink( $styles['other'], ResourceLoaderModule
::TYPE_STYLES
);
3656 // Add normal styles added through addStyle()/addInlineStyle() here
3657 $links[] = implode( "\n", $this->buildCssLinksArray() ) . $this->mInlineStyles
;
3658 // Add marker tag to mark the place where the client-side loader should inject dynamic styles
3659 // We use a <meta> tag with a made-up name for this because that's valid HTML
3660 $links[] = Html
::element(
3662 array( 'name' => 'ResourceLoaderDynamicStyles', 'content' => '' )
3665 // Add site, private and user styles
3666 // 'private' at present only contains user.options, so put that before 'user'
3667 // Any future private modules will likely have a similar user-specific character
3668 foreach ( array( 'site', 'noscript', 'private', 'user' ) as $group ) {
3669 $links[] = $this->makeResourceLoaderLink( $styles[$group],
3670 ResourceLoaderModule
::TYPE_STYLES
3674 // Add stuff in $otherTags (previewed user CSS if applicable)
3675 return self
::getHtmlFromLoaderLinks( $links ) . $otherTags;
3681 public function buildCssLinksArray() {
3684 // Add any extension CSS
3685 foreach ( $this->mExtStyles
as $url ) {
3686 $this->addStyle( $url );
3688 $this->mExtStyles
= array();
3690 foreach ( $this->styles
as $file => $options ) {
3691 $link = $this->styleLink( $file, $options );
3693 $links[$file] = $link;
3700 * Generate \<link\> tags for stylesheets
3702 * @param string $style URL to the file
3703 * @param array $options Option, can contain 'condition', 'dir', 'media' keys
3704 * @return string HTML fragment
3706 protected function styleLink( $style, array $options ) {
3707 if ( isset( $options['dir'] ) ) {
3708 if ( $this->getLanguage()->getDir() != $options['dir'] ) {
3713 if ( isset( $options['media'] ) ) {
3714 $media = self
::transformCssMedia( $options['media'] );
3715 if ( is_null( $media ) ) {
3722 if ( substr( $style, 0, 1 ) == '/' ||
3723 substr( $style, 0, 5 ) == 'http:' ||
3724 substr( $style, 0, 6 ) == 'https:' ) {
3727 $config = $this->getConfig();
3728 $url = $config->get( 'StylePath' ) . '/' . $style . '?' . $config->get( 'StyleVersion' );
3731 $link = Html
::linkedStyle( $url, $media );
3733 if ( isset( $options['condition'] ) ) {
3734 $condition = htmlspecialchars( $options['condition'] );
3735 $link = "<!--[if $condition]>$link<![endif]-->";
3741 * Transform "media" attribute based on request parameters
3743 * @param string $media Current value of the "media" attribute
3744 * @return string Modified value of the "media" attribute, or null to skip
3747 public static function transformCssMedia( $media ) {
3750 // http://www.w3.org/TR/css3-mediaqueries/#syntax
3751 $screenMediaQueryRegex = '/^(?:only\s+)?screen\b/i';
3753 // Switch in on-screen display for media testing
3755 'printable' => 'print',
3756 'handheld' => 'handheld',
3758 foreach ( $switches as $switch => $targetMedia ) {
3759 if ( $wgRequest->getBool( $switch ) ) {
3760 if ( $media == $targetMedia ) {
3762 } elseif ( preg_match( $screenMediaQueryRegex, $media ) === 1 ) {
3763 // This regex will not attempt to understand a comma-separated media_query_list
3765 // Example supported values for $media:
3766 // 'screen', 'only screen', 'screen and (min-width: 982px)' ),
3767 // Example NOT supported value for $media:
3768 // '3d-glasses, screen, print and resolution > 90dpi'
3770 // If it's a print request, we never want any kind of screen stylesheets
3771 // If it's a handheld request (currently the only other choice with a switch),
3772 // we don't want simple 'screen' but we might want screen queries that
3773 // have a max-width or something, so we'll pass all others on and let the
3774 // client do the query.
3775 if ( $targetMedia == 'print' ||
$media == 'screen' ) {
3786 * Add a wikitext-formatted message to the output.
3787 * This is equivalent to:
3789 * $wgOut->addWikiText( wfMessage( ... )->plain() )
3791 public function addWikiMsg( /*...*/ ) {
3792 $args = func_get_args();
3793 $name = array_shift( $args );
3794 $this->addWikiMsgArray( $name, $args );
3798 * Add a wikitext-formatted message to the output.
3799 * Like addWikiMsg() except the parameters are taken as an array
3800 * instead of a variable argument list.
3802 * @param string $name
3803 * @param array $args
3805 public function addWikiMsgArray( $name, $args ) {
3806 $this->addHTML( $this->msg( $name, $args )->parseAsBlock() );
3810 * This function takes a number of message/argument specifications, wraps them in
3811 * some overall structure, and then parses the result and adds it to the output.
3813 * In the $wrap, $1 is replaced with the first message, $2 with the second,
3814 * and so on. The subsequent arguments may be either
3815 * 1) strings, in which case they are message names, or
3816 * 2) arrays, in which case, within each array, the first element is the message
3817 * name, and subsequent elements are the parameters to that message.
3819 * Don't use this for messages that are not in the user's interface language.
3823 * $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>", 'some-error' );
3827 * $wgOut->addWikiText( "<div class='error'>\n"
3828 * . wfMessage( 'some-error' )->plain() . "\n</div>" );
3830 * The newline after the opening div is needed in some wikitext. See bug 19226.
3832 * @param string $wrap
3834 public function wrapWikiMsg( $wrap /*, ...*/ ) {
3835 $msgSpecs = func_get_args();
3836 array_shift( $msgSpecs );
3837 $msgSpecs = array_values( $msgSpecs );
3839 foreach ( $msgSpecs as $n => $spec ) {
3840 if ( is_array( $spec ) ) {
3842 $name = array_shift( $args );
3843 if ( isset( $args['options'] ) ) {
3844 unset( $args['options'] );
3846 'Adding "options" to ' . __METHOD__
. ' is no longer supported',
3854 $s = str_replace( '$' . ( $n +
1 ), $this->msg( $name, $args )->plain(), $s );
3856 $this->addWikiText( $s );
3860 * Include jQuery core. Use this to avoid loading it multiple times
3861 * before we get a usable script loader.
3863 * @param array $modules List of jQuery modules which should be loaded
3864 * @return array The list of modules which were not loaded.
3866 * @deprecated since 1.17
3868 public function includeJQuery( array $modules = array() ) {
3873 * Enables/disables TOC, doesn't override __NOTOC__
3877 public function enableTOC( $flag = true ) {
3878 $this->mEnableTOC
= $flag;
3885 public function isTOCEnabled() {
3886 return $this->mEnableTOC
;
3890 * Enables/disables section edit links, doesn't override __NOEDITSECTION__
3894 public function enableSectionEditLinks( $flag = true ) {
3895 $this->mEnableSectionEditLinks
= $flag;
3902 public function sectionEditLinksEnabled() {
3903 return $this->mEnableSectionEditLinks
;
3907 * Add ResourceLoader module styles for OOUI and set up the PHP implementation of it for use with
3908 * MediaWiki and this OutputPage instance.
3912 public function enableOOUI() {
3913 OOUI\Theme
::setSingleton( new OOUI\
MediaWikiTheme() );
3914 OOUI\Element
::setDefaultDir( $this->getLanguage()->getDir() );
3915 $this->addModuleStyles( array(
3917 'oojs-ui.styles.icons',
3918 'oojs-ui.styles.indicators',
3919 'oojs-ui.styles.textures',