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 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();
125 /** @var array Array of Interwiki Prefixed (non DB key) Titles (e.g. 'fr:Test page') */
126 private $mLanguageLinks = array();
129 * Used for JavaScript (pre resource loader)
130 * @todo We should split JS / CSS.
131 * mScripts content is inserted as is in "<head>" by Skin. This might
132 * contain either a link to a stylesheet or inline CSS.
134 private $mScripts = '';
136 /** @var string Inline CSS styles. Use addInlineStyle() sparingly */
137 protected $mInlineStyles = '';
140 private $mLinkColours;
143 * @var string Used by skin template.
144 * Example: $tpl->set( 'displaytitle', $out->mPageLinkTitle );
146 public $mPageLinkTitle = '';
148 /** @var array Array of elements in "<head>". Parser might add its own headers! */
149 protected $mHeadItems = array();
151 // @todo FIXME: Next 5 variables probably come from the resource loader
154 protected $mModules = array();
157 protected $mModuleScripts = array();
160 protected $mModuleStyles = array();
163 protected $mModuleMessages = array();
165 /** @var ResourceLoader */
166 protected $mResourceLoader;
169 protected $mJsConfigVars = array();
172 protected $mTemplateIds = array();
175 protected $mImageTimeKeys = array();
178 public $mRedirectCode = '';
180 protected $mFeedLinksAppendQuery = null;
183 * What level of 'untrustworthiness' is allowed in CSS/JS modules loaded on this page?
184 * @see ResourceLoaderModule::$origin
185 * ResourceLoaderModule::ORIGIN_ALL is assumed unless overridden;
187 protected $mAllowedModules = array(
188 ResourceLoaderModule
::TYPE_COMBINED
=> ResourceLoaderModule
::ORIGIN_ALL
,
191 /** @var bool Whether output is disabled. If this is true, the 'output' method will do nothing. */
192 protected $mDoNothing = false;
200 private $mContainsOldMagic = 0;
203 protected $mContainsNewMagic = 0;
206 * lazy initialised, use parserOptions()
209 protected $mParserOptions = null;
212 * Handles the Atom / RSS links.
213 * We probably only support Atom in 2011.
214 * @see $wgAdvertisedFeedTypes
216 private $mFeedLinks = array();
218 // Gwicke work on squid caching? Roughly from 2003.
219 protected $mEnableClientCache = true;
221 /** @var bool Flag if output should only contain the body of the article. */
222 private $mArticleBodyOnly = false;
225 protected $mNewSectionLink = false;
228 protected $mHideNewSectionLink = false;
231 * @var bool Comes from the parser. This was probably made to load CSS/JS
232 * only if we had "<gallery>". Used directly in CategoryPage.php.
233 * Looks like resource loader can replace this.
235 public $mNoGallery = false;
238 private $mPageTitleActionText = '';
241 private $mParseWarnings = array();
243 /** @var int Cache stuff. Looks like mEnableClientCache */
244 protected $mSquidMaxage = 0;
250 protected $mPreventClickjacking = true;
252 /** @var int To include the variable {{REVISIONID}} */
253 private $mRevisionId = null;
256 private $mRevisionTimestamp = null;
259 protected $mFileVersion = null;
262 * @var array An array of stylesheet filenames (relative from skins path),
263 * with options for CSS media, IE conditions, and RTL/LTR direction.
264 * For internal use; add settings in the skin via $this->addStyle()
266 * Style again! This seems like a code duplication since we already have
267 * mStyles. This is what makes Open Source amazing.
269 protected $styles = array();
272 * Whether jQuery is already handled.
274 protected $mJQueryDone = false;
276 private $mIndexPolicy = 'index';
277 private $mFollowPolicy = 'follow';
278 private $mVaryHeader = array(
279 'Accept-Encoding' => array( 'list-contains=gzip' ),
283 * If the current page was reached through a redirect, $mRedirectedFrom contains the Title
288 private $mRedirectedFrom = null;
291 * Additional key => value data
293 private $mProperties = array();
296 * @var string|null ResourceLoader target for load.php links. If null, will be omitted
298 private $mTarget = null;
301 * @var bool Whether parser output should contain table of contents
303 private $mEnableTOC = true;
306 * @var bool Whether parser output should contain section edit links
308 private $mEnableSectionEditLinks = true;
311 * Constructor for OutputPage. This should not be called directly.
312 * Instead a new RequestContext should be created and it will implicitly create
313 * a OutputPage tied to that context.
315 function __construct( IContextSource
$context = null ) {
316 if ( $context === null ) {
317 # Extensions should use `new RequestContext` instead of `new OutputPage` now.
318 wfDeprecated( __METHOD__
, '1.18' );
320 $this->setContext( $context );
325 * Redirect to $url rather than displaying the normal page
327 * @param string $url URL
328 * @param string $responsecode HTTP status code
330 public function redirect( $url, $responsecode = '302' ) {
331 # Strip newlines as a paranoia check for header injection in PHP<5.1.2
332 $this->mRedirect
= str_replace( "\n", '', $url );
333 $this->mRedirectCode
= $responsecode;
337 * Get the URL to redirect to, or an empty string if not redirect URL set
341 public function getRedirect() {
342 return $this->mRedirect
;
346 * Set the HTTP status code to send with the output.
348 * @param int $statusCode
350 public function setStatusCode( $statusCode ) {
351 $this->mStatusCode
= $statusCode;
355 * Add a new "<meta>" tag
356 * To add an http-equiv meta tag, precede the name with "http:"
358 * @param string $name tag name
359 * @param string $val tag value
361 function addMeta( $name, $val ) {
362 array_push( $this->mMetatags
, array( $name, $val ) );
366 * Add a new \<link\> tag to the page header.
368 * Note: use setCanonicalUrl() for rel=canonical.
370 * @param array $linkarr associative array of attributes.
372 function addLink( $linkarr ) {
373 array_push( $this->mLinktags
, $linkarr );
377 * Add a new \<link\> with "rel" attribute set to "meta"
379 * @param array $linkarr associative array mapping attribute names to their
380 * values, both keys and values will be escaped, and the
381 * "rel" attribute will be automatically added
383 function addMetadataLink( $linkarr ) {
384 $linkarr['rel'] = $this->getMetadataAttribute();
385 $this->addLink( $linkarr );
389 * Set the URL to be used for the <link rel=canonical>. This should be used
390 * in preference to addLink(), to avoid duplicate link tags.
392 function setCanonicalUrl( $url ) {
393 $this->mCanonicalUrl
= $url;
397 * Get the value of the "rel" attribute for metadata links
401 public function getMetadataAttribute() {
402 # note: buggy CC software only reads first "meta" link
403 static $haveMeta = false;
405 return 'alternate meta';
413 * Add raw HTML to the list of scripts (including \<script\> tag, etc.)
415 * @param string $script raw HTML
417 function addScript( $script ) {
418 $this->mScripts
.= $script . "\n";
422 * Register and add a stylesheet from an extension directory.
424 * @param string $url path to sheet. Provide either a full url (beginning
425 * with 'http', etc) or a relative path from the document root
426 * (beginning with '/'). Otherwise it behaves identically to
427 * addStyle() and draws from the /skins folder.
429 public function addExtensionStyle( $url ) {
430 array_push( $this->mExtStyles
, $url );
434 * Get all styles added by extensions
438 function getExtStyle() {
439 return $this->mExtStyles
;
443 * Add a JavaScript file out of skins/common, or a given relative path.
445 * @param string $file filename in skins/common or complete on-server path
447 * @param string $version style version of the file. Defaults to $wgStyleVersion
449 public function addScriptFile( $file, $version = null ) {
450 global $wgStylePath, $wgStyleVersion;
451 // See if $file parameter is an absolute URL or begins with a slash
452 if ( substr( $file, 0, 1 ) == '/' ||
preg_match( '#^[a-z]*://#i', $file ) ) {
455 $path = "{$wgStylePath}/common/{$file}";
457 if ( is_null( $version ) ) {
458 $version = $wgStyleVersion;
460 $this->addScript( Html
::linkedScript( wfAppendQuery( $path, $version ) ) );
464 * Add a self-contained script tag with the given contents
466 * @param string $script JavaScript text, no "<script>" tags
468 public function addInlineScript( $script ) {
469 $this->mScripts
.= Html
::inlineScript( "\n$script\n" ) . "\n";
473 * Get all registered JS and CSS tags for the header.
476 * @deprecated since 1.24 Use OutputPage::headElement to build the full header.
478 function getScript() {
479 wfDeprecated( __METHOD__
, '1.24' );
480 return $this->mScripts
. $this->getHeadItems();
484 * Filter an array of modules to remove insufficiently trustworthy members, and modules
485 * which are no longer registered (eg a page is cached before an extension is disabled)
486 * @param array $modules
487 * @param string|null $position if not null, only return modules with this position
488 * @param string $type
491 protected function filterModules( $modules, $position = null,
492 $type = ResourceLoaderModule
::TYPE_COMBINED
494 $resourceLoader = $this->getResourceLoader();
495 $filteredModules = array();
496 foreach ( $modules as $val ) {
497 $module = $resourceLoader->getModule( $val );
498 if ( $module instanceof ResourceLoaderModule
499 && $module->getOrigin() <= $this->getAllowedModules( $type )
500 && ( is_null( $position ) ||
$module->getPosition() == $position )
501 && ( !$this->mTarget ||
in_array( $this->mTarget
, $module->getTargets() ) )
503 $filteredModules[] = $val;
506 return $filteredModules;
510 * Get the list of modules to include on this page
512 * @param bool $filter Whether to filter out insufficiently trustworthy modules
513 * @param string|null $position If not null, only return modules with this position
514 * @param string $param
515 * @return array Array of module names
517 public function getModules( $filter = false, $position = null, $param = 'mModules' ) {
518 $modules = array_values( array_unique( $this->$param ) );
520 ?
$this->filterModules( $modules, $position )
525 * Add one or more modules recognized by the resource loader. Modules added
526 * through this function will be loaded by the resource loader when the
529 * @param string|array $modules Module name (string) or array of module names
531 public function addModules( $modules ) {
532 $this->mModules
= array_merge( $this->mModules
, (array)$modules );
536 * Get the list of module JS to include on this page
538 * @param bool $filter
539 * @param string|null $position
541 * @return array Array of module names
543 public function getModuleScripts( $filter = false, $position = null ) {
544 return $this->getModules( $filter, $position, 'mModuleScripts' );
548 * Add only JS of one or more modules recognized by the resource loader. Module
549 * scripts added through this function will be loaded by the resource loader when
552 * @param string|array $modules Module name (string) or array of module names
554 public function addModuleScripts( $modules ) {
555 $this->mModuleScripts
= array_merge( $this->mModuleScripts
, (array)$modules );
559 * Get the list of module CSS to include on this page
561 * @param bool $filter
562 * @param string|null $position
564 * @return array Array of module names
566 public function getModuleStyles( $filter = false, $position = null ) {
567 return $this->getModules( $filter, $position, 'mModuleStyles' );
571 * Add only CSS of one or more modules recognized by the resource loader.
573 * Module styles added through this function will be added using standard link CSS
574 * tags, rather than as a combined Javascript and CSS package. Thus, they will
575 * load when JavaScript is disabled (unless CSS also happens to be disabled).
577 * @param string|array $modules Module name (string) or array of module names
579 public function addModuleStyles( $modules ) {
580 $this->mModuleStyles
= array_merge( $this->mModuleStyles
, (array)$modules );
584 * Get the list of module messages to include on this page
586 * @param bool $filter
587 * @param string|null $position
589 * @return array Array of module names
591 public function getModuleMessages( $filter = false, $position = null ) {
592 return $this->getModules( $filter, $position, 'mModuleMessages' );
596 * Add only messages of one or more modules recognized by the resource loader.
597 * Module messages added through this function will be loaded by the resource
598 * loader when the page loads.
600 * @param string|array $modules Module name (string) or array of module names
602 public function addModuleMessages( $modules ) {
603 $this->mModuleMessages
= array_merge( $this->mModuleMessages
, (array)$modules );
607 * @return null|string ResourceLoader target
609 public function getTarget() {
610 return $this->mTarget
;
614 * Sets ResourceLoader target for load.php links. If null, will be omitted
616 * @param string|null $target
618 public function setTarget( $target ) {
619 $this->mTarget
= $target;
623 * Get an array of head items
627 function getHeadItemsArray() {
628 return $this->mHeadItems
;
632 * Get all header items in a string
635 * @deprecated since 1.24 Use OutputPage::headElement or
636 * if absolutely necessary use OutputPage::getHeadItemsArray
638 function getHeadItems() {
639 wfDeprecated( __METHOD__
, '1.24' );
641 foreach ( $this->mHeadItems
as $item ) {
648 * Add or replace an header item to the output
650 * @param string $name item name
651 * @param string $value raw HTML
653 public function addHeadItem( $name, $value ) {
654 $this->mHeadItems
[$name] = $value;
658 * Check if the header item $name is already set
660 * @param string $name Item name
663 public function hasHeadItem( $name ) {
664 return isset( $this->mHeadItems
[$name] );
668 * Set the value of the ETag HTTP header, only used if $wgUseETag is true
670 * @param string $tag value of "ETag" header
672 function setETag( $tag ) {
677 * Set whether the output should only contain the body of the article,
678 * without any skin, sidebar, etc.
679 * Used e.g. when calling with "action=render".
681 * @param bool $only Whether to output only the body of the article
683 public function setArticleBodyOnly( $only ) {
684 $this->mArticleBodyOnly
= $only;
688 * Return whether the output will contain only the body of the article
692 public function getArticleBodyOnly() {
693 return $this->mArticleBodyOnly
;
697 * Set an additional output property
700 * @param string $name
701 * @param mixed $value
703 public function setProperty( $name, $value ) {
704 $this->mProperties
[$name] = $value;
708 * Get an additional output property
711 * @param string $name
712 * @return mixed Property value or null if not found
714 public function getProperty( $name ) {
715 if ( isset( $this->mProperties
[$name] ) ) {
716 return $this->mProperties
[$name];
723 * checkLastModified tells the client to use the client-cached page if
724 * possible. If successful, the OutputPage is disabled so that
725 * any future call to OutputPage->output() have no effect.
727 * Side effect: sets mLastModified for Last-Modified header
729 * @param string $timestamp
731 * @return bool True if cache-ok headers was sent.
733 public function checkLastModified( $timestamp ) {
734 global $wgCachePages, $wgCacheEpoch, $wgUseSquid, $wgSquidMaxage;
736 if ( !$timestamp ||
$timestamp == '19700101000000' ) {
737 wfDebug( __METHOD__
. ": CACHE DISABLED, NO TIMESTAMP\n" );
740 if ( !$wgCachePages ) {
741 wfDebug( __METHOD__
. ": CACHE DISABLED\n" );
745 $timestamp = wfTimestamp( TS_MW
, $timestamp );
746 $modifiedTimes = array(
747 'page' => $timestamp,
748 'user' => $this->getUser()->getTouched(),
749 'epoch' => $wgCacheEpoch
752 // bug 44570: the core page itself may not change, but resources might
753 $modifiedTimes['sepoch'] = wfTimestamp( TS_MW
, time() - $wgSquidMaxage );
755 wfRunHooks( 'OutputPageCheckLastModified', array( &$modifiedTimes ) );
757 $maxModified = max( $modifiedTimes );
758 $this->mLastModified
= wfTimestamp( TS_RFC2822
, $maxModified );
760 $clientHeader = $this->getRequest()->getHeader( 'If-Modified-Since' );
761 if ( $clientHeader === false ) {
762 wfDebug( __METHOD__
. ": client did not send If-Modified-Since header\n", 'log' );
766 # IE sends sizes after the date like this:
767 # Wed, 20 Aug 2003 06:51:19 GMT; length=5202
768 # this breaks strtotime().
769 $clientHeader = preg_replace( '/;.*$/', '', $clientHeader );
771 wfSuppressWarnings(); // E_STRICT system time bitching
772 $clientHeaderTime = strtotime( $clientHeader );
774 if ( !$clientHeaderTime ) {
776 . ": unable to parse the client's If-Modified-Since header: $clientHeader\n" );
779 $clientHeaderTime = wfTimestamp( TS_MW
, $clientHeaderTime );
783 foreach ( $modifiedTimes as $name => $value ) {
784 if ( $info !== '' ) {
787 $info .= "$name=" . wfTimestamp( TS_ISO_8601
, $value );
790 wfDebug( __METHOD__
. ": client sent If-Modified-Since: " .
791 wfTimestamp( TS_ISO_8601
, $clientHeaderTime ) . "\n", 'log' );
792 wfDebug( __METHOD__
. ": effective Last-Modified: " .
793 wfTimestamp( TS_ISO_8601
, $maxModified ) . "\n", 'log' );
794 if ( $clientHeaderTime < $maxModified ) {
795 wfDebug( __METHOD__
. ": STALE, $info\n", 'log' );
800 # Give a 304 response code and disable body output
801 wfDebug( __METHOD__
. ": NOT MODIFIED, $info\n", 'log' );
802 ini_set( 'zlib.output_compression', 0 );
803 $this->getRequest()->response()->header( "HTTP/1.1 304 Not Modified" );
804 $this->sendCacheControl();
807 // Don't output a compressed blob when using ob_gzhandler;
808 // it's technically against HTTP spec and seems to confuse
809 // Firefox when the response gets split over two packets.
810 wfClearOutputBuffers();
816 * Override the last modified timestamp
818 * @param string $timestamp new timestamp, in a format readable by
821 public function setLastModified( $timestamp ) {
822 $this->mLastModified
= wfTimestamp( TS_RFC2822
, $timestamp );
826 * Set the robot policy for the page: <http://www.robotstxt.org/meta.html>
828 * @param string $policy the literal string to output as the contents of
829 * the meta tag. Will be parsed according to the spec and output in
833 public function setRobotPolicy( $policy ) {
834 $policy = Article
::formatRobotPolicy( $policy );
836 if ( isset( $policy['index'] ) ) {
837 $this->setIndexPolicy( $policy['index'] );
839 if ( isset( $policy['follow'] ) ) {
840 $this->setFollowPolicy( $policy['follow'] );
845 * Set the index policy for the page, but leave the follow policy un-
848 * @param string $policy Either 'index' or 'noindex'.
851 public function setIndexPolicy( $policy ) {
852 $policy = trim( $policy );
853 if ( in_array( $policy, array( 'index', 'noindex' ) ) ) {
854 $this->mIndexPolicy
= $policy;
859 * Set the follow policy for the page, but leave the index policy un-
862 * @param string $policy either 'follow' or 'nofollow'.
865 public function setFollowPolicy( $policy ) {
866 $policy = trim( $policy );
867 if ( in_array( $policy, array( 'follow', 'nofollow' ) ) ) {
868 $this->mFollowPolicy
= $policy;
873 * Set the new value of the "action text", this will be added to the
874 * "HTML title", separated from it with " - ".
876 * @param string $text new value of the "action text"
878 public function setPageTitleActionText( $text ) {
879 $this->mPageTitleActionText
= $text;
883 * Get the value of the "action text"
887 public function getPageTitleActionText() {
888 return $this->mPageTitleActionText
;
892 * "HTML title" means the contents of "<title>".
893 * It is stored as plain, unescaped text and will be run through htmlspecialchars in the skin file.
895 * @param string $name
897 public function setHTMLTitle( $name ) {
898 if ( $name instanceof Message
) {
899 $this->mHTMLtitle
= $name->setContext( $this->getContext() )->text();
901 $this->mHTMLtitle
= $name;
906 * Return the "HTML title", i.e. the content of the "<title>" tag.
910 public function getHTMLTitle() {
911 return $this->mHTMLtitle
;
915 * Set $mRedirectedFrom, the Title of the page which redirected us to the current page.
919 public function setRedirectedFrom( $t ) {
920 $this->mRedirectedFrom
= $t;
924 * "Page title" means the contents of \<h1\>. It is stored as a valid HTML
925 * fragment. This function allows good tags like \<sup\> in the \<h1\> tag,
926 * but not bad tags like \<script\>. This function automatically sets
927 * \<title\> to the same content as \<h1\> but with all tags removed. Bad
928 * tags that were escaped in \<h1\> will still be escaped in \<title\>, and
929 * good tags like \<i\> will be dropped entirely.
931 * @param string|Message $name
933 public function setPageTitle( $name ) {
934 if ( $name instanceof Message
) {
935 $name = $name->setContext( $this->getContext() )->text();
938 # change "<script>foo&bar</script>" to "<script>foo&bar</script>"
939 # but leave "<i>foobar</i>" alone
940 $nameWithTags = Sanitizer
::normalizeCharReferences( Sanitizer
::removeHTMLtags( $name ) );
941 $this->mPagetitle
= $nameWithTags;
943 # change "<i>foo&bar</i>" to "foo&bar"
945 $this->msg( 'pagetitle' )->rawParams( Sanitizer
::stripAllTags( $nameWithTags ) )
946 ->inContentLanguage()
951 * Return the "page title", i.e. the content of the \<h1\> tag.
955 public function getPageTitle() {
956 return $this->mPagetitle
;
960 * Set the Title object to use
964 public function setTitle( Title
$t ) {
965 $this->getContext()->setTitle( $t );
969 * Replace the subtitle with $str
971 * @param string|Message $str new value of the subtitle. String should be safe HTML.
973 public function setSubtitle( $str ) {
974 $this->clearSubtitle();
975 $this->addSubtitle( $str );
979 * Add $str to the subtitle
981 * @deprecated since 1.19; use addSubtitle() instead
982 * @param string|Message $str to add to the subtitle
984 public function appendSubtitle( $str ) {
985 $this->addSubtitle( $str );
989 * Add $str to the subtitle
991 * @param string|Message $str to add to the subtitle. String should be safe HTML.
993 public function addSubtitle( $str ) {
994 if ( $str instanceof Message
) {
995 $this->mSubtitle
[] = $str->setContext( $this->getContext() )->parse();
997 $this->mSubtitle
[] = $str;
1002 * Add a subtitle containing a backlink to a page
1004 * @param Title $title Title to link to
1006 public function addBacklinkSubtitle( Title
$title ) {
1008 if ( $title->isRedirect() ) {
1009 $query['redirect'] = 'no';
1011 $this->addSubtitle( $this->msg( 'backlinksubtitle' )
1012 ->rawParams( Linker
::link( $title, null, array(), $query ) ) );
1016 * Clear the subtitles
1018 public function clearSubtitle() {
1019 $this->mSubtitle
= array();
1027 public function getSubtitle() {
1028 return implode( "<br />\n\t\t\t\t", $this->mSubtitle
);
1032 * Set the page as printable, i.e. it'll be displayed with with all
1033 * print styles included
1035 public function setPrintable() {
1036 $this->mPrintable
= true;
1040 * Return whether the page is "printable"
1044 public function isPrintable() {
1045 return $this->mPrintable
;
1049 * Disable output completely, i.e. calling output() will have no effect
1051 public function disable() {
1052 $this->mDoNothing
= true;
1056 * Return whether the output will be completely disabled
1060 public function isDisabled() {
1061 return $this->mDoNothing
;
1065 * Show an "add new section" link?
1069 public function showNewSectionLink() {
1070 return $this->mNewSectionLink
;
1074 * Forcibly hide the new section link?
1078 public function forceHideNewSectionLink() {
1079 return $this->mHideNewSectionLink
;
1083 * Add or remove feed links in the page header
1084 * This is mainly kept for backward compatibility, see OutputPage::addFeedLink()
1085 * for the new version
1086 * @see addFeedLink()
1088 * @param bool $show true: add default feeds, false: remove all feeds
1090 public function setSyndicated( $show = true ) {
1092 $this->setFeedAppendQuery( false );
1094 $this->mFeedLinks
= array();
1099 * Add default feeds to the page header
1100 * This is mainly kept for backward compatibility, see OutputPage::addFeedLink()
1101 * for the new version
1102 * @see addFeedLink()
1104 * @param string $val query to append to feed links or false to output
1107 public function setFeedAppendQuery( $val ) {
1108 global $wgAdvertisedFeedTypes;
1110 $this->mFeedLinks
= array();
1112 foreach ( $wgAdvertisedFeedTypes as $type ) {
1113 $query = "feed=$type";
1114 if ( is_string( $val ) ) {
1115 $query .= '&' . $val;
1117 $this->mFeedLinks
[$type] = $this->getTitle()->getLocalURL( $query );
1122 * Add a feed link to the page header
1124 * @param string $format feed type, should be a key of $wgFeedClasses
1125 * @param string $href URL
1127 public function addFeedLink( $format, $href ) {
1128 global $wgAdvertisedFeedTypes;
1130 if ( in_array( $format, $wgAdvertisedFeedTypes ) ) {
1131 $this->mFeedLinks
[$format] = $href;
1136 * Should we output feed links for this page?
1139 public function isSyndicated() {
1140 return count( $this->mFeedLinks
) > 0;
1144 * Return URLs for each supported syndication format for this page.
1145 * @return array associating format keys with URLs
1147 public function getSyndicationLinks() {
1148 return $this->mFeedLinks
;
1152 * Will currently always return null
1156 public function getFeedAppendQuery() {
1157 return $this->mFeedLinksAppendQuery
;
1161 * Set whether the displayed content is related to the source of the
1162 * corresponding article on the wiki
1163 * Setting true will cause the change "article related" toggle to true
1167 public function setArticleFlag( $v ) {
1168 $this->mIsarticle
= $v;
1170 $this->mIsArticleRelated
= $v;
1175 * Return whether the content displayed page is related to the source of
1176 * the corresponding article on the wiki
1180 public function isArticle() {
1181 return $this->mIsarticle
;
1185 * Set whether this page is related an article on the wiki
1186 * Setting false will cause the change of "article flag" toggle to false
1190 public function setArticleRelated( $v ) {
1191 $this->mIsArticleRelated
= $v;
1193 $this->mIsarticle
= false;
1198 * Return whether this page is related an article on the wiki
1202 public function isArticleRelated() {
1203 return $this->mIsArticleRelated
;
1207 * Add new language links
1209 * @param array $newLinkArray Associative array mapping language code to the page
1212 public function addLanguageLinks( $newLinkArray ) {
1213 $this->mLanguageLinks +
= $newLinkArray;
1217 * Reset the language links and add new language links
1219 * @param array $newLinkArray Associative array mapping language code to the page
1222 public function setLanguageLinks( $newLinkArray ) {
1223 $this->mLanguageLinks
= $newLinkArray;
1227 * Get the list of language links
1229 * @return array Array of Interwiki Prefixed (non DB key) Titles (e.g. 'fr:Test page')
1231 public function getLanguageLinks() {
1232 return $this->mLanguageLinks
;
1236 * Add an array of categories, with names in the keys
1238 * @param array $categories mapping category name => sort key
1240 public function addCategoryLinks( $categories ) {
1243 if ( !is_array( $categories ) ||
count( $categories ) == 0 ) {
1247 # Add the links to a LinkBatch
1248 $arr = array( NS_CATEGORY
=> $categories );
1249 $lb = new LinkBatch
;
1250 $lb->setArray( $arr );
1252 # Fetch existence plus the hiddencat property
1253 $dbr = wfGetDB( DB_SLAVE
);
1254 $res = $dbr->select( array( 'page', 'page_props' ),
1255 array( 'page_id', 'page_namespace', 'page_title', 'page_len',
1256 'page_is_redirect', 'page_latest', 'pp_value' ),
1257 $lb->constructSet( 'page', $dbr ),
1260 array( 'page_props' => array( 'LEFT JOIN', array(
1261 'pp_propname' => 'hiddencat',
1266 # Add the results to the link cache
1267 $lb->addResultToCache( LinkCache
::singleton(), $res );
1269 # Set all the values to 'normal'. This can be done with array_fill_keys in PHP 5.2.0+
1270 $categories = array_combine(
1271 array_keys( $categories ),
1272 array_fill( 0, count( $categories ), 'normal' )
1275 # Mark hidden categories
1276 foreach ( $res as $row ) {
1277 if ( isset( $row->pp_value
) ) {
1278 $categories[$row->page_title
] = 'hidden';
1282 # Add the remaining categories to the skin
1284 'OutputPageMakeCategoryLinks',
1285 array( &$this, $categories, &$this->mCategoryLinks
) )
1287 foreach ( $categories as $category => $type ) {
1288 $origcategory = $category;
1289 $title = Title
::makeTitleSafe( NS_CATEGORY
, $category );
1290 $wgContLang->findVariantLink( $category, $title, true );
1291 if ( $category != $origcategory ) {
1292 if ( array_key_exists( $category, $categories ) ) {
1296 $text = $wgContLang->convertHtml( $title->getText() );
1297 $this->mCategories
[] = $title->getText();
1298 $this->mCategoryLinks
[$type][] = Linker
::link( $title, $text );
1304 * Reset the category links (but not the category list) and add $categories
1306 * @param array $categories mapping category name => sort key
1308 public function setCategoryLinks( $categories ) {
1309 $this->mCategoryLinks
= array();
1310 $this->addCategoryLinks( $categories );
1314 * Get the list of category links, in a 2-D array with the following format:
1315 * $arr[$type][] = $link, where $type is either "normal" or "hidden" (for
1316 * hidden categories) and $link a HTML fragment with a link to the category
1321 public function getCategoryLinks() {
1322 return $this->mCategoryLinks
;
1326 * Get the list of category names this page belongs to
1328 * @return array Array of strings
1330 public function getCategories() {
1331 return $this->mCategories
;
1335 * Do not allow scripts which can be modified by wiki users to load on this page;
1336 * only allow scripts bundled with, or generated by, the software.
1338 public function disallowUserJs() {
1339 $this->reduceAllowedModules(
1340 ResourceLoaderModule
::TYPE_SCRIPTS
,
1341 ResourceLoaderModule
::ORIGIN_CORE_INDIVIDUAL
1346 * Return whether user JavaScript is allowed for this page
1347 * @deprecated since 1.18 Load modules with ResourceLoader, and origin and
1348 * trustworthiness is identified and enforced automagically.
1351 public function isUserJsAllowed() {
1352 wfDeprecated( __METHOD__
, '1.18' );
1353 return $this->getAllowedModules( ResourceLoaderModule
::TYPE_SCRIPTS
) >=
1354 ResourceLoaderModule
::ORIGIN_USER_INDIVIDUAL
;
1358 * Show what level of JavaScript / CSS untrustworthiness is allowed on this page
1359 * @see ResourceLoaderModule::$origin
1360 * @param string $type ResourceLoaderModule TYPE_ constant
1361 * @return int ResourceLoaderModule ORIGIN_ class constant
1363 public function getAllowedModules( $type ) {
1364 if ( $type == ResourceLoaderModule
::TYPE_COMBINED
) {
1365 return min( array_values( $this->mAllowedModules
) );
1367 return isset( $this->mAllowedModules
[$type] )
1368 ?
$this->mAllowedModules
[$type]
1369 : ResourceLoaderModule
::ORIGIN_ALL
;
1374 * Set the highest level of CSS/JS untrustworthiness allowed
1375 * @param string $type ResourceLoaderModule TYPE_ constant
1376 * @param int $level ResourceLoaderModule class constant
1378 public function setAllowedModules( $type, $level ) {
1379 $this->mAllowedModules
[$type] = $level;
1383 * As for setAllowedModules(), but don't inadvertently make the page more accessible
1384 * @param string $type
1385 * @param int $level ResourceLoaderModule class constant
1387 public function reduceAllowedModules( $type, $level ) {
1388 $this->mAllowedModules
[$type] = min( $this->getAllowedModules( $type ), $level );
1392 * Prepend $text to the body HTML
1394 * @param string $text HTML
1396 public function prependHTML( $text ) {
1397 $this->mBodytext
= $text . $this->mBodytext
;
1401 * Append $text to the body HTML
1403 * @param string $text HTML
1405 public function addHTML( $text ) {
1406 $this->mBodytext
.= $text;
1410 * Shortcut for adding an Html::element via addHTML.
1414 * @param string $element
1415 * @param array $attribs
1416 * @param string $contents
1418 public function addElement( $element, $attribs = array(), $contents = '' ) {
1419 $this->addHTML( Html
::element( $element, $attribs, $contents ) );
1423 * Clear the body HTML
1425 public function clearHTML() {
1426 $this->mBodytext
= '';
1432 * @return string HTML
1434 public function getHTML() {
1435 return $this->mBodytext
;
1439 * Get/set the ParserOptions object to use for wikitext parsing
1441 * @param ParserOptions|null $options Either the ParserOption to use or null to only get the
1442 * current ParserOption object
1443 * @return ParserOptions
1445 public function parserOptions( $options = null ) {
1446 if ( !$this->mParserOptions
) {
1447 $this->mParserOptions
= ParserOptions
::newFromContext( $this->getContext() );
1448 $this->mParserOptions
->setEditSection( false );
1450 return wfSetVar( $this->mParserOptions
, $options );
1454 * Set the revision ID which will be seen by the wiki text parser
1455 * for things such as embedded {{REVISIONID}} variable use.
1457 * @param int|null $revid An positive integer, or null
1458 * @return mixed Previous value
1460 public function setRevisionId( $revid ) {
1461 $val = is_null( $revid ) ?
null : intval( $revid );
1462 return wfSetVar( $this->mRevisionId
, $val );
1466 * Get the displayed revision ID
1470 public function getRevisionId() {
1471 return $this->mRevisionId
;
1475 * Set the timestamp of the revision which will be displayed. This is used
1476 * to avoid a extra DB call in Skin::lastModified().
1478 * @param string|null $timestamp
1479 * @return mixed Previous value
1481 public function setRevisionTimestamp( $timestamp ) {
1482 return wfSetVar( $this->mRevisionTimestamp
, $timestamp );
1486 * Get the timestamp of displayed revision.
1487 * This will be null if not filled by setRevisionTimestamp().
1489 * @return string|null
1491 public function getRevisionTimestamp() {
1492 return $this->mRevisionTimestamp
;
1496 * Set the displayed file version
1498 * @param File|bool $file
1499 * @return mixed Previous value
1501 public function setFileVersion( $file ) {
1503 if ( $file instanceof File
&& $file->exists() ) {
1504 $val = array( 'time' => $file->getTimestamp(), 'sha1' => $file->getSha1() );
1506 return wfSetVar( $this->mFileVersion
, $val, true );
1510 * Get the displayed file version
1512 * @return array|null ('time' => MW timestamp, 'sha1' => sha1)
1514 public function getFileVersion() {
1515 return $this->mFileVersion
;
1519 * Get the templates used on this page
1521 * @return array (namespace => dbKey => revId)
1524 public function getTemplateIds() {
1525 return $this->mTemplateIds
;
1529 * Get the files used on this page
1531 * @return array (dbKey => array('time' => MW timestamp or null, 'sha1' => sha1 or ''))
1534 public function getFileSearchOptions() {
1535 return $this->mImageTimeKeys
;
1539 * Convert wikitext to HTML and add it to the buffer
1540 * Default assumes that the current page title will be used.
1542 * @param string $text
1543 * @param bool $linestart Is this the start of a line?
1544 * @param bool $interface Is this text in the user interface language?
1546 public function addWikiText( $text, $linestart = true, $interface = true ) {
1547 $title = $this->getTitle(); // Work around E_STRICT
1549 throw new MWException( 'Title is null' );
1551 $this->addWikiTextTitle( $text, $title, $linestart, /*tidy*/false, $interface );
1555 * Add wikitext with a custom Title object
1557 * @param string $text Wikitext
1558 * @param Title $title
1559 * @param bool $linestart Is this the start of a line?
1561 public function addWikiTextWithTitle( $text, &$title, $linestart = true ) {
1562 $this->addWikiTextTitle( $text, $title, $linestart );
1566 * Add wikitext with a custom Title object and tidy enabled.
1568 * @param string $text Wikitext
1569 * @param Title $title
1570 * @param bool $linestart Is this the start of a line?
1572 function addWikiTextTitleTidy( $text, &$title, $linestart = true ) {
1573 $this->addWikiTextTitle( $text, $title, $linestart, true );
1577 * Add wikitext with tidy enabled
1579 * @param string $text Wikitext
1580 * @param bool $linestart Is this the start of a line?
1582 public function addWikiTextTidy( $text, $linestart = true ) {
1583 $title = $this->getTitle();
1584 $this->addWikiTextTitleTidy( $text, $title, $linestart );
1588 * Add wikitext with a custom Title object
1590 * @param string $text Wikitext
1591 * @param Title $title
1592 * @param bool $linestart Is this the start of a line?
1593 * @param bool $tidy Whether to use tidy
1594 * @param bool $interface Whether it is an interface message
1595 * (for example disables conversion)
1597 public function addWikiTextTitle( $text, Title
$title, $linestart,
1598 $tidy = false, $interface = false
1602 wfProfileIn( __METHOD__
);
1604 $popts = $this->parserOptions();
1605 $oldTidy = $popts->setTidy( $tidy );
1606 $popts->setInterfaceMessage( (bool)$interface );
1608 $parserOutput = $wgParser->getFreshParser()->parse(
1609 $text, $title, $popts,
1610 $linestart, true, $this->mRevisionId
1613 $popts->setTidy( $oldTidy );
1615 $this->addParserOutput( $parserOutput );
1617 wfProfileOut( __METHOD__
);
1621 * Add a ParserOutput object, but without Html.
1623 * @deprecated since 1.24, use addParserOutputMetadata() instead.
1624 * @param ParserOutput $parserOutput
1626 public function addParserOutputNoText( &$parserOutput ) {
1627 $this->addParserOutputMetadata( $parserOutput );
1631 * Add all metadata associated with a ParserOutput object, but without the actual HTML. This
1632 * includes categories, language links, ResourceLoader modules, effects of certain magic words,
1636 * @param ParserOutput $parserOutput
1638 public function addParserOutputMetadata( &$parserOutput ) {
1639 $this->mLanguageLinks +
= $parserOutput->getLanguageLinks();
1640 $this->addCategoryLinks( $parserOutput->getCategories() );
1641 $this->mNewSectionLink
= $parserOutput->getNewSection();
1642 $this->mHideNewSectionLink
= $parserOutput->getHideNewSection();
1644 $this->mParseWarnings
= $parserOutput->getWarnings();
1645 if ( !$parserOutput->isCacheable() ) {
1646 $this->enableClientCache( false );
1648 $this->mNoGallery
= $parserOutput->getNoGallery();
1649 $this->mHeadItems
= array_merge( $this->mHeadItems
, $parserOutput->getHeadItems() );
1650 $this->addModules( $parserOutput->getModules() );
1651 $this->addModuleScripts( $parserOutput->getModuleScripts() );
1652 $this->addModuleStyles( $parserOutput->getModuleStyles() );
1653 $this->addModuleMessages( $parserOutput->getModuleMessages() );
1654 $this->addJsConfigVars( $parserOutput->getJsConfigVars() );
1656 // Template versioning...
1657 foreach ( (array)$parserOutput->getTemplateIds() as $ns => $dbks ) {
1658 if ( isset( $this->mTemplateIds
[$ns] ) ) {
1659 $this->mTemplateIds
[$ns] = $dbks +
$this->mTemplateIds
[$ns];
1661 $this->mTemplateIds
[$ns] = $dbks;
1664 // File versioning...
1665 foreach ( (array)$parserOutput->getFileSearchOptions() as $dbk => $data ) {
1666 $this->mImageTimeKeys
[$dbk] = $data;
1669 // Hooks registered in the object
1670 global $wgParserOutputHooks;
1671 foreach ( $parserOutput->getOutputHooks() as $hookInfo ) {
1672 list( $hookName, $data ) = $hookInfo;
1673 if ( isset( $wgParserOutputHooks[$hookName] ) ) {
1674 call_user_func( $wgParserOutputHooks[$hookName], $this, $parserOutput, $data );
1678 // Link flags are ignored for now, but may in the future be
1679 // used to mark individual language links.
1680 $linkFlags = array();
1681 wfRunHooks( 'LanguageLinks', array( $this->getTitle(), &$this->mLanguageLinks
, &$linkFlags ) );
1682 wfRunHooks( 'OutputPageParserOutput', array( &$this, $parserOutput ) );
1686 * Add the HTML and enhancements for it (like ResourceLoader modules) associated with a
1687 * ParserOutput object, without any other metadata.
1690 * @param ParserOutput $parserOutput
1692 public function addParserOutputContent( &$parserOutput ) {
1693 $this->addParserOutputText( $parserOutput );
1695 $this->addModules( $parserOutput->getModules() );
1696 $this->addModuleScripts( $parserOutput->getModuleScripts() );
1697 $this->addModuleStyles( $parserOutput->getModuleStyles() );
1698 $this->addModuleMessages( $parserOutput->getModuleMessages() );
1700 $this->addJsConfigVars( $parserOutput->getJsConfigVars() );
1704 * Add the HTML associated with a ParserOutput object, without any metadata.
1707 * @param ParserOutput $parserOutput
1709 public function addParserOutputText( &$parserOutput ) {
1710 $text = $parserOutput->getText();
1711 wfRunHooks( 'OutputPageBeforeHTML', array( &$this, &$text ) );
1712 $this->addHTML( $text );
1716 * Add everything from a ParserOutput object.
1718 * @param ParserOutput $parserOutput
1720 function addParserOutput( &$parserOutput ) {
1721 $this->addParserOutputMetadata( $parserOutput );
1722 $parserOutput->setTOCEnabled( $this->mEnableTOC
);
1724 // Touch section edit links only if not previously disabled
1725 if ( $parserOutput->getEditSectionTokens() ) {
1726 $parserOutput->setEditSectionTokens( $this->mEnableSectionEditLinks
);
1729 $this->addParserOutputText( $parserOutput );
1733 * Add the output of a QuickTemplate to the output buffer
1735 * @param QuickTemplate $template
1737 public function addTemplate( &$template ) {
1738 $this->addHTML( $template->getHTML() );
1742 * Parse wikitext and return the HTML.
1744 * @param string $text
1745 * @param bool $linestart Is this the start of a line?
1746 * @param bool $interface Use interface language ($wgLang instead of
1747 * $wgContLang) while parsing language sensitive magic words like GRAMMAR and PLURAL.
1748 * This also disables LanguageConverter.
1749 * @param Language $language Target language object, will override $interface
1750 * @throws MWException
1751 * @return string HTML
1753 public function parse( $text, $linestart = true, $interface = false, $language = null ) {
1756 if ( is_null( $this->getTitle() ) ) {
1757 throw new MWException( 'Empty $mTitle in ' . __METHOD__
);
1760 $popts = $this->parserOptions();
1762 $popts->setInterfaceMessage( true );
1764 if ( $language !== null ) {
1765 $oldLang = $popts->setTargetLanguage( $language );
1768 $parserOutput = $wgParser->getFreshParser()->parse(
1769 $text, $this->getTitle(), $popts,
1770 $linestart, true, $this->mRevisionId
1774 $popts->setInterfaceMessage( false );
1776 if ( $language !== null ) {
1777 $popts->setTargetLanguage( $oldLang );
1780 return $parserOutput->getText();
1784 * Parse wikitext, strip paragraphs, and return the HTML.
1786 * @param string $text
1787 * @param bool $linestart Is this the start of a line?
1788 * @param bool $interface Use interface language ($wgLang instead of
1789 * $wgContLang) while parsing language sensitive magic
1790 * words like GRAMMAR and PLURAL
1791 * @return string HTML
1793 public function parseInline( $text, $linestart = true, $interface = false ) {
1794 $parsed = $this->parse( $text, $linestart, $interface );
1795 return Parser
::stripOuterParagraph( $parsed );
1799 * Set the value of the "s-maxage" part of the "Cache-control" HTTP header
1801 * @param int $maxage Maximum cache time on the Squid, in seconds.
1803 public function setSquidMaxage( $maxage ) {
1804 $this->mSquidMaxage
= $maxage;
1808 * Use enableClientCache(false) to force it to send nocache headers
1810 * @param bool $state
1814 public function enableClientCache( $state ) {
1815 return wfSetVar( $this->mEnableClientCache
, $state );
1819 * Get the list of cookies that will influence on the cache
1823 function getCacheVaryCookies() {
1824 global $wgCookiePrefix, $wgCacheVaryCookies;
1826 if ( $cookies === null ) {
1827 $cookies = array_merge(
1829 "{$wgCookiePrefix}Token",
1830 "{$wgCookiePrefix}LoggedOut",
1836 wfRunHooks( 'GetCacheVaryCookies', array( $this, &$cookies ) );
1842 * Check if the request has a cache-varying cookie header
1843 * If it does, it's very important that we don't allow public caching
1847 function haveCacheVaryCookies() {
1848 $cookieHeader = $this->getRequest()->getHeader( 'cookie' );
1849 if ( $cookieHeader === false ) {
1852 $cvCookies = $this->getCacheVaryCookies();
1853 foreach ( $cvCookies as $cookieName ) {
1854 # Check for a simple string match, like the way squid does it
1855 if ( strpos( $cookieHeader, $cookieName ) !== false ) {
1856 wfDebug( __METHOD__
. ": found $cookieName\n" );
1860 wfDebug( __METHOD__
. ": no cache-varying cookies found\n" );
1865 * Add an HTTP header that will influence on the cache
1867 * @param string $header header name
1868 * @param array|null $option
1869 * @todo FIXME: Document the $option parameter; it appears to be for
1870 * X-Vary-Options but what format is acceptable?
1872 public function addVaryHeader( $header, $option = null ) {
1873 if ( !array_key_exists( $header, $this->mVaryHeader
) ) {
1874 $this->mVaryHeader
[$header] = (array)$option;
1875 } elseif ( is_array( $option ) ) {
1876 if ( is_array( $this->mVaryHeader
[$header] ) ) {
1877 $this->mVaryHeader
[$header] = array_merge( $this->mVaryHeader
[$header], $option );
1879 $this->mVaryHeader
[$header] = $option;
1882 $this->mVaryHeader
[$header] = array_unique( (array)$this->mVaryHeader
[$header] );
1886 * Return a Vary: header on which to vary caches. Based on the keys of $mVaryHeader,
1887 * such as Accept-Encoding or Cookie
1891 public function getVaryHeader() {
1892 return 'Vary: ' . join( ', ', array_keys( $this->mVaryHeader
) );
1896 * Get a complete X-Vary-Options header
1900 public function getXVO() {
1901 $cvCookies = $this->getCacheVaryCookies();
1903 $cookiesOption = array();
1904 foreach ( $cvCookies as $cookieName ) {
1905 $cookiesOption[] = 'string-contains=' . $cookieName;
1907 $this->addVaryHeader( 'Cookie', $cookiesOption );
1910 foreach ( $this->mVaryHeader
as $header => $option ) {
1911 $newheader = $header;
1912 if ( is_array( $option ) && count( $option ) > 0 ) {
1913 $newheader .= ';' . implode( ';', $option );
1915 $headers[] = $newheader;
1917 $xvo = 'X-Vary-Options: ' . implode( ',', $headers );
1923 * bug 21672: Add Accept-Language to Vary and XVO headers
1924 * if there's no 'variant' parameter existed in GET.
1927 * /w/index.php?title=Main_page should always be served; but
1928 * /w/index.php?title=Main_page&variant=zh-cn should never be served.
1930 function addAcceptLanguage() {
1931 $title = $this->getTitle();
1932 if ( !$title instanceof Title
) {
1936 $lang = $title->getPageLanguage();
1937 if ( !$this->getRequest()->getCheck( 'variant' ) && $lang->hasVariants() ) {
1938 $variants = $lang->getVariants();
1939 $aloption = array();
1940 foreach ( $variants as $variant ) {
1941 if ( $variant === $lang->getCode() ) {
1944 $aloption[] = 'string-contains=' . $variant;
1946 // IE and some other browsers use BCP 47 standards in
1947 // their Accept-Language header, like "zh-CN" or "zh-Hant".
1948 // We should handle these too.
1949 $variantBCP47 = wfBCP47( $variant );
1950 if ( $variantBCP47 !== $variant ) {
1951 $aloption[] = 'string-contains=' . $variantBCP47;
1955 $this->addVaryHeader( 'Accept-Language', $aloption );
1960 * Set a flag which will cause an X-Frame-Options header appropriate for
1961 * edit pages to be sent. The header value is controlled by
1962 * $wgEditPageFrameOptions.
1964 * This is the default for special pages. If you display a CSRF-protected
1965 * form on an ordinary view page, then you need to call this function.
1967 * @param bool $enable
1969 public function preventClickjacking( $enable = true ) {
1970 $this->mPreventClickjacking
= $enable;
1974 * Turn off frame-breaking. Alias for $this->preventClickjacking(false).
1975 * This can be called from pages which do not contain any CSRF-protected
1978 public function allowClickjacking() {
1979 $this->mPreventClickjacking
= false;
1983 * Get the X-Frame-Options header value (without the name part), or false
1984 * if there isn't one. This is used by Skin to determine whether to enable
1985 * JavaScript frame-breaking, for clients that don't support X-Frame-Options.
1989 public function getFrameOptions() {
1990 global $wgBreakFrames, $wgEditPageFrameOptions;
1991 if ( $wgBreakFrames ) {
1993 } elseif ( $this->mPreventClickjacking
&& $wgEditPageFrameOptions ) {
1994 return $wgEditPageFrameOptions;
2000 * Send cache control HTTP headers
2002 public function sendCacheControl() {
2003 global $wgUseSquid, $wgUseESI, $wgUseETag, $wgSquidMaxage, $wgUseXVO;
2005 $response = $this->getRequest()->response();
2006 if ( $wgUseETag && $this->mETag
) {
2007 $response->header( "ETag: $this->mETag" );
2010 $this->addVaryHeader( 'Cookie' );
2011 $this->addAcceptLanguage();
2013 # don't serve compressed data to clients who can't handle it
2014 # maintain different caches for logged-in users and non-logged in ones
2015 $response->header( $this->getVaryHeader() );
2018 # Add an X-Vary-Options header for Squid with Wikimedia patches
2019 $response->header( $this->getXVO() );
2022 if ( $this->mEnableClientCache
) {
2024 $wgUseSquid && session_id() == '' && !$this->isPrintable() &&
2025 $this->mSquidMaxage
!= 0 && !$this->haveCacheVaryCookies()
2028 # We'll purge the proxy cache explicitly, but require end user agents
2029 # to revalidate against the proxy on each visit.
2030 # Surrogate-Control controls our Squid, Cache-Control downstream caches
2031 wfDebug( __METHOD__
. ": proxy caching with ESI; {$this->mLastModified} **\n", 'log' );
2032 # start with a shorter timeout for initial testing
2033 # header( 'Surrogate-Control: max-age=2678400+2678400, content="ESI/1.0"');
2034 $response->header( 'Surrogate-Control: max-age=' . $wgSquidMaxage
2035 . '+' . $this->mSquidMaxage
. ', content="ESI/1.0"' );
2036 $response->header( 'Cache-Control: s-maxage=0, must-revalidate, max-age=0' );
2038 # We'll purge the proxy cache for anons explicitly, but require end user agents
2039 # to revalidate against the proxy on each visit.
2040 # IMPORTANT! The Squid needs to replace the Cache-Control header with
2041 # Cache-Control: s-maxage=0, must-revalidate, max-age=0
2042 wfDebug( __METHOD__
. ": local proxy caching; {$this->mLastModified} **\n", 'log' );
2043 # start with a shorter timeout for initial testing
2044 # header( "Cache-Control: s-maxage=2678400, must-revalidate, max-age=0" );
2045 $response->header( 'Cache-Control: s-maxage=' . $this->mSquidMaxage
2046 . ', must-revalidate, max-age=0' );
2049 # We do want clients to cache if they can, but they *must* check for updates
2050 # on revisiting the page.
2051 wfDebug( __METHOD__
. ": private caching; {$this->mLastModified} **\n", 'log' );
2052 $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
2053 $response->header( "Cache-Control: private, must-revalidate, max-age=0" );
2055 if ( $this->mLastModified
) {
2056 $response->header( "Last-Modified: {$this->mLastModified}" );
2059 wfDebug( __METHOD__
. ": no caching **\n", 'log' );
2061 # In general, the absence of a last modified header should be enough to prevent
2062 # the client from using its cache. We send a few other things just to make sure.
2063 $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
2064 $response->header( 'Cache-Control: no-cache, no-store, max-age=0, must-revalidate' );
2065 $response->header( 'Pragma: no-cache' );
2070 * Get the message associated with the HTTP response code $code
2072 * @param int $code Status code
2073 * @return string|null Message or null if $code is not in the list of messages
2075 * @deprecated since 1.18 Use HttpStatus::getMessage() instead.
2077 public static function getStatusMessage( $code ) {
2078 wfDeprecated( __METHOD__
, '1.18' );
2079 return HttpStatus
::getMessage( $code );
2083 * Finally, all the text has been munged and accumulated into
2084 * the object, let's actually output it:
2086 public function output() {
2087 global $wgLanguageCode, $wgDebugRedirects, $wgMimeType, $wgVaryOnXFP,
2088 $wgUseAjax, $wgResponsiveImages;
2090 if ( $this->mDoNothing
) {
2094 wfProfileIn( __METHOD__
);
2096 $response = $this->getRequest()->response();
2098 if ( $this->mRedirect
!= '' ) {
2099 # Standards require redirect URLs to be absolute
2100 $this->mRedirect
= wfExpandUrl( $this->mRedirect
, PROTO_CURRENT
);
2102 $redirect = $this->mRedirect
;
2103 $code = $this->mRedirectCode
;
2105 if ( wfRunHooks( "BeforePageRedirect", array( $this, &$redirect, &$code ) ) ) {
2106 if ( $code == '301' ||
$code == '303' ) {
2107 if ( !$wgDebugRedirects ) {
2108 $message = HttpStatus
::getMessage( $code );
2109 $response->header( "HTTP/1.1 $code $message" );
2111 $this->mLastModified
= wfTimestamp( TS_RFC2822
);
2113 if ( $wgVaryOnXFP ) {
2114 $this->addVaryHeader( 'X-Forwarded-Proto' );
2116 $this->sendCacheControl();
2118 $response->header( "Content-Type: text/html; charset=utf-8" );
2119 if ( $wgDebugRedirects ) {
2120 $url = htmlspecialchars( $redirect );
2121 print "<html>\n<head>\n<title>Redirect</title>\n</head>\n<body>\n";
2122 print "<p>Location: <a href=\"$url\">$url</a></p>\n";
2123 print "</body>\n</html>\n";
2125 $response->header( 'Location: ' . $redirect );
2129 wfProfileOut( __METHOD__
);
2131 } elseif ( $this->mStatusCode
) {
2132 $message = HttpStatus
::getMessage( $this->mStatusCode
);
2134 $response->header( 'HTTP/1.1 ' . $this->mStatusCode
. ' ' . $message );
2138 # Buffer output; final headers may depend on later processing
2141 $response->header( "Content-type: $wgMimeType; charset=UTF-8" );
2142 $response->header( 'Content-language: ' . $wgLanguageCode );
2144 // Avoid Internet Explorer "compatibility view" in IE 8-10, so that
2145 // jQuery etc. can work correctly.
2146 $response->header( 'X-UA-Compatible: IE=Edge' );
2148 // Prevent framing, if requested
2149 $frameOptions = $this->getFrameOptions();
2150 if ( $frameOptions ) {
2151 $response->header( "X-Frame-Options: $frameOptions" );
2154 if ( $this->mArticleBodyOnly
) {
2155 echo $this->mBodytext
;
2158 $sk = $this->getSkin();
2159 // add skin specific modules
2160 $modules = $sk->getDefaultModules();
2162 // enforce various default modules for all skins
2163 $coreModules = array(
2164 // keep this list as small as possible
2165 'mediawiki.page.startup',
2169 // Support for high-density display images if enabled
2170 if ( $wgResponsiveImages ) {
2171 $coreModules[] = 'mediawiki.hidpi';
2174 $this->addModules( $coreModules );
2175 foreach ( $modules as $group ) {
2176 $this->addModules( $group );
2178 MWDebug
::addModules( $this );
2180 // FIXME: deprecate? - not clear why this is useful
2181 wfRunHooks( 'AjaxAddScript', array( &$this ) );
2184 // Hook that allows last minute changes to the output page, e.g.
2185 // adding of CSS or Javascript by extensions.
2186 wfRunHooks( 'BeforePageDisplay', array( &$this, &$sk ) );
2188 wfProfileIn( 'Output-skin' );
2190 wfProfileOut( 'Output-skin' );
2193 // This hook allows last minute changes to final overall output by modifying output buffer
2194 wfRunHooks( 'AfterFinalPageOutput', array( $this ) );
2196 $this->sendCacheControl();
2200 wfProfileOut( __METHOD__
);
2204 * Actually output something with print.
2206 * @param string $ins the string to output
2207 * @deprecated since 1.22 Use echo yourself.
2209 public function out( $ins ) {
2210 wfDeprecated( __METHOD__
, '1.22' );
2215 * Produce a "user is blocked" page.
2216 * @deprecated since 1.18
2218 function blockedPage() {
2219 throw new UserBlockedError( $this->getUser()->mBlock
);
2223 * Prepare this object to display an error page; disable caching and
2224 * indexing, clear the current text and redirect, set the page's title
2225 * and optionally an custom HTML title (content of the "<title>" tag).
2227 * @param string|Message $pageTitle will be passed directly to setPageTitle()
2228 * @param string|Message $htmlTitle will be passed directly to setHTMLTitle();
2229 * optional, if not passed the "<title>" attribute will be
2230 * based on $pageTitle
2232 public function prepareErrorPage( $pageTitle, $htmlTitle = false ) {
2233 $this->setPageTitle( $pageTitle );
2234 if ( $htmlTitle !== false ) {
2235 $this->setHTMLTitle( $htmlTitle );
2237 $this->setRobotPolicy( 'noindex,nofollow' );
2238 $this->setArticleRelated( false );
2239 $this->enableClientCache( false );
2240 $this->mRedirect
= '';
2241 $this->clearSubtitle();
2246 * Output a standard error page
2248 * showErrorPage( 'titlemsg', 'pagetextmsg' );
2249 * showErrorPage( 'titlemsg', 'pagetextmsg', array( 'param1', 'param2' ) );
2250 * showErrorPage( 'titlemsg', $messageObject );
2251 * showErrorPage( $titleMessageObject, $messageObject );
2253 * @param string|Message $title Message key (string) for page title, or a Message object
2254 * @param string|Message $msg Message key (string) for page text, or a Message object
2255 * @param array $params Message parameters; ignored if $msg is a Message object
2257 public function showErrorPage( $title, $msg, $params = array() ) {
2258 if ( !$title instanceof Message
) {
2259 $title = $this->msg( $title );
2262 $this->prepareErrorPage( $title );
2264 if ( $msg instanceof Message
) {
2265 if ( $params !== array() ) {
2266 trigger_error( 'Argument ignored: $params. The message parameters argument '
2267 . 'is discarded when the $msg argument is a Message object instead of '
2268 . 'a string.', E_USER_NOTICE
);
2270 $this->addHTML( $msg->parseAsBlock() );
2272 $this->addWikiMsgArray( $msg, $params );
2275 $this->returnToMain();
2279 * Output a standard permission error page
2281 * @param array $errors error message keys
2282 * @param string $action action that was denied or null if unknown
2284 public function showPermissionsErrorPage( $errors, $action = null ) {
2285 // For some action (read, edit, create and upload), display a "login to do this action"
2286 // error if all of the following conditions are met:
2287 // 1. the user is not logged in
2288 // 2. the only error is insufficient permissions (i.e. no block or something else)
2289 // 3. the error can be avoided simply by logging in
2290 if ( in_array( $action, array( 'read', 'edit', 'createpage', 'createtalk', 'upload' ) )
2291 && $this->getUser()->isAnon() && count( $errors ) == 1 && isset( $errors[0][0] )
2292 && ( $errors[0][0] == 'badaccess-groups' ||
$errors[0][0] == 'badaccess-group0' )
2293 && ( User
::groupHasPermission( 'user', $action )
2294 || User
::groupHasPermission( 'autoconfirmed', $action ) )
2296 $displayReturnto = null;
2298 # Due to bug 32276, if a user does not have read permissions,
2299 # $this->getTitle() will just give Special:Badtitle, which is
2300 # not especially useful as a returnto parameter. Use the title
2301 # from the request instead, if there was one.
2302 $request = $this->getRequest();
2303 $returnto = Title
::newFromURL( $request->getVal( 'title', '' ) );
2304 if ( $action == 'edit' ) {
2305 $msg = 'whitelistedittext';
2306 $displayReturnto = $returnto;
2307 } elseif ( $action == 'createpage' ||
$action == 'createtalk' ) {
2308 $msg = 'nocreatetext';
2309 } elseif ( $action == 'upload' ) {
2310 $msg = 'uploadnologintext';
2312 $msg = 'loginreqpagetext';
2313 $displayReturnto = Title
::newMainPage();
2319 $query['returnto'] = $returnto->getPrefixedText();
2321 if ( !$request->wasPosted() ) {
2322 $returntoquery = $request->getValues();
2323 unset( $returntoquery['title'] );
2324 unset( $returntoquery['returnto'] );
2325 unset( $returntoquery['returntoquery'] );
2326 $query['returntoquery'] = wfArrayToCgi( $returntoquery );
2329 $loginLink = Linker
::linkKnown(
2330 SpecialPage
::getTitleFor( 'Userlogin' ),
2331 $this->msg( 'loginreqlink' )->escaped(),
2336 $this->prepareErrorPage( $this->msg( 'loginreqtitle' ) );
2337 $this->addHTML( $this->msg( $msg )->rawParams( $loginLink )->parse() );
2339 # Don't return to a page the user can't read otherwise
2340 # we'll end up in a pointless loop
2341 if ( $displayReturnto && $displayReturnto->userCan( 'read', $this->getUser() ) ) {
2342 $this->returnToMain( null, $displayReturnto );
2345 $this->prepareErrorPage( $this->msg( 'permissionserrors' ) );
2346 $this->addWikiText( $this->formatPermissionsErrorMessage( $errors, $action ) );
2351 * Display an error page indicating that a given version of MediaWiki is
2352 * required to use it
2354 * @param mixed $version The version of MediaWiki needed to use the page
2356 public function versionRequired( $version ) {
2357 $this->prepareErrorPage( $this->msg( 'versionrequired', $version ) );
2359 $this->addWikiMsg( 'versionrequiredtext', $version );
2360 $this->returnToMain();
2364 * Display an error page noting that a given permission bit is required.
2365 * @deprecated since 1.18, just throw the exception directly
2366 * @param string $permission key required
2367 * @throws PermissionsError
2369 public function permissionRequired( $permission ) {
2370 throw new PermissionsError( $permission );
2374 * Produce the stock "please login to use the wiki" page
2376 * @deprecated since 1.19; throw the exception directly
2378 public function loginToUse() {
2379 throw new PermissionsError( 'read' );
2383 * Format a list of error messages
2385 * @param array $errors Array of arrays returned by Title::getUserPermissionsErrors
2386 * @param string $action Action that was denied or null if unknown
2387 * @return string The wikitext error-messages, formatted into a list.
2389 public function formatPermissionsErrorMessage( $errors, $action = null ) {
2390 if ( $action == null ) {
2391 $text = $this->msg( 'permissionserrorstext', count( $errors ) )->plain() . "\n\n";
2393 $action_desc = $this->msg( "action-$action" )->plain();
2395 'permissionserrorstext-withaction',
2398 )->plain() . "\n\n";
2401 if ( count( $errors ) > 1 ) {
2402 $text .= '<ul class="permissions-errors">' . "\n";
2404 foreach ( $errors as $error ) {
2406 $text .= call_user_func_array( array( $this, 'msg' ), $error )->plain();
2411 $text .= "<div class=\"permissions-errors\">\n" .
2412 call_user_func_array( array( $this, 'msg' ), reset( $errors ) )->plain() .
2420 * Display a page stating that the Wiki is in read-only mode,
2421 * and optionally show the source of the page that the user
2422 * was trying to edit. Should only be called (for this
2423 * purpose) after wfReadOnly() has returned true.
2425 * For historical reasons, this function is _also_ used to
2426 * show the error message when a user tries to edit a page
2427 * they are not allowed to edit. (Unless it's because they're
2428 * blocked, then we show blockedPage() instead.) In this
2429 * case, the second parameter should be set to true and a list
2430 * of reasons supplied as the third parameter.
2432 * @todo Needs to be split into multiple functions.
2434 * @param string $source Source code to show (or null).
2435 * @param bool $protected Is this a permissions error?
2436 * @param array $reasons List of reasons for this error, as returned by
2437 * Title::getUserPermissionsErrors().
2438 * @param string $action Action that was denied or null if unknown
2439 * @throws ReadOnlyError
2441 public function readOnlyPage( $source = null, $protected = false,
2442 $reasons = array(), $action = null
2444 $this->setRobotPolicy( 'noindex,nofollow' );
2445 $this->setArticleRelated( false );
2447 // If no reason is given, just supply a default "I can't let you do
2448 // that, Dave" message. Should only occur if called by legacy code.
2449 if ( $protected && empty( $reasons ) ) {
2450 $reasons[] = array( 'badaccess-group0' );
2453 if ( !empty( $reasons ) ) {
2454 // Permissions error
2456 $this->setPageTitle( $this->msg( 'viewsource-title', $this->getTitle()->getPrefixedText() ) );
2457 $this->addBacklinkSubtitle( $this->getTitle() );
2459 $this->setPageTitle( $this->msg( 'badaccess' ) );
2461 $this->addWikiText( $this->formatPermissionsErrorMessage( $reasons, $action ) );
2463 // Wiki is read only
2464 throw new ReadOnlyError
;
2467 // Show source, if supplied
2468 if ( is_string( $source ) ) {
2469 $this->addWikiMsg( 'viewsourcetext' );
2471 $pageLang = $this->getTitle()->getPageLanguage();
2473 'id' => 'wpTextbox1',
2474 'name' => 'wpTextbox1',
2475 'cols' => $this->getUser()->getOption( 'cols' ),
2476 'rows' => $this->getUser()->getOption( 'rows' ),
2477 'readonly' => 'readonly',
2478 'lang' => $pageLang->getHtmlCode(),
2479 'dir' => $pageLang->getDir(),
2481 $this->addHTML( Html
::element( 'textarea', $params, $source ) );
2483 // Show templates used by this article
2484 $templates = Linker
::formatTemplates( $this->getTitle()->getTemplateLinksFrom() );
2485 $this->addHTML( "<div class='templatesUsed'>
2491 # If the title doesn't exist, it's fairly pointless to print a return
2492 # link to it. After all, you just tried editing it and couldn't, so
2493 # what's there to do there?
2494 if ( $this->getTitle()->exists() ) {
2495 $this->returnToMain( null, $this->getTitle() );
2500 * Turn off regular page output and return an error response
2501 * for when rate limiting has triggered.
2503 public function rateLimited() {
2504 throw new ThrottledError
;
2508 * Show a warning about slave lag
2510 * If the lag is higher than $wgSlaveLagCritical seconds,
2511 * then the warning is a bit more obvious. If the lag is
2512 * lower than $wgSlaveLagWarning, then no warning is shown.
2514 * @param int $lag Slave lag
2516 public function showLagWarning( $lag ) {
2517 global $wgSlaveLagWarning, $wgSlaveLagCritical;
2518 if ( $lag >= $wgSlaveLagWarning ) {
2519 $message = $lag < $wgSlaveLagCritical
2522 $wrap = Html
::rawElement( 'div', array( 'class' => "mw-{$message}" ), "\n$1\n" );
2523 $this->wrapWikiMsg( "$wrap\n", array( $message, $this->getLanguage()->formatNum( $lag ) ) );
2527 public function showFatalError( $message ) {
2528 $this->prepareErrorPage( $this->msg( 'internalerror' ) );
2530 $this->addHTML( $message );
2533 public function showUnexpectedValueError( $name, $val ) {
2534 $this->showFatalError( $this->msg( 'unexpected', $name, $val )->text() );
2537 public function showFileCopyError( $old, $new ) {
2538 $this->showFatalError( $this->msg( 'filecopyerror', $old, $new )->text() );
2541 public function showFileRenameError( $old, $new ) {
2542 $this->showFatalError( $this->msg( 'filerenameerror', $old, $new )->text() );
2545 public function showFileDeleteError( $name ) {
2546 $this->showFatalError( $this->msg( 'filedeleteerror', $name )->text() );
2549 public function showFileNotFoundError( $name ) {
2550 $this->showFatalError( $this->msg( 'filenotfound', $name )->text() );
2554 * Add a "return to" link pointing to a specified title
2556 * @param Title $title Title to link
2557 * @param array $query Query string parameters
2558 * @param string $text Text of the link (input is not escaped)
2559 * @param array $options Options array to pass to Linker
2561 public function addReturnTo( $title, $query = array(), $text = null, $options = array() ) {
2562 $link = $this->msg( 'returnto' )->rawParams(
2563 Linker
::link( $title, $text, array(), $query, $options ) )->escaped();
2564 $this->addHTML( "<p id=\"mw-returnto\">{$link}</p>\n" );
2568 * Add a "return to" link pointing to a specified title,
2569 * or the title indicated in the request, or else the main page
2571 * @param mixed $unused
2572 * @param Title|string $returnto Title or String to return to
2573 * @param string $returntoquery Query string for the return to link
2575 public function returnToMain( $unused = null, $returnto = null, $returntoquery = null ) {
2576 if ( $returnto == null ) {
2577 $returnto = $this->getRequest()->getText( 'returnto' );
2580 if ( $returntoquery == null ) {
2581 $returntoquery = $this->getRequest()->getText( 'returntoquery' );
2584 if ( $returnto === '' ) {
2585 $returnto = Title
::newMainPage();
2588 if ( is_object( $returnto ) ) {
2589 $titleObj = $returnto;
2591 $titleObj = Title
::newFromText( $returnto );
2593 if ( !is_object( $titleObj ) ) {
2594 $titleObj = Title
::newMainPage();
2597 $this->addReturnTo( $titleObj, wfCgiToArray( $returntoquery ) );
2601 * @param Skin $sk The given Skin
2602 * @param bool $includeStyle Unused
2603 * @return string The doctype, opening "<html>", and head element.
2605 public function headElement( Skin
$sk, $includeStyle = true ) {
2606 global $wgContLang, $wgMimeType;
2608 $userdir = $this->getLanguage()->getDir();
2609 $sitedir = $wgContLang->getDir();
2611 $ret = Html
::htmlHeader( $sk->getHtmlElementAttributes() );
2613 if ( $this->getHTMLTitle() == '' ) {
2614 $this->setHTMLTitle( $this->msg( 'pagetitle', $this->getPageTitle() )->inContentLanguage() );
2617 $openHead = Html
::openElement( 'head' );
2619 # Don't bother with the newline if $head == ''
2620 $ret .= "$openHead\n";
2623 if ( !Html
::isXmlMimeType( $wgMimeType ) ) {
2624 // Add <meta charset="UTF-8">
2625 // This should be before <title> since it defines the charset used by
2626 // text including the text inside <title>.
2627 // The spec recommends defining XHTML5's charset using the XML declaration
2629 // Our XML declaration is output by Html::htmlHeader.
2630 // http://www.whatwg.org/html/semantics.html#attr-meta-http-equiv-content-type
2631 // http://www.whatwg.org/html/semantics.html#charset
2632 $ret .= Html
::element( 'meta', array( 'charset' => 'UTF-8' ) ) . "\n";
2635 $ret .= Html
::element( 'title', null, $this->getHTMLTitle() ) . "\n";
2637 foreach ( $this->getHeadLinksArray() as $item ) {
2638 $ret .= $item . "\n";
2641 // No newline after buildCssLinks since makeResourceLoaderLink did that already
2642 $ret .= $this->buildCssLinks();
2644 $ret .= $this->getHeadScripts() . "\n";
2646 foreach ( $this->mHeadItems
as $item ) {
2647 $ret .= $item . "\n";
2650 $closeHead = Html
::closeElement( 'head' );
2652 $ret .= "$closeHead\n";
2655 $bodyClasses = array();
2656 $bodyClasses[] = 'mediawiki';
2658 # Classes for LTR/RTL directionality support
2659 $bodyClasses[] = $userdir;
2660 $bodyClasses[] = "sitedir-$sitedir";
2662 if ( $this->getLanguage()->capitalizeAllNouns() ) {
2663 # A <body> class is probably not the best way to do this . . .
2664 $bodyClasses[] = 'capitalize-all-nouns';
2667 $bodyClasses[] = $sk->getPageClasses( $this->getTitle() );
2668 $bodyClasses[] = 'skin-' . Sanitizer
::escapeClass( $sk->getSkinName() );
2670 'action-' . Sanitizer
::escapeClass( Action
::getActionName( $this->getContext() ) );
2672 $bodyAttrs = array();
2673 // While the implode() is not strictly needed, it's used for backwards compatibility
2674 // (this used to be built as a string and hooks likely still expect that).
2675 $bodyAttrs['class'] = implode( ' ', $bodyClasses );
2677 // Allow skins and extensions to add body attributes they need
2678 $sk->addToBodyAttributes( $this, $bodyAttrs );
2679 wfRunHooks( 'OutputPageBodyAttributes', array( $this, $sk, &$bodyAttrs ) );
2681 $ret .= Html
::openElement( 'body', $bodyAttrs ) . "\n";
2687 * Get a ResourceLoader object associated with this OutputPage
2689 * @return ResourceLoader
2691 public function getResourceLoader() {
2692 if ( is_null( $this->mResourceLoader
) ) {
2693 $this->mResourceLoader
= new ResourceLoader();
2695 return $this->mResourceLoader
;
2700 * @param array|string $modules One or more module names
2701 * @param string $only ResourceLoaderModule TYPE_ class constant
2702 * @param bool $useESI
2703 * @param array $extraQuery Array with extra query parameters to add to each
2704 * request. array( param => value ).
2705 * @param bool $loadCall If true, output an (asynchronous) mw.loader.load()
2706 * call rather than a "<script src='...'>" tag.
2707 * @return string The html "<script>", "<link>" and "<style>" tags
2709 protected function makeResourceLoaderLink( $modules, $only, $useESI = false,
2710 array $extraQuery = array(), $loadCall = false
2712 global $wgResourceLoaderUseESI;
2714 $modules = (array)$modules;
2718 'states' => array(),
2721 if ( !count( $modules ) ) {
2725 if ( count( $modules ) > 1 ) {
2726 // Remove duplicate module requests
2727 $modules = array_unique( $modules );
2728 // Sort module names so requests are more uniform
2731 if ( ResourceLoader
::inDebugMode() ) {
2732 // Recursively call us for every item
2733 foreach ( $modules as $name ) {
2734 $link = $this->makeResourceLoaderLink( $name, $only, $useESI );
2735 $links['html'] .= $link['html'];
2736 $links['states'] +
= $link['states'];
2742 if ( !is_null( $this->mTarget
) ) {
2743 $extraQuery['target'] = $this->mTarget
;
2746 // Create keyed-by-group list of module objects from modules list
2748 $resourceLoader = $this->getResourceLoader();
2749 foreach ( $modules as $name ) {
2750 $module = $resourceLoader->getModule( $name );
2751 # Check that we're allowed to include this module on this page
2753 ||
( $module->getOrigin() > $this->getAllowedModules( ResourceLoaderModule
::TYPE_SCRIPTS
)
2754 && $only == ResourceLoaderModule
::TYPE_SCRIPTS
)
2755 ||
( $module->getOrigin() > $this->getAllowedModules( ResourceLoaderModule
::TYPE_STYLES
)
2756 && $only == ResourceLoaderModule
::TYPE_STYLES
)
2757 ||
( $this->mTarget
&& !in_array( $this->mTarget
, $module->getTargets() ) )
2762 $group = $module->getGroup();
2763 if ( !isset( $groups[$group] ) ) {
2764 $groups[$group] = array();
2766 $groups[$group][$name] = $module;
2769 foreach ( $groups as $group => $grpModules ) {
2770 // Special handling for user-specific groups
2772 if ( ( $group === 'user' ||
$group === 'private' ) && $this->getUser()->isLoggedIn() ) {
2773 $user = $this->getUser()->getName();
2776 // Create a fake request based on the one we are about to make so modules return
2777 // correct timestamp and emptiness data
2778 $query = ResourceLoader
::makeLoaderQuery(
2779 array(), // modules; not determined yet
2780 $this->getLanguage()->getCode(),
2781 $this->getSkin()->getSkinName(),
2783 null, // version; not determined yet
2784 ResourceLoader
::inDebugMode(),
2785 $only === ResourceLoaderModule
::TYPE_COMBINED ?
null : $only,
2786 $this->isPrintable(),
2787 $this->getRequest()->getBool( 'handheld' ),
2790 $context = new ResourceLoaderContext( $resourceLoader, new FauxRequest( $query ) );
2792 // Extract modules that know they're empty
2793 foreach ( $grpModules as $key => $module ) {
2794 // Inline empty modules: since they're empty, just mark them as 'ready' (bug 46857)
2795 // If we're only getting the styles, we don't need to do anything for empty modules.
2796 if ( $module->isKnownEmpty( $context ) ) {
2797 unset( $grpModules[$key] );
2798 if ( $only !== ResourceLoaderModule
::TYPE_STYLES
) {
2799 $links['states'][$key] = 'ready';
2804 // If there are no non-empty modules, skip this group
2805 if ( count( $grpModules ) === 0 ) {
2809 // Inline private modules. These can't be loaded through load.php for security
2810 // reasons, see bug 34907. Note that these modules should be loaded from
2811 // getHeadScripts() before the first loader call. Otherwise other modules can't
2812 // properly use them as dependencies (bug 30914)
2813 if ( $group === 'private' ) {
2814 if ( $only == ResourceLoaderModule
::TYPE_STYLES
) {
2815 $links['html'] .= Html
::inlineStyle(
2816 $resourceLoader->makeModuleResponse( $context, $grpModules )
2819 $links['html'] .= Html
::inlineScript(
2820 ResourceLoader
::makeLoaderConditionalScript(
2821 $resourceLoader->makeModuleResponse( $context, $grpModules )
2825 $links['html'] .= "\n";
2829 // Special handling for the user group; because users might change their stuff
2830 // on-wiki like user pages, or user preferences; we need to find the highest
2831 // timestamp of these user-changeable modules so we can ensure cache misses on change
2832 // This should NOT be done for the site group (bug 27564) because anons get that too
2833 // and we shouldn't be putting timestamps in Squid-cached HTML
2835 if ( $group === 'user' ) {
2836 // Get the maximum timestamp
2838 foreach ( $grpModules as $module ) {
2839 $timestamp = max( $timestamp, $module->getModifiedTime( $context ) );
2841 // Add a version parameter so cache will break when things change
2842 $version = wfTimestamp( TS_ISO_8601_BASIC
, $timestamp );
2845 $url = ResourceLoader
::makeLoaderURL(
2846 array_keys( $grpModules ),
2847 $this->getLanguage()->getCode(),
2848 $this->getSkin()->getSkinName(),
2851 ResourceLoader
::inDebugMode(),
2852 $only === ResourceLoaderModule
::TYPE_COMBINED ?
null : $only,
2853 $this->isPrintable(),
2854 $this->getRequest()->getBool( 'handheld' ),
2857 if ( $useESI && $wgResourceLoaderUseESI ) {
2858 $esi = Xml
::element( 'esi:include', array( 'src' => $url ) );
2859 if ( $only == ResourceLoaderModule
::TYPE_STYLES
) {
2860 $link = Html
::inlineStyle( $esi );
2862 $link = Html
::inlineScript( $esi );
2865 // Automatically select style/script elements
2866 if ( $only === ResourceLoaderModule
::TYPE_STYLES
) {
2867 $link = Html
::linkedStyle( $url );
2868 } elseif ( $loadCall ) {
2869 $link = Html
::inlineScript(
2870 ResourceLoader
::makeLoaderConditionalScript(
2871 Xml
::encodeJsCall( 'mw.loader.load', array( $url, 'text/javascript', true ) )
2875 $link = Html
::linkedScript( $url );
2877 // For modules requested directly in the html via <link> or <script>,
2878 // tell mw.loader they are being loading to prevent duplicate requests.
2879 foreach ( $grpModules as $key => $module ) {
2880 // Don't output state=loading for the startup module..
2881 if ( $key !== 'startup' ) {
2882 $links['states'][$key] = 'loading';
2888 if ( $group == 'noscript' ) {
2889 $links['html'] .= Html
::rawElement( 'noscript', array(), $link ) . "\n";
2891 $links['html'] .= $link . "\n";
2899 * Build html output from an array of links from makeResourceLoaderLink.
2900 * @param array $links
2901 * @return string HTML
2903 protected static function getHtmlFromLoaderLinks( Array $links ) {
2906 foreach ( $links as $link ) {
2907 if ( !is_array( $link ) ) {
2910 $html .= $link['html'];
2911 $states +
= $link['states'];
2915 if ( count( $states ) ) {
2916 $html = Html
::inlineScript(
2917 ResourceLoader
::makeLoaderConditionalScript(
2918 ResourceLoader
::makeLoaderStateScript( $states )
2927 * JS stuff to put in the "<head>". This is the startup module, config
2928 * vars and modules marked with position 'top'
2930 * @return string HTML fragment
2932 function getHeadScripts() {
2933 global $wgResourceLoaderExperimentalAsyncLoading;
2935 // Startup - this will immediately load jquery and mediawiki modules
2937 $links[] = $this->makeResourceLoaderLink( 'startup', ResourceLoaderModule
::TYPE_SCRIPTS
, true );
2939 // Load config before anything else
2940 $links[] = Html
::inlineScript(
2941 ResourceLoader
::makeLoaderConditionalScript(
2942 ResourceLoader
::makeConfigSetScript( $this->getJSVars() )
2946 // Load embeddable private modules before any loader links
2947 // This needs to be TYPE_COMBINED so these modules are properly wrapped
2948 // in mw.loader.implement() calls and deferred until mw.user is available
2949 $embedScripts = array( 'user.options', 'user.tokens' );
2950 $links[] = $this->makeResourceLoaderLink( $embedScripts, ResourceLoaderModule
::TYPE_COMBINED
);
2952 // Scripts and messages "only" requests marked for top inclusion
2953 // Messages should go first
2954 $links[] = $this->makeResourceLoaderLink(
2955 $this->getModuleMessages( true, 'top' ),
2956 ResourceLoaderModule
::TYPE_MESSAGES
2958 $links[] = $this->makeResourceLoaderLink(
2959 $this->getModuleScripts( true, 'top' ),
2960 ResourceLoaderModule
::TYPE_SCRIPTS
2963 // Modules requests - let the client calculate dependencies and batch requests as it likes
2964 // Only load modules that have marked themselves for loading at the top
2965 $modules = $this->getModules( true, 'top' );
2967 $links[] = Html
::inlineScript(
2968 ResourceLoader
::makeLoaderConditionalScript(
2969 Xml
::encodeJsCall( 'mw.loader.load', array( $modules ) )
2974 if ( $wgResourceLoaderExperimentalAsyncLoading ) {
2975 $links[] = $this->getScriptsForBottomQueue( true );
2978 return self
::getHtmlFromLoaderLinks( $links );
2982 * JS stuff to put at the 'bottom', which can either be the bottom of the
2983 * "<body>" or the bottom of the "<head>" depending on
2984 * $wgResourceLoaderExperimentalAsyncLoading: modules marked with position
2985 * 'bottom', legacy scripts ($this->mScripts), user preferences, site JS
2988 * @param bool $inHead If true, this HTML goes into the "<head>",
2989 * if false it goes into the "<body>".
2992 function getScriptsForBottomQueue( $inHead ) {
2993 global $wgUseSiteJs, $wgAllowUserJs;
2995 // Scripts and messages "only" requests marked for bottom inclusion
2996 // If we're in the <head>, use load() calls rather than <script src="..."> tags
2997 // Messages should go first
2999 $links[] = $this->makeResourceLoaderLink( $this->getModuleMessages( true, 'bottom' ),
3000 ResourceLoaderModule
::TYPE_MESSAGES
, /* $useESI = */ false, /* $extraQuery = */ array(),
3001 /* $loadCall = */ $inHead
3003 $links[] = $this->makeResourceLoaderLink( $this->getModuleScripts( true, 'bottom' ),
3004 ResourceLoaderModule
::TYPE_SCRIPTS
, /* $useESI = */ false, /* $extraQuery = */ array(),
3005 /* $loadCall = */ $inHead
3008 // Modules requests - let the client calculate dependencies and batch requests as it likes
3009 // Only load modules that have marked themselves for loading at the bottom
3010 $modules = $this->getModules( true, 'bottom' );
3012 $links[] = Html
::inlineScript(
3013 ResourceLoader
::makeLoaderConditionalScript(
3014 Xml
::encodeJsCall( 'mw.loader.load', array( $modules, null, true ) )
3020 $links[] = "\n" . $this->mScripts
;
3022 // Add site JS if enabled
3023 $links[] = $this->makeResourceLoaderLink( 'site', ResourceLoaderModule
::TYPE_SCRIPTS
,
3024 /* $useESI = */ false, /* $extraQuery = */ array(), /* $loadCall = */ $inHead
3027 // Add user JS if enabled
3029 && $this->getUser()->isLoggedIn()
3030 && $this->getTitle()
3031 && $this->getTitle()->isJsSubpage()
3032 && $this->userCanPreview()
3034 # XXX: additional security check/prompt?
3035 // We're on a preview of a JS subpage
3036 // Exclude this page from the user module in case it's in there (bug 26283)
3037 $links[] = $this->makeResourceLoaderLink( 'user', ResourceLoaderModule
::TYPE_SCRIPTS
, false,
3038 array( 'excludepage' => $this->getTitle()->getPrefixedDBkey() ), $inHead
3040 // Load the previewed JS
3041 $links[] = Html
::inlineScript( "\n"
3042 . $this->getRequest()->getText( 'wpTextbox1' ) . "\n" ) . "\n";
3044 // FIXME: If the user is previewing, say, ./vector.js, his ./common.js will be loaded
3045 // asynchronously and may arrive *after* the inline script here. So the previewed code
3046 // may execute before ./common.js runs. Normally, ./common.js runs before ./vector.js...
3048 // Include the user module normally, i.e., raw to avoid it being wrapped in a closure.
3049 $links[] = $this->makeResourceLoaderLink( 'user', ResourceLoaderModule
::TYPE_SCRIPTS
,
3050 /* $useESI = */ false, /* $extraQuery = */ array(), /* $loadCall = */ $inHead
3054 // Group JS is only enabled if site JS is enabled.
3055 $links[] = $this->makeResourceLoaderLink( 'user.groups', ResourceLoaderModule
::TYPE_COMBINED
,
3056 /* $useESI = */ false, /* $extraQuery = */ array(), /* $loadCall = */ $inHead
3059 return self
::getHtmlFromLoaderLinks( $links );
3063 * JS stuff to put at the bottom of the "<body>"
3066 function getBottomScripts() {
3067 global $wgResourceLoaderExperimentalAsyncLoading;
3069 // Optimise jQuery ready event cross-browser.
3070 // This also enforces $.isReady to be true at </body> which fixes the
3071 // mw.loader bug in Firefox with using document.write between </body>
3072 // and the DOMContentReady event (bug 47457).
3073 $html = Html
::inlineScript( 'window.jQuery && jQuery.ready();' );
3075 if ( !$wgResourceLoaderExperimentalAsyncLoading ) {
3076 $html .= $this->getScriptsForBottomQueue( false );
3083 * Get the javascript config vars to include on this page
3085 * @return array Array of javascript config vars
3088 public function getJsConfigVars() {
3089 return $this->mJsConfigVars
;
3093 * Add one or more variables to be set in mw.config in JavaScript
3095 * @param string|array $keys Key or array of key/value pairs
3096 * @param mixed $value [optional] Value of the configuration variable
3098 public function addJsConfigVars( $keys, $value = null ) {
3099 if ( is_array( $keys ) ) {
3100 foreach ( $keys as $key => $value ) {
3101 $this->mJsConfigVars
[$key] = $value;
3106 $this->mJsConfigVars
[$keys] = $value;
3110 * Get an array containing the variables to be set in mw.config in JavaScript.
3112 * Do not add things here which can be evaluated in ResourceLoaderStartUpModule
3113 * - in other words, page-independent/site-wide variables (without state).
3114 * You will only be adding bloat to the html page and causing page caches to
3115 * have to be purged on configuration changes.
3118 private function getJSVars() {
3123 $canonicalSpecialPageName = false; # bug 21115
3125 $title = $this->getTitle();
3126 $ns = $title->getNamespace();
3127 $canonicalNamespace = MWNamespace
::exists( $ns )
3128 ? MWNamespace
::getCanonicalName( $ns )
3129 : $title->getNsText();
3131 $sk = $this->getSkin();
3132 // Get the relevant title so that AJAX features can use the correct page name
3133 // when making API requests from certain special pages (bug 34972).
3134 $relevantTitle = $sk->getRelevantTitle();
3135 $relevantUser = $sk->getRelevantUser();
3137 if ( $ns == NS_SPECIAL
) {
3138 list( $canonicalSpecialPageName, /*...*/ ) =
3139 SpecialPageFactory
::resolveAlias( $title->getDBkey() );
3140 } elseif ( $this->canUseWikiPage() ) {
3141 $wikiPage = $this->getWikiPage();
3142 $curRevisionId = $wikiPage->getLatest();
3143 $articleId = $wikiPage->getId();
3146 $lang = $title->getPageLanguage();
3148 // Pre-process information
3149 $separatorTransTable = $lang->separatorTransformTable();
3150 $separatorTransTable = $separatorTransTable ?
$separatorTransTable : array();
3151 $compactSeparatorTransTable = array(
3152 implode( "\t", array_keys( $separatorTransTable ) ),
3153 implode( "\t", $separatorTransTable ),
3155 $digitTransTable = $lang->digitTransformTable();
3156 $digitTransTable = $digitTransTable ?
$digitTransTable : array();
3157 $compactDigitTransTable = array(
3158 implode( "\t", array_keys( $digitTransTable ) ),
3159 implode( "\t", $digitTransTable ),
3162 $user = $this->getUser();
3165 'wgCanonicalNamespace' => $canonicalNamespace,
3166 'wgCanonicalSpecialPageName' => $canonicalSpecialPageName,
3167 'wgNamespaceNumber' => $title->getNamespace(),
3168 'wgPageName' => $title->getPrefixedDBkey(),
3169 'wgTitle' => $title->getText(),
3170 'wgCurRevisionId' => $curRevisionId,
3171 'wgRevisionId' => (int)$this->getRevisionId(),
3172 'wgArticleId' => $articleId,
3173 'wgIsArticle' => $this->isArticle(),
3174 'wgIsRedirect' => $title->isRedirect(),
3175 'wgAction' => Action
::getActionName( $this->getContext() ),
3176 'wgUserName' => $user->isAnon() ?
null : $user->getName(),
3177 'wgUserGroups' => $user->getEffectiveGroups(),
3178 'wgCategories' => $this->getCategories(),
3179 'wgBreakFrames' => $this->getFrameOptions() == 'DENY',
3180 'wgPageContentLanguage' => $lang->getCode(),
3181 'wgPageContentModel' => $title->getContentModel(),
3182 'wgSeparatorTransformTable' => $compactSeparatorTransTable,
3183 'wgDigitTransformTable' => $compactDigitTransTable,
3184 'wgDefaultDateFormat' => $lang->getDefaultDateFormat(),
3185 'wgMonthNames' => $lang->getMonthNamesArray(),
3186 'wgMonthNamesShort' => $lang->getMonthAbbreviationsArray(),
3187 'wgRelevantPageName' => $relevantTitle->getPrefixedDBkey(),
3190 if ( $user->isLoggedIn() ) {
3191 $vars['wgUserId'] = $user->getId();
3192 $vars['wgUserEditCount'] = $user->getEditCount();
3193 $userReg = wfTimestampOrNull( TS_UNIX
, $user->getRegistration() );
3194 $vars['wgUserRegistration'] = $userReg !== null ?
( $userReg * 1000 ) : null;
3195 // Get the revision ID of the oldest new message on the user's talk
3196 // page. This can be used for constructing new message alerts on
3198 $vars['wgUserNewMsgRevisionId'] = $user->getNewMessageRevisionId();
3201 if ( $wgContLang->hasVariants() ) {
3202 $vars['wgUserVariant'] = $wgContLang->getPreferredVariant();
3204 // Same test as SkinTemplate
3205 $vars['wgIsProbablyEditable'] = $title->quickUserCan( 'edit', $user )
3206 && ( $title->exists() ||
$title->quickUserCan( 'create', $user ) );
3208 foreach ( $title->getRestrictionTypes() as $type ) {
3209 $vars['wgRestriction' . ucfirst( $type )] = $title->getRestrictions( $type );
3212 if ( $title->isMainPage() ) {
3213 $vars['wgIsMainPage'] = true;
3216 if ( $this->mRedirectedFrom
) {
3217 $vars['wgRedirectedFrom'] = $this->mRedirectedFrom
->getPrefixedDBkey();
3220 if ( $relevantUser ) {
3221 $vars['wgRelevantUserName'] = $relevantUser->getName();
3224 // Allow extensions to add their custom variables to the mw.config map.
3225 // Use the 'ResourceLoaderGetConfigVars' hook if the variable is not
3226 // page-dependant but site-wide (without state).
3227 // Alternatively, you may want to use OutputPage->addJsConfigVars() instead.
3228 wfRunHooks( 'MakeGlobalVariablesScript', array( &$vars, $this ) );
3230 // Merge in variables from addJsConfigVars last
3231 return array_merge( $vars, $this->getJsConfigVars() );
3235 * To make it harder for someone to slip a user a fake
3236 * user-JavaScript or user-CSS preview, a random token
3237 * is associated with the login session. If it's not
3238 * passed back with the preview request, we won't render
3243 public function userCanPreview() {
3244 if ( $this->getRequest()->getVal( 'action' ) != 'submit'
3245 ||
!$this->getRequest()->wasPosted()
3246 ||
!$this->getUser()->matchEditToken(
3247 $this->getRequest()->getVal( 'wpEditToken' ) )
3251 if ( !$this->getTitle()->isJsSubpage() && !$this->getTitle()->isCssSubpage() ) {
3255 return !count( $this->getTitle()->getUserPermissionsErrors( 'edit', $this->getUser() ) );
3259 * @return array in format "link name or number => 'link html'".
3261 public function getHeadLinksArray() {
3262 global $wgUniversalEditButton, $wgFavicon, $wgAppleTouchIcon, $wgEnableAPI,
3263 $wgSitename, $wgVersion,
3264 $wgFeed, $wgOverrideSiteFeed, $wgAdvertisedFeedTypes,
3265 $wgDisableLangConversion, $wgCanonicalLanguageLinks,
3266 $wgRightsPage, $wgRightsUrl;
3270 $canonicalUrl = $this->mCanonicalUrl
;
3272 $tags['meta-generator'] = Html
::element( 'meta', array(
3273 'name' => 'generator',
3274 'content' => "MediaWiki $wgVersion",
3277 $p = "{$this->mIndexPolicy},{$this->mFollowPolicy}";
3278 if ( $p !== 'index,follow' ) {
3279 // http://www.robotstxt.org/wc/meta-user.html
3280 // Only show if it's different from the default robots policy
3281 $tags['meta-robots'] = Html
::element( 'meta', array(
3287 foreach ( $this->mMetatags
as $tag ) {
3288 if ( 0 == strcasecmp( 'http:', substr( $tag[0], 0, 5 ) ) ) {
3290 $tag[0] = substr( $tag[0], 5 );
3294 $tagName = "meta-{$tag[0]}";
3295 if ( isset( $tags[$tagName] ) ) {
3296 $tagName .= $tag[1];
3298 $tags[$tagName] = Html
::element( 'meta',
3301 'content' => $tag[1]
3306 foreach ( $this->mLinktags
as $tag ) {
3307 $tags[] = Html
::element( 'link', $tag );
3310 # Universal edit button
3311 if ( $wgUniversalEditButton && $this->isArticleRelated() ) {
3312 $user = $this->getUser();
3313 if ( $this->getTitle()->quickUserCan( 'edit', $user )
3314 && ( $this->getTitle()->exists() ||
$this->getTitle()->quickUserCan( 'create', $user ) ) ) {
3315 // Original UniversalEditButton
3316 $msg = $this->msg( 'edit' )->text();
3317 $tags['universal-edit-button'] = Html
::element( 'link', array(
3318 'rel' => 'alternate',
3319 'type' => 'application/x-wiki',
3321 'href' => $this->getTitle()->getEditURL(),
3323 // Alternate edit link
3324 $tags['alternative-edit'] = Html
::element( 'link', array(
3327 'href' => $this->getTitle()->getEditURL(),
3332 # Generally the order of the favicon and apple-touch-icon links
3333 # should not matter, but Konqueror (3.5.9 at least) incorrectly
3334 # uses whichever one appears later in the HTML source. Make sure
3335 # apple-touch-icon is specified first to avoid this.
3336 if ( $wgAppleTouchIcon !== false ) {
3337 $tags['apple-touch-icon'] = Html
::element( 'link', array(
3338 'rel' => 'apple-touch-icon',
3339 'href' => $wgAppleTouchIcon
3343 if ( $wgFavicon !== false ) {
3344 $tags['favicon'] = Html
::element( 'link', array(
3345 'rel' => 'shortcut icon',
3346 'href' => $wgFavicon
3350 # OpenSearch description link
3351 $tags['opensearch'] = Html
::element( 'link', array(
3353 'type' => 'application/opensearchdescription+xml',
3354 'href' => wfScript( 'opensearch_desc' ),
3355 'title' => $this->msg( 'opensearch-desc' )->inContentLanguage()->text(),
3358 if ( $wgEnableAPI ) {
3359 # Real Simple Discovery link, provides auto-discovery information
3360 # for the MediaWiki API (and potentially additional custom API
3361 # support such as WordPress or Twitter-compatible APIs for a
3362 # blogging extension, etc)
3363 $tags['rsd'] = Html
::element( 'link', array(
3365 'type' => 'application/rsd+xml',
3366 // Output a protocol-relative URL here if $wgServer is protocol-relative
3367 // Whether RSD accepts relative or protocol-relative URLs is completely undocumented, though
3368 'href' => wfExpandUrl( wfAppendQuery(
3370 array( 'action' => 'rsd' ) ),
3377 if ( !$wgDisableLangConversion && $wgCanonicalLanguageLinks ) {
3378 $lang = $this->getTitle()->getPageLanguage();
3379 if ( $lang->hasVariants() ) {
3381 $urlvar = $lang->getURLVariant();
3384 $variants = $lang->getVariants();
3385 foreach ( $variants as $_v ) {
3386 $tags["variant-$_v"] = Html
::element( 'link', array(
3387 'rel' => 'alternate',
3388 'hreflang' => wfBCP47( $_v ),
3389 'href' => $this->getTitle()->getLocalURL( array( 'variant' => $_v ) ) )
3393 $canonicalUrl = $this->getTitle()->getLocalURL();
3400 if ( $wgRightsPage ) {
3401 $copy = Title
::newFromText( $wgRightsPage );
3404 $copyright = $copy->getLocalURL();
3408 if ( !$copyright && $wgRightsUrl ) {
3409 $copyright = $wgRightsUrl;
3413 $tags['copyright'] = Html
::element( 'link', array(
3414 'rel' => 'copyright',
3415 'href' => $copyright )
3421 foreach ( $this->getSyndicationLinks() as $format => $link ) {
3422 # Use the page name for the title. In principle, this could
3423 # lead to issues with having the same name for different feeds
3424 # corresponding to the same page, but we can't avoid that at
3427 $tags[] = $this->feedLink(
3430 # Used messages: 'page-rss-feed' and 'page-atom-feed' (for an easier grep)
3431 $this->msg( "page-{$format}-feed", $this->getTitle()->getPrefixedText() )->text()
3435 # Recent changes feed should appear on every page (except recentchanges,
3436 # that would be redundant). Put it after the per-page feed to avoid
3437 # changing existing behavior. It's still available, probably via a
3438 # menu in your browser. Some sites might have a different feed they'd
3439 # like to promote instead of the RC feed (maybe like a "Recent New Articles"
3440 # or "Breaking news" one). For this, we see if $wgOverrideSiteFeed is defined.
3441 # If so, use it instead.
3442 if ( $wgOverrideSiteFeed ) {
3443 foreach ( $wgOverrideSiteFeed as $type => $feedUrl ) {
3444 // Note, this->feedLink escapes the url.
3445 $tags[] = $this->feedLink(
3448 $this->msg( "site-{$type}-feed", $wgSitename )->text()
3451 } elseif ( !$this->getTitle()->isSpecial( 'Recentchanges' ) ) {
3452 $rctitle = SpecialPage
::getTitleFor( 'Recentchanges' );
3453 foreach ( $wgAdvertisedFeedTypes as $format ) {
3454 $tags[] = $this->feedLink(
3456 $rctitle->getLocalURL( array( 'feed' => $format ) ),
3457 # For grep: 'site-rss-feed', 'site-atom-feed'
3458 $this->msg( "site-{$format}-feed", $wgSitename )->text()
3465 global $wgEnableCanonicalServerLink;
3466 if ( $wgEnableCanonicalServerLink ) {
3467 if ( $canonicalUrl !== false ) {
3468 $canonicalUrl = wfExpandUrl( $canonicalUrl, PROTO_CANONICAL
);
3470 $reqUrl = $this->getRequest()->getRequestURL();
3471 $canonicalUrl = wfExpandUrl( $reqUrl, PROTO_CANONICAL
);
3474 if ( $canonicalUrl !== false ) {
3475 $tags[] = Html
::element( 'link', array(
3476 'rel' => 'canonical',
3477 'href' => $canonicalUrl
3485 * @return string HTML tag links to be put in the header.
3486 * @deprecated since 1.24 Use OutputPage::headElement or if you have to,
3487 * OutputPage::getHeadLinksArray directly.
3489 public function getHeadLinks() {
3490 wfDeprecated( __METHOD__
, '1.24' );
3491 return implode( "\n", $this->getHeadLinksArray() );
3495 * Generate a "<link rel/>" for a feed.
3497 * @param string $type Feed type
3498 * @param string $url URL to the feed
3499 * @param string $text Value of the "title" attribute
3500 * @return string HTML fragment
3502 private function feedLink( $type, $url, $text ) {
3503 return Html
::element( 'link', array(
3504 'rel' => 'alternate',
3505 'type' => "application/$type+xml",
3512 * Add a local or specified stylesheet, with the given media options.
3513 * Meant primarily for internal use...
3515 * @param string $style URL to the file
3516 * @param string $media to specify a media type, 'screen', 'printable', 'handheld' or any.
3517 * @param string $condition for IE conditional comments, specifying an IE version
3518 * @param string $dir set to 'rtl' or 'ltr' for direction-specific sheets
3520 public function addStyle( $style, $media = '', $condition = '', $dir = '' ) {
3522 // Even though we expect the media type to be lowercase, but here we
3523 // force it to lowercase to be safe.
3525 $options['media'] = $media;
3528 $options['condition'] = $condition;
3531 $options['dir'] = $dir;
3533 $this->styles
[$style] = $options;
3537 * Adds inline CSS styles
3538 * @param mixed $style_css Inline CSS
3539 * @param string $flip Set to 'flip' to flip the CSS if needed
3541 public function addInlineStyle( $style_css, $flip = 'noflip' ) {
3542 if ( $flip === 'flip' && $this->getLanguage()->isRTL() ) {
3543 # If wanted, and the interface is right-to-left, flip the CSS
3544 $style_css = CSSJanus
::transform( $style_css, true, false );
3546 $this->mInlineStyles
.= Html
::inlineStyle( $style_css ) . "\n";
3550 * Build a set of "<link>" elements for the stylesheets specified in the $this->styles array.
3551 * These will be applied to various media & IE conditionals.
3555 public function buildCssLinks() {
3556 global $wgUseSiteCss, $wgAllowUserCss, $wgAllowUserCssPrefs, $wgContLang;
3558 $this->getSkin()->setupSkinUserCss( $this );
3560 // Add ResourceLoader styles
3561 // Split the styles into these groups
3566 'private' => array(),
3567 'noscript' => array()
3570 $otherTags = ''; // Tags to append after the normal <link> tags
3571 $resourceLoader = $this->getResourceLoader();
3573 $moduleStyles = $this->getModuleStyles();
3575 // Per-site custom styles
3576 $moduleStyles[] = 'site';
3577 $moduleStyles[] = 'noscript';
3578 $moduleStyles[] = 'user.groups';
3580 // Per-user custom styles
3581 if ( $wgAllowUserCss && $this->getTitle()->isCssSubpage() && $this->userCanPreview() ) {
3582 // We're on a preview of a CSS subpage
3583 // Exclude this page from the user module in case it's in there (bug 26283)
3584 $link = $this->makeResourceLoaderLink( 'user', ResourceLoaderModule
::TYPE_STYLES
, false,
3585 array( 'excludepage' => $this->getTitle()->getPrefixedDBkey() )
3587 $otherTags .= $link['html'];
3589 // Load the previewed CSS
3590 // If needed, Janus it first. This is user-supplied CSS, so it's
3591 // assumed to be right for the content language directionality.
3592 $previewedCSS = $this->getRequest()->getText( 'wpTextbox1' );
3593 if ( $this->getLanguage()->getDir() !== $wgContLang->getDir() ) {
3594 $previewedCSS = CSSJanus
::transform( $previewedCSS, true, false );
3596 $otherTags .= Html
::inlineStyle( $previewedCSS ) . "\n";
3598 // Load the user styles normally
3599 $moduleStyles[] = 'user';
3602 // Per-user preference styles
3603 $moduleStyles[] = 'user.cssprefs';
3605 foreach ( $moduleStyles as $name ) {
3606 $module = $resourceLoader->getModule( $name );
3610 $group = $module->getGroup();
3611 // Modules in groups different than the ones listed on top (see $styles assignment)
3612 // will be placed in the "other" group
3613 $styles[ isset( $styles[$group] ) ?
$group : 'other' ][] = $name;
3616 // We want site, private and user styles to override dynamically added
3617 // styles from modules, but we want dynamically added styles to override
3618 // statically added styles from other modules. So the order has to be
3619 // other, dynamic, site, private, user. Add statically added styles for
3621 $links[] = $this->makeResourceLoaderLink( $styles['other'], ResourceLoaderModule
::TYPE_STYLES
);
3622 // Add normal styles added through addStyle()/addInlineStyle() here
3623 $links[] = implode( "\n", $this->buildCssLinksArray() ) . $this->mInlineStyles
;
3624 // Add marker tag to mark the place where the client-side loader should inject dynamic styles
3625 // We use a <meta> tag with a made-up name for this because that's valid HTML
3626 $links[] = Html
::element(
3628 array( 'name' => 'ResourceLoaderDynamicStyles', 'content' => '' )
3631 // Add site, private and user styles
3632 // 'private' at present only contains user.options, so put that before 'user'
3633 // Any future private modules will likely have a similar user-specific character
3634 foreach ( array( 'site', 'noscript', 'private', 'user' ) as $group ) {
3635 $links[] = $this->makeResourceLoaderLink( $styles[$group],
3636 ResourceLoaderModule
::TYPE_STYLES
3640 // Add stuff in $otherTags (previewed user CSS if applicable)
3641 return self
::getHtmlFromLoaderLinks( $links ) . $otherTags;
3647 public function buildCssLinksArray() {
3650 // Add any extension CSS
3651 foreach ( $this->mExtStyles
as $url ) {
3652 $this->addStyle( $url );
3654 $this->mExtStyles
= array();
3656 foreach ( $this->styles
as $file => $options ) {
3657 $link = $this->styleLink( $file, $options );
3659 $links[$file] = $link;
3666 * Generate \<link\> tags for stylesheets
3668 * @param string $style URL to the file
3669 * @param array $options Option, can contain 'condition', 'dir', 'media' keys
3670 * @return string HTML fragment
3672 protected function styleLink( $style, $options ) {
3673 if ( isset( $options['dir'] ) ) {
3674 if ( $this->getLanguage()->getDir() != $options['dir'] ) {
3679 if ( isset( $options['media'] ) ) {
3680 $media = self
::transformCssMedia( $options['media'] );
3681 if ( is_null( $media ) ) {
3688 if ( substr( $style, 0, 1 ) == '/' ||
3689 substr( $style, 0, 5 ) == 'http:' ||
3690 substr( $style, 0, 6 ) == 'https:' ) {
3693 global $wgStylePath, $wgStyleVersion;
3694 $url = $wgStylePath . '/' . $style . '?' . $wgStyleVersion;
3697 $link = Html
::linkedStyle( $url, $media );
3699 if ( isset( $options['condition'] ) ) {
3700 $condition = htmlspecialchars( $options['condition'] );
3701 $link = "<!--[if $condition]>$link<![endif]-->";
3707 * Transform "media" attribute based on request parameters
3709 * @param string $media Current value of the "media" attribute
3710 * @return string Modified value of the "media" attribute, or null to skip
3713 public static function transformCssMedia( $media ) {
3716 // http://www.w3.org/TR/css3-mediaqueries/#syntax
3717 $screenMediaQueryRegex = '/^(?:only\s+)?screen\b/i';
3719 // Switch in on-screen display for media testing
3721 'printable' => 'print',
3722 'handheld' => 'handheld',
3724 foreach ( $switches as $switch => $targetMedia ) {
3725 if ( $wgRequest->getBool( $switch ) ) {
3726 if ( $media == $targetMedia ) {
3728 } elseif ( preg_match( $screenMediaQueryRegex, $media ) === 1 ) {
3729 // This regex will not attempt to understand a comma-separated media_query_list
3731 // Example supported values for $media:
3732 // 'screen', 'only screen', 'screen and (min-width: 982px)' ),
3733 // Example NOT supported value for $media:
3734 // '3d-glasses, screen, print and resolution > 90dpi'
3736 // If it's a print request, we never want any kind of screen stylesheets
3737 // If it's a handheld request (currently the only other choice with a switch),
3738 // we don't want simple 'screen' but we might want screen queries that
3739 // have a max-width or something, so we'll pass all others on and let the
3740 // client do the query.
3741 if ( $targetMedia == 'print' ||
$media == 'screen' ) {
3752 * Add a wikitext-formatted message to the output.
3753 * This is equivalent to:
3755 * $wgOut->addWikiText( wfMessage( ... )->plain() )
3757 public function addWikiMsg( /*...*/ ) {
3758 $args = func_get_args();
3759 $name = array_shift( $args );
3760 $this->addWikiMsgArray( $name, $args );
3764 * Add a wikitext-formatted message to the output.
3765 * Like addWikiMsg() except the parameters are taken as an array
3766 * instead of a variable argument list.
3768 * @param string $name
3769 * @param array $args
3771 public function addWikiMsgArray( $name, $args ) {
3772 $this->addHTML( $this->msg( $name, $args )->parseAsBlock() );
3776 * This function takes a number of message/argument specifications, wraps them in
3777 * some overall structure, and then parses the result and adds it to the output.
3779 * In the $wrap, $1 is replaced with the first message, $2 with the second, and so
3780 * on. The subsequent arguments may either be strings, in which case they are the
3781 * message names, or arrays, in which case the first element is the message name,
3782 * and subsequent elements are the parameters to that message.
3784 * Don't use this for messages that are not in users interface language.
3788 * $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>", 'some-error' );
3792 * $wgOut->addWikiText( "<div class='error'>\n"
3793 * . wfMessage( 'some-error' )->plain() . "\n</div>" );
3795 * The newline after opening div is needed in some wikitext. See bug 19226.
3797 * @param string $wrap
3799 public function wrapWikiMsg( $wrap /*, ...*/ ) {
3800 $msgSpecs = func_get_args();
3801 array_shift( $msgSpecs );
3802 $msgSpecs = array_values( $msgSpecs );
3804 foreach ( $msgSpecs as $n => $spec ) {
3805 if ( is_array( $spec ) ) {
3807 $name = array_shift( $args );
3808 if ( isset( $args['options'] ) ) {
3809 unset( $args['options'] );
3811 'Adding "options" to ' . __METHOD__
. ' is no longer supported',
3819 $s = str_replace( '$' . ( $n +
1 ), $this->msg( $name, $args )->plain(), $s );
3821 $this->addWikiText( $s );
3825 * Include jQuery core. Use this to avoid loading it multiple times
3826 * before we get a usable script loader.
3828 * @param array $modules List of jQuery modules which should be loaded
3829 * @return array The list of modules which were not loaded.
3831 * @deprecated since 1.17
3833 public function includeJQuery( $modules = array() ) {
3838 * Enables/disables TOC, doesn't override __NOTOC__
3842 public function enableTOC( $flag = true ) {
3843 $this->mEnableTOC
= $flag;
3850 public function isTOCEnabled() {
3851 return $this->mEnableTOC
;
3855 * Enables/disables section edit links, doesn't override __NOEDITSECTION__
3859 public function enableSectionEditLinks( $flag = true ) {
3860 $this->mEnableSectionEditLinks
= $flag;
3867 public function sectionEditLinksEnabled() {
3868 return $this->mEnableSectionEditLinks
;