2 if ( !defined( 'MEDIAWIKI' ) ) {
7 * This class should be covered by a general architecture document which does
8 * not exist as of January 2011. This is one of the Core classes and should
9 * be read at least once by any new developers.
11 * This class is used to prepare the final rendering. A skin is then
12 * applied to the output parameters (links, javascript, html, categories ...).
14 * @todo FIXME: Another class handles sending the whole page to the client.
16 * Some comments comes from a pairing session between Zak Greant and Ashar Voultoiz
22 /// Should be private. Used with addMeta() which adds <meta>
23 var $mMetatags = array();
25 /// <meta keyworkds="stuff"> most of the time the first 10 links to an article
26 var $mKeywords = array();
28 var $mLinktags = array();
30 /// Additional stylesheets. Looks like this is for extensions. Might be replaced by resource loader.
31 var $mExtStyles = array();
33 /// Should be private - has getter and setter. Contains the HTML title
36 /// Contains all of the <body> content. Should be private we got set/get accessors and the append() method.
40 * Holds the debug lines that will be output as comments in page source if
41 * $wgDebugComments is enabled. See also $wgShowDebug.
42 * TODO: make a getter method for this
44 public $mDebugtext = ''; // TODO: we might want to replace it by wfDebug() wfDebugLog()
46 /// Should be private. Stores contents of <title> tag
49 /// Should be private. Is the displayed content related to the source of the corresponding wiki article.
50 var $mIsarticle = true;
53 * Should be private. We have to set isPrintable(). Some pages should
54 * never be printed (ex: redirections).
56 var $mPrintable = false;
59 * Should be private. We have set/get/append methods.
61 * Contains the page subtitle. Special pages usually have some links here.
62 * Don't confuse with site subtitle added by skins.
70 * mLastModified and mEtag are used for sending cache control.
71 * The whole caching system should probably be moved into its own class.
73 var $mLastModified = '';
76 * Should be private. No getter but used in sendCacheControl();
77 * Contains an HTTP Entity Tags (see RFC 2616 section 3.13) which is used
78 * as a unique identifier for the content. It is later used by the client
79 * to compare its cached version with the server version. Client sends
80 * headers If-Match and If-None-Match containing its locally cached ETAG value.
82 * To get more information, you will have to look at HTTP/1.1 protocol which
83 * is properly described in RFC 2616 : http://tools.ietf.org/html/rfc2616
87 var $mCategoryLinks = array();
88 var $mCategories = array();
90 /// Should be private. Array of Interwiki Prefixed (non DB key) Titles (e.g. 'fr:Test page')
91 var $mLanguageLinks = array();
94 * Should be private. Used for JavaScript (pre resource loader)
95 * We should split js / css.
96 * mScripts content is inserted as is in <head> by Skin. This might contains
97 * either a link to a stylesheet or inline css.
102 * Inline CSS styles. Use addInlineStyle() sparsingly
104 var $mInlineStyles = '';
110 * Used by skin template.
111 * Example: $tpl->set( 'displaytitle', $out->mPageLinkTitle );
113 var $mPageLinkTitle = '';
115 /// Array of elements in <head>. Parser might add its own headers!
116 var $mHeadItems = array();
118 // @todo FIXME: Next variables probably comes from the resource loader
119 var $mModules = array(), $mModuleScripts = array(), $mModuleStyles = array(), $mModuleMessages = array();
120 var $mResourceLoader;
122 /** @todo FIXME: Is this still used ?*/
123 var $mInlineMsg = array();
125 var $mTemplateIds = array();
126 var $mImageTimeKeys = array();
128 # What level of 'untrustworthiness' is allowed in CSS/JS modules loaded on this page?
129 # @see ResourceLoaderModule::$origin
130 # ResourceLoaderModule::ORIGIN_ALL is assumed unless overridden;
131 protected $mAllowedModules = array(
132 ResourceLoaderModule
::TYPE_COMBINED
=> ResourceLoaderModule
::ORIGIN_ALL
,
136 * @EasterEgg I just love the name for this self documenting variable.
139 var $mDoNothing = false;
142 var $mContainsOldMagic = 0, $mContainsNewMagic = 0;
145 * Should be private. Has get/set methods properly documented.
146 * Stores "article flag" toggle.
148 var $mIsArticleRelated = true;
150 /// lazy initialised, use parserOptions()
151 protected $mParserOptions = null;
154 * Handles the atom / rss links.
155 * We probably only support atom in 2011.
156 * Looks like a private variable.
157 * @see $wgAdvertisedFeedTypes
159 var $mFeedLinks = array();
161 // Gwicke work on squid caching? Roughly from 2003.
162 var $mEnableClientCache = true;
165 * Flag if output should only contain the body of the article.
168 var $mArticleBodyOnly = false;
170 var $mNewSectionLink = false;
171 var $mHideNewSectionLink = false;
174 * Comes from the parser. This was probably made to load CSS/JS only
175 * if we had <gallery>. Used directly in CategoryPage.php
176 * Looks like resource loader can replace this.
178 var $mNoGallery = false;
180 // should be private.
181 var $mPageTitleActionText = '';
182 var $mParseWarnings = array();
184 // Cache stuff. Looks like mEnableClientCache
185 var $mSquidMaxage = 0;
188 var $mPreventClickjacking = true;
190 /// should be private. To include the variable {{REVISIONID}}
191 var $mRevisionId = null;
196 * An array of stylesheet filenames (relative from skins path), with options
197 * for CSS media, IE conditions, and RTL/LTR direction.
198 * For internal use; add settings in the skin via $this->addStyle()
200 * Style again! This seems like a code duplication since we already have
201 * mStyles. This is what makes OpenSource amazing.
203 var $styles = array();
206 * Whether jQuery is already handled.
208 protected $mJQueryDone = false;
210 private $mIndexPolicy = 'index';
211 private $mFollowPolicy = 'follow';
212 private $mVaryHeader = array(
213 'Accept-Encoding' => array( 'list-contains=gzip' ),
218 * Constructor for OutputPage. This should not be called directly.
219 * Instead a new RequestContext should be created and it will implicitly create
220 * a OutputPage tied to that context.
222 function __construct( RequestContext
$context = null ) {
223 if ( !isset($context) ) {
224 # Extensions should use `new RequestContext` instead of `new OutputPage` now.
225 wfDeprecated( __METHOD__
);
227 $this->mContext
= $context;
231 * Redirect to $url rather than displaying the normal page
233 * @param $url String: URL
234 * @param $responsecode String: HTTP status code
236 public function redirect( $url, $responsecode = '302' ) {
237 # Strip newlines as a paranoia check for header injection in PHP<5.1.2
238 $this->mRedirect
= str_replace( "\n", '', $url );
239 $this->mRedirectCode
= $responsecode;
243 * Get the URL to redirect to, or an empty string if not redirect URL set
247 public function getRedirect() {
248 return $this->mRedirect
;
252 * Set the HTTP status code to send with the output.
254 * @param $statusCode Integer
256 public function setStatusCode( $statusCode ) {
257 $this->mStatusCode
= $statusCode;
261 * Add a new <meta> tag
262 * To add an http-equiv meta tag, precede the name with "http:"
264 * @param $name String tag name
265 * @param $val String tag value
267 function addMeta( $name, $val ) {
268 array_push( $this->mMetatags
, array( $name, $val ) );
272 * Add a keyword or a list of keywords in the page header
274 * @param $text String or array of strings
276 function addKeyword( $text ) {
277 if( is_array( $text ) ) {
278 $this->mKeywords
= array_merge( $this->mKeywords
, $text );
280 array_push( $this->mKeywords
, $text );
285 * Add a new \<link\> tag to the page header
287 * @param $linkarr Array: associative array of attributes.
289 function addLink( $linkarr ) {
290 array_push( $this->mLinktags
, $linkarr );
294 * Add a new \<link\> with "rel" attribute set to "meta"
296 * @param $linkarr Array: associative array mapping attribute names to their
297 * values, both keys and values will be escaped, and the
298 * "rel" attribute will be automatically added
300 function addMetadataLink( $linkarr ) {
301 $linkarr['rel'] = $this->getMetadataAttribute();
302 $this->addLink( $linkarr );
306 * Get the value of the "rel" attribute for metadata links
310 public function getMetadataAttribute() {
311 # note: buggy CC software only reads first "meta" link
312 static $haveMeta = false;
314 return 'alternate meta';
322 * Add raw HTML to the list of scripts (including \<script\> tag, etc.)
324 * @param $script String: raw HTML
326 function addScript( $script ) {
327 $this->mScripts
.= $script . "\n";
331 * Register and add a stylesheet from an extension directory.
333 * @param $url String path to sheet. Provide either a full url (beginning
334 * with 'http', etc) or a relative path from the document root
335 * (beginning with '/'). Otherwise it behaves identically to
336 * addStyle() and draws from the /skins folder.
338 public function addExtensionStyle( $url ) {
339 array_push( $this->mExtStyles
, $url );
343 * Get all styles added by extensions
347 function getExtStyle() {
348 return $this->mExtStyles
;
352 * Add a JavaScript file out of skins/common, or a given relative path.
354 * @param $file String: filename in skins/common or complete on-server path
356 * @param $version String: style version of the file. Defaults to $wgStyleVersion
358 public function addScriptFile( $file, $version = null ) {
359 global $wgStylePath, $wgStyleVersion;
360 // See if $file parameter is an absolute URL or begins with a slash
361 if( substr( $file, 0, 1 ) == '/' ||
preg_match( '#^[a-z]*://#i', $file ) ) {
364 $path = "{$wgStylePath}/common/{$file}";
366 if ( is_null( $version ) )
367 $version = $wgStyleVersion;
368 $this->addScript( Html
::linkedScript( wfAppendQuery( $path, $version ) ) );
372 * Add a self-contained script tag with the given contents
374 * @param $script String: JavaScript text, no <script> tags
376 public function addInlineScript( $script ) {
377 $this->mScripts
.= Html
::inlineScript( "\n$script\n" ) . "\n";
381 * Get all registered JS and CSS tags for the header.
385 function getScript() {
386 return $this->mScripts
. $this->getHeadItems();
390 * Filter an array of modules to remove insufficiently trustworthy members, and modules
391 * which are no longer registered (eg a page is cached before an extension is disabled)
392 * @param $modules Array
393 * @param $position String if not null, only return modules with this position
394 * @param $type string
397 protected function filterModules( $modules, $position = null, $type = ResourceLoaderModule
::TYPE_COMBINED
){
398 $resourceLoader = $this->getResourceLoader();
399 $filteredModules = array();
400 foreach( $modules as $val ){
401 $module = $resourceLoader->getModule( $val );
402 if( $module instanceof ResourceLoaderModule
403 && $module->getOrigin() <= $this->getAllowedModules( $type )
404 && ( is_null( $position ) ||
$module->getPosition() == $position ) )
406 $filteredModules[] = $val;
409 return $filteredModules;
413 * Get the list of modules to include on this page
415 * @param $filter Bool whether to filter out insufficiently trustworthy modules
416 * @param $position String if not null, only return modules with this position
417 * @param $param string
418 * @return Array of module names
420 public function getModules( $filter = false, $position = null, $param = 'mModules' ) {
421 $modules = array_values( array_unique( $this->$param ) );
423 ?
$this->filterModules( $modules, $position )
428 * Add one or more modules recognized by the resource loader. Modules added
429 * through this function will be loaded by the resource loader when the
432 * @param $modules Mixed: module name (string) or array of module names
434 public function addModules( $modules ) {
435 $this->mModules
= array_merge( $this->mModules
, (array)$modules );
439 * Get the list of module JS to include on this page
444 * @return array of module names
446 public function getModuleScripts( $filter = false, $position = null ) {
447 return $this->getModules( $filter, $position, 'mModuleScripts' );
451 * Add only JS of one or more modules recognized by the resource loader. Module
452 * scripts added through this function will be loaded by the resource loader when
455 * @param $modules Mixed: module name (string) or array of module names
457 public function addModuleScripts( $modules ) {
458 $this->mModuleScripts
= array_merge( $this->mModuleScripts
, (array)$modules );
462 * Get the list of module CSS to include on this page
467 * @return Array of module names
469 public function getModuleStyles( $filter = false, $position = null ) {
470 return $this->getModules( $filter, $position, 'mModuleStyles' );
474 * Add only CSS of one or more modules recognized by the resource loader. Module
475 * styles added through this function will be loaded by the resource loader when
478 * @param $modules Mixed: module name (string) or array of module names
480 public function addModuleStyles( $modules ) {
481 $this->mModuleStyles
= array_merge( $this->mModuleStyles
, (array)$modules );
485 * Get the list of module messages to include on this page
490 * @return Array of module names
492 public function getModuleMessages( $filter = false, $position = null ) {
493 return $this->getModules( $filter, $position, 'mModuleMessages' );
497 * Add only messages of one or more modules recognized by the resource loader.
498 * Module messages added through this function will be loaded by the resource
499 * loader when the page loads.
501 * @param $modules Mixed: module name (string) or array of module names
503 public function addModuleMessages( $modules ) {
504 $this->mModuleMessages
= array_merge( $this->mModuleMessages
, (array)$modules );
508 * Get all header items in a string
512 function getHeadItems() {
514 foreach ( $this->mHeadItems
as $item ) {
521 * Add or replace an header item to the output
523 * @param $name String: item name
524 * @param $value String: raw HTML
526 public function addHeadItem( $name, $value ) {
527 $this->mHeadItems
[$name] = $value;
531 * Check if the header item $name is already set
533 * @param $name String: item name
536 public function hasHeadItem( $name ) {
537 return isset( $this->mHeadItems
[$name] );
541 * Set the value of the ETag HTTP header, only used if $wgUseETag is true
543 * @param $tag String: value of "ETag" header
545 function setETag( $tag ) {
550 * Set whether the output should only contain the body of the article,
551 * without any skin, sidebar, etc.
552 * Used e.g. when calling with "action=render".
554 * @param $only Boolean: whether to output only the body of the article
556 public function setArticleBodyOnly( $only ) {
557 $this->mArticleBodyOnly
= $only;
561 * Return whether the output will contain only the body of the article
565 public function getArticleBodyOnly() {
566 return $this->mArticleBodyOnly
;
570 * checkLastModified tells the client to use the client-cached page if
571 * possible. If sucessful, the OutputPage is disabled so that
572 * any future call to OutputPage->output() have no effect.
574 * Side effect: sets mLastModified for Last-Modified header
576 * @param $timestamp string
578 * @return Boolean: true iff cache-ok headers was sent.
580 public function checkLastModified( $timestamp ) {
581 global $wgCachePages, $wgCacheEpoch;
583 if ( !$timestamp ||
$timestamp == '19700101000000' ) {
584 wfDebug( __METHOD__
. ": CACHE DISABLED, NO TIMESTAMP\n" );
587 if( !$wgCachePages ) {
588 wfDebug( __METHOD__
. ": CACHE DISABLED\n", false );
591 if( $this->getUser()->getOption( 'nocache' ) ) {
592 wfDebug( __METHOD__
. ": USER DISABLED CACHE\n", false );
596 $timestamp = wfTimestamp( TS_MW
, $timestamp );
597 $modifiedTimes = array(
598 'page' => $timestamp,
599 'user' => $this->getUser()->getTouched(),
600 'epoch' => $wgCacheEpoch
602 wfRunHooks( 'OutputPageCheckLastModified', array( &$modifiedTimes ) );
604 $maxModified = max( $modifiedTimes );
605 $this->mLastModified
= wfTimestamp( TS_RFC2822
, $maxModified );
607 if( empty( $_SERVER['HTTP_IF_MODIFIED_SINCE'] ) ) {
608 wfDebug( __METHOD__
. ": client did not send If-Modified-Since header\n", false );
614 foreach ( $modifiedTimes as $name => $value ) {
615 if ( $info !== '' ) {
618 $info .= "$name=" . wfTimestamp( TS_ISO_8601
, $value );
621 # IE sends sizes after the date like this:
622 # Wed, 20 Aug 2003 06:51:19 GMT; length=5202
623 # this breaks strtotime().
624 $clientHeader = preg_replace( '/;.*$/', '', $_SERVER["HTTP_IF_MODIFIED_SINCE"] );
626 wfSuppressWarnings(); // E_STRICT system time bitching
627 $clientHeaderTime = strtotime( $clientHeader );
629 if ( !$clientHeaderTime ) {
630 wfDebug( __METHOD__
. ": unable to parse the client's If-Modified-Since header: $clientHeader\n" );
633 $clientHeaderTime = wfTimestamp( TS_MW
, $clientHeaderTime );
635 wfDebug( __METHOD__
. ": client sent If-Modified-Since: " .
636 wfTimestamp( TS_ISO_8601
, $clientHeaderTime ) . "\n", false );
637 wfDebug( __METHOD__
. ": effective Last-Modified: " .
638 wfTimestamp( TS_ISO_8601
, $maxModified ) . "\n", false );
639 if( $clientHeaderTime < $maxModified ) {
640 wfDebug( __METHOD__
. ": STALE, $info\n", false );
645 # Give a 304 response code and disable body output
646 wfDebug( __METHOD__
. ": NOT MODIFIED, $info\n", false );
647 ini_set( 'zlib.output_compression', 0 );
648 $this->getRequest()->response()->header( "HTTP/1.1 304 Not Modified" );
649 $this->sendCacheControl();
652 // Don't output a compressed blob when using ob_gzhandler;
653 // it's technically against HTTP spec and seems to confuse
654 // Firefox when the response gets split over two packets.
655 wfClearOutputBuffers();
661 * Override the last modified timestamp
663 * @param $timestamp String: new timestamp, in a format readable by
666 public function setLastModified( $timestamp ) {
667 $this->mLastModified
= wfTimestamp( TS_RFC2822
, $timestamp );
671 * Set the robot policy for the page: <http://www.robotstxt.org/meta.html>
673 * @param $policy String: the literal string to output as the contents of
674 * the meta tag. Will be parsed according to the spec and output in
678 public function setRobotPolicy( $policy ) {
679 $policy = Article
::formatRobotPolicy( $policy );
681 if( isset( $policy['index'] ) ) {
682 $this->setIndexPolicy( $policy['index'] );
684 if( isset( $policy['follow'] ) ) {
685 $this->setFollowPolicy( $policy['follow'] );
690 * Set the index policy for the page, but leave the follow policy un-
693 * @param $policy string Either 'index' or 'noindex'.
696 public function setIndexPolicy( $policy ) {
697 $policy = trim( $policy );
698 if( in_array( $policy, array( 'index', 'noindex' ) ) ) {
699 $this->mIndexPolicy
= $policy;
704 * Set the follow policy for the page, but leave the index policy un-
707 * @param $policy String: either 'follow' or 'nofollow'.
710 public function setFollowPolicy( $policy ) {
711 $policy = trim( $policy );
712 if( in_array( $policy, array( 'follow', 'nofollow' ) ) ) {
713 $this->mFollowPolicy
= $policy;
718 * Set the new value of the "action text", this will be added to the
719 * "HTML title", separated from it with " - ".
721 * @param $text String: new value of the "action text"
723 public function setPageTitleActionText( $text ) {
724 $this->mPageTitleActionText
= $text;
728 * Get the value of the "action text"
732 public function getPageTitleActionText() {
733 if ( isset( $this->mPageTitleActionText
) ) {
734 return $this->mPageTitleActionText
;
739 * "HTML title" means the contents of <title>.
740 * It is stored as plain, unescaped text and will be run through htmlspecialchars in the skin file.
742 * @param $name string
744 public function setHTMLTitle( $name ) {
745 $this->mHTMLtitle
= $name;
749 * Return the "HTML title", i.e. the content of the <title> tag.
753 public function getHTMLTitle() {
754 return $this->mHTMLtitle
;
758 * "Page title" means the contents of \<h1\>. It is stored as a valid HTML fragment.
759 * This function allows good tags like \<sup\> in the \<h1\> tag, but not bad tags like \<script\>.
760 * This function automatically sets \<title\> to the same content as \<h1\> but with all tags removed.
761 * Bad tags that were escaped in \<h1\> will still be escaped in \<title\>, and good tags like \<i\> will be dropped entirely.
763 * @param $name string
765 public function setPageTitle( $name ) {
766 # change "<script>foo&bar</script>" to "<script>foo&bar</script>"
767 # but leave "<i>foobar</i>" alone
768 $nameWithTags = Sanitizer
::normalizeCharReferences( Sanitizer
::removeHTMLtags( $name ) );
769 $this->mPagetitle
= $nameWithTags;
771 # change "<i>foo&bar</i>" to "foo&bar"
772 $this->setHTMLTitle( wfMsg( 'pagetitle', Sanitizer
::stripAllTags( $nameWithTags ) ) );
776 * Return the "page title", i.e. the content of the \<h1\> tag.
780 public function getPageTitle() {
781 return $this->mPagetitle
;
785 * Get the RequestContext used in this instance
787 * @return RequestContext
789 private function getContext() {
790 if ( !isset($this->mContext
) ) {
791 wfDebug( __METHOD__
. " called and \$mContext is null. Using RequestContext::getMain(); for sanity\n" );
792 $this->mContext
= RequestContext
::getMain();
794 return $this->mContext
;
798 * Get the WebRequest being used for this instance
803 public function getRequest() {
804 return $this->getContext()->getRequest();
808 * Set the Title object to use
810 * @param $t Title object
812 public function setTitle( $t ) {
813 $this->getContext()->setTitle( $t );
817 * Get the Title object used in this instance
821 public function getTitle() {
822 return $this->getContext()->getTitle();
826 * Get the User object used in this instance
831 public function getUser() {
832 return $this->getContext()->getUser();
836 * Get the Skin object used to render this instance
841 public function getSkin() {
842 return $this->getContext()->getSkin();
846 * Replace the subtile with $str
848 * @param $str String: new value of the subtitle
850 public function setSubtitle( $str ) {
851 $this->mSubtitle
= /*$this->parse(*/ $str /*)*/; // @bug 2514
855 * Add $str to the subtitle
857 * @param $str String to add to the subtitle
859 public function appendSubtitle( $str ) {
860 $this->mSubtitle
.= /*$this->parse(*/ $str /*)*/; // @bug 2514
868 public function getSubtitle() {
869 return $this->mSubtitle
;
873 * Set the page as printable, i.e. it'll be displayed with with all
874 * print styles included
876 public function setPrintable() {
877 $this->mPrintable
= true;
881 * Return whether the page is "printable"
885 public function isPrintable() {
886 return $this->mPrintable
;
890 * Disable output completely, i.e. calling output() will have no effect
892 public function disable() {
893 $this->mDoNothing
= true;
897 * Return whether the output will be completely disabled
901 public function isDisabled() {
902 return $this->mDoNothing
;
906 * Show an "add new section" link?
910 public function showNewSectionLink() {
911 return $this->mNewSectionLink
;
915 * Forcibly hide the new section link?
919 public function forceHideNewSectionLink() {
920 return $this->mHideNewSectionLink
;
924 * Add or remove feed links in the page header
925 * This is mainly kept for backward compatibility, see OutputPage::addFeedLink()
926 * for the new version
929 * @param $show Boolean: true: add default feeds, false: remove all feeds
931 public function setSyndicated( $show = true ) {
933 $this->setFeedAppendQuery( false );
935 $this->mFeedLinks
= array();
940 * Add default feeds to the page header
941 * This is mainly kept for backward compatibility, see OutputPage::addFeedLink()
942 * for the new version
945 * @param $val String: query to append to feed links or false to output
948 public function setFeedAppendQuery( $val ) {
949 global $wgAdvertisedFeedTypes;
951 $this->mFeedLinks
= array();
953 foreach ( $wgAdvertisedFeedTypes as $type ) {
954 $query = "feed=$type";
955 if ( is_string( $val ) ) {
956 $query .= '&' . $val;
958 $this->mFeedLinks
[$type] = $this->getTitle()->getLocalURL( $query );
963 * Add a feed link to the page header
965 * @param $format String: feed type, should be a key of $wgFeedClasses
966 * @param $href String: URL
968 public function addFeedLink( $format, $href ) {
969 global $wgAdvertisedFeedTypes;
971 if ( in_array( $format, $wgAdvertisedFeedTypes ) ) {
972 $this->mFeedLinks
[$format] = $href;
977 * Should we output feed links for this page?
980 public function isSyndicated() {
981 return count( $this->mFeedLinks
) > 0;
985 * Return URLs for each supported syndication format for this page.
986 * @return array associating format keys with URLs
988 public function getSyndicationLinks() {
989 return $this->mFeedLinks
;
993 * Will currently always return null
997 public function getFeedAppendQuery() {
998 return $this->mFeedLinksAppendQuery
;
1002 * Set whether the displayed content is related to the source of the
1003 * corresponding article on the wiki
1004 * Setting true will cause the change "article related" toggle to true
1008 public function setArticleFlag( $v ) {
1009 $this->mIsarticle
= $v;
1011 $this->mIsArticleRelated
= $v;
1016 * Return whether the content displayed page is related to the source of
1017 * the corresponding article on the wiki
1021 public function isArticle() {
1022 return $this->mIsarticle
;
1026 * Set whether this page is related an article on the wiki
1027 * Setting false will cause the change of "article flag" toggle to false
1031 public function setArticleRelated( $v ) {
1032 $this->mIsArticleRelated
= $v;
1034 $this->mIsarticle
= false;
1039 * Return whether this page is related an article on the wiki
1043 public function isArticleRelated() {
1044 return $this->mIsArticleRelated
;
1048 * Add new language links
1050 * @param $newLinkArray Associative array mapping language code to the page
1053 public function addLanguageLinks( $newLinkArray ) {
1054 $this->mLanguageLinks +
= $newLinkArray;
1058 * Reset the language links and add new language links
1060 * @param $newLinkArray Associative array mapping language code to the page
1063 public function setLanguageLinks( $newLinkArray ) {
1064 $this->mLanguageLinks
= $newLinkArray;
1068 * Get the list of language links
1070 * @return Array of Interwiki Prefixed (non DB key) Titles (e.g. 'fr:Test page')
1072 public function getLanguageLinks() {
1073 return $this->mLanguageLinks
;
1077 * Add an array of categories, with names in the keys
1079 * @param $categories Array mapping category name => sort key
1081 public function addCategoryLinks( $categories ) {
1084 if ( !is_array( $categories ) ||
count( $categories ) == 0 ) {
1088 # Add the links to a LinkBatch
1089 $arr = array( NS_CATEGORY
=> $categories );
1090 $lb = new LinkBatch
;
1091 $lb->setArray( $arr );
1093 # Fetch existence plus the hiddencat property
1094 $dbr = wfGetDB( DB_SLAVE
);
1095 $res = $dbr->select( array( 'page', 'page_props' ),
1096 array( 'page_id', 'page_namespace', 'page_title', 'page_len', 'page_is_redirect', 'page_latest', 'pp_value' ),
1097 $lb->constructSet( 'page', $dbr ),
1100 array( 'page_props' => array( 'LEFT JOIN', array( 'pp_propname' => 'hiddencat', 'pp_page = page_id' ) ) )
1103 # Add the results to the link cache
1104 $lb->addResultToCache( LinkCache
::singleton(), $res );
1106 # Set all the values to 'normal'. This can be done with array_fill_keys in PHP 5.2.0+
1107 $categories = array_combine(
1108 array_keys( $categories ),
1109 array_fill( 0, count( $categories ), 'normal' )
1112 # Mark hidden categories
1113 foreach ( $res as $row ) {
1114 if ( isset( $row->pp_value
) ) {
1115 $categories[$row->page_title
] = 'hidden';
1119 # Add the remaining categories to the skin
1120 if ( wfRunHooks( 'OutputPageMakeCategoryLinks', array( &$this, $categories, &$this->mCategoryLinks
) ) ) {
1121 foreach ( $categories as $category => $type ) {
1122 $origcategory = $category;
1123 $title = Title
::makeTitleSafe( NS_CATEGORY
, $category );
1124 $wgContLang->findVariantLink( $category, $title, true );
1125 if ( $category != $origcategory ) {
1126 if ( array_key_exists( $category, $categories ) ) {
1130 $text = $wgContLang->convertHtml( $title->getText() );
1131 $this->mCategories
[] = $title->getText();
1132 $this->mCategoryLinks
[$type][] = Linker
::link( $title, $text );
1138 * Reset the category links (but not the category list) and add $categories
1140 * @param $categories Array mapping category name => sort key
1142 public function setCategoryLinks( $categories ) {
1143 $this->mCategoryLinks
= array();
1144 $this->addCategoryLinks( $categories );
1148 * Get the list of category links, in a 2-D array with the following format:
1149 * $arr[$type][] = $link, where $type is either "normal" or "hidden" (for
1150 * hidden categories) and $link a HTML fragment with a link to the category
1155 public function getCategoryLinks() {
1156 return $this->mCategoryLinks
;
1160 * Get the list of category names this page belongs to
1162 * @return Array of strings
1164 public function getCategories() {
1165 return $this->mCategories
;
1169 * Do not allow scripts which can be modified by wiki users to load on this page;
1170 * only allow scripts bundled with, or generated by, the software.
1172 public function disallowUserJs() {
1173 $this->reduceAllowedModules(
1174 ResourceLoaderModule
::TYPE_SCRIPTS
,
1175 ResourceLoaderModule
::ORIGIN_CORE_INDIVIDUAL
1180 * Return whether user JavaScript is allowed for this page
1181 * @deprecated since 1.18 Load modules with ResourceLoader, and origin and
1182 * trustworthiness is identified and enforced automagically.
1185 public function isUserJsAllowed() {
1186 return $this->getAllowedModules( ResourceLoaderModule
::TYPE_SCRIPTS
) >= ResourceLoaderModule
::ORIGIN_USER_INDIVIDUAL
;
1190 * Show what level of JavaScript / CSS untrustworthiness is allowed on this page
1191 * @see ResourceLoaderModule::$origin
1192 * @param $type String ResourceLoaderModule TYPE_ constant
1193 * @return Int ResourceLoaderModule ORIGIN_ class constant
1195 public function getAllowedModules( $type ){
1196 if( $type == ResourceLoaderModule
::TYPE_COMBINED
){
1197 return min( array_values( $this->mAllowedModules
) );
1199 return isset( $this->mAllowedModules
[$type] )
1200 ?
$this->mAllowedModules
[$type]
1201 : ResourceLoaderModule
::ORIGIN_ALL
;
1206 * Set the highest level of CSS/JS untrustworthiness allowed
1207 * @param $type String ResourceLoaderModule TYPE_ constant
1208 * @param $level Int ResourceLoaderModule class constant
1210 public function setAllowedModules( $type, $level ){
1211 $this->mAllowedModules
[$type] = $level;
1215 * As for setAllowedModules(), but don't inadvertantly make the page more accessible
1216 * @param $type String
1217 * @param $level Int ResourceLoaderModule class constant
1219 public function reduceAllowedModules( $type, $level ){
1220 $this->mAllowedModules
[$type] = min( $this->getAllowedModules($type), $level );
1224 * Prepend $text to the body HTML
1226 * @param $text String: HTML
1228 public function prependHTML( $text ) {
1229 $this->mBodytext
= $text . $this->mBodytext
;
1233 * Append $text to the body HTML
1235 * @param $text String: HTML
1237 public function addHTML( $text ) {
1238 $this->mBodytext
.= $text;
1242 * Clear the body HTML
1244 public function clearHTML() {
1245 $this->mBodytext
= '';
1251 * @return String: HTML
1253 public function getHTML() {
1254 return $this->mBodytext
;
1258 * Add $text to the debug output
1260 * @param $text String: debug text
1262 public function debug( $text ) {
1263 $this->mDebugtext
.= $text;
1267 * Get/set the ParserOptions object to use for wikitext parsing
1269 * @param $options either the ParserOption to use or null to only get the
1270 * current ParserOption object
1271 * @return ParserOptions object
1273 public function parserOptions( $options = null ) {
1274 if ( !$this->mParserOptions
) {
1275 $this->mParserOptions
= new ParserOptions
;
1277 return wfSetVar( $this->mParserOptions
, $options );
1281 * Set the revision ID which will be seen by the wiki text parser
1282 * for things such as embedded {{REVISIONID}} variable use.
1284 * @param $revid Mixed: an positive integer, or null
1285 * @return Mixed: previous value
1287 public function setRevisionId( $revid ) {
1288 $val = is_null( $revid ) ?
null : intval( $revid );
1289 return wfSetVar( $this->mRevisionId
, $val );
1293 * Get the current revision ID
1297 public function getRevisionId() {
1298 return $this->mRevisionId
;
1302 * Get the templates used on this page
1304 * @return Array (namespace => dbKey => revId)
1307 public function getTemplateIds() {
1308 return $this->mTemplateIds
;
1312 * Get the files used on this page
1314 * @return Array (dbKey => array('time' => MW timestamp or null, 'sha1' => sha1 or ''))
1317 public function getImageTimeKeys() {
1318 return $this->mImageTimeKeys
;
1322 * Convert wikitext to HTML and add it to the buffer
1323 * Default assumes that the current page title will be used.
1325 * @param $text String
1326 * @param $linestart Boolean: is this the start of a line?
1328 public function addWikiText( $text, $linestart = true ) {
1329 $title = $this->getTitle(); // Work arround E_STRICT
1330 $this->addWikiTextTitle( $text, $title, $linestart );
1334 * Add wikitext with a custom Title object
1336 * @param $text String: wikitext
1337 * @param $title Title object
1338 * @param $linestart Boolean: is this the start of a line?
1340 public function addWikiTextWithTitle( $text, &$title, $linestart = true ) {
1341 $this->addWikiTextTitle( $text, $title, $linestart );
1345 * Add wikitext with a custom Title object and
1347 * @param $text String: wikitext
1348 * @param $title Title object
1349 * @param $linestart Boolean: is this the start of a line?
1351 function addWikiTextTitleTidy( $text, &$title, $linestart = true ) {
1352 $this->addWikiTextTitle( $text, $title, $linestart, true );
1356 * Add wikitext with tidy enabled
1358 * @param $text String: wikitext
1359 * @param $linestart Boolean: is this the start of a line?
1361 public function addWikiTextTidy( $text, $linestart = true ) {
1362 $title = $this->getTitle();
1363 $this->addWikiTextTitleTidy( $text, $title, $linestart );
1367 * Add wikitext with a custom Title object
1369 * @param $text String: wikitext
1370 * @param $title Title object
1371 * @param $linestart Boolean: is this the start of a line?
1372 * @param $tidy Boolean: whether to use tidy
1374 public function addWikiTextTitle( $text, &$title, $linestart, $tidy = false ) {
1377 wfProfileIn( __METHOD__
);
1379 wfIncrStats( 'pcache_not_possible' );
1381 $popts = $this->parserOptions();
1382 $oldTidy = $popts->setTidy( $tidy );
1384 $parserOutput = $wgParser->parse(
1385 $text, $title, $popts,
1386 $linestart, true, $this->mRevisionId
1389 $popts->setTidy( $oldTidy );
1391 $this->addParserOutput( $parserOutput );
1393 wfProfileOut( __METHOD__
);
1397 * Add a ParserOutput object, but without Html
1399 * @param $parserOutput ParserOutput object
1401 public function addParserOutputNoText( &$parserOutput ) {
1402 $this->mLanguageLinks +
= $parserOutput->getLanguageLinks();
1403 $this->addCategoryLinks( $parserOutput->getCategories() );
1404 $this->mNewSectionLink
= $parserOutput->getNewSection();
1405 $this->mHideNewSectionLink
= $parserOutput->getHideNewSection();
1407 $this->mParseWarnings
= $parserOutput->getWarnings();
1408 if ( !$parserOutput->isCacheable() ) {
1409 $this->enableClientCache( false );
1411 $this->mNoGallery
= $parserOutput->getNoGallery();
1412 $this->mHeadItems
= array_merge( $this->mHeadItems
, $parserOutput->getHeadItems() );
1413 $this->addModules( $parserOutput->getModules() );
1415 // Template versioning...
1416 foreach ( (array)$parserOutput->getTemplateIds() as $ns => $dbks ) {
1417 if ( isset( $this->mTemplateIds
[$ns] ) ) {
1418 $this->mTemplateIds
[$ns] = $dbks +
$this->mTemplateIds
[$ns];
1420 $this->mTemplateIds
[$ns] = $dbks;
1423 // File versioning...
1424 foreach ( (array)$parserOutput->getImageTimeKeys() as $dbk => $data ) {
1425 $this->mImageTimeKeys
[$dbk] = $data;
1428 // Hooks registered in the object
1429 global $wgParserOutputHooks;
1430 foreach ( $parserOutput->getOutputHooks() as $hookInfo ) {
1431 list( $hookName, $data ) = $hookInfo;
1432 if ( isset( $wgParserOutputHooks[$hookName] ) ) {
1433 call_user_func( $wgParserOutputHooks[$hookName], $this, $parserOutput, $data );
1437 wfRunHooks( 'OutputPageParserOutput', array( &$this, $parserOutput ) );
1441 * Add a ParserOutput object
1443 * @param $parserOutput ParserOutput
1445 function addParserOutput( &$parserOutput ) {
1446 $this->addParserOutputNoText( $parserOutput );
1447 $text = $parserOutput->getText();
1448 wfRunHooks( 'OutputPageBeforeHTML', array( &$this, &$text ) );
1449 $this->addHTML( $text );
1454 * Add the output of a QuickTemplate to the output buffer
1456 * @param $template QuickTemplate
1458 public function addTemplate( &$template ) {
1460 $template->execute();
1461 $this->addHTML( ob_get_contents() );
1466 * Parse wikitext and return the HTML.
1468 * @param $text String
1469 * @param $linestart Boolean: is this the start of a line?
1470 * @param $interface Boolean: use interface language ($wgLang instead of
1471 * $wgContLang) while parsing language sensitive magic
1472 * words like GRAMMAR and PLURAL
1473 * @param $language Language object: target language object, will override
1475 * @return String: HTML
1477 public function parse( $text, $linestart = true, $interface = false, $language = null ) {
1478 // Check one for one common cause for parser state resetting
1479 $callers = wfGetAllCallers( 10 );
1480 if ( strpos( $callers, 'Parser::extensionSubstitution' ) !== false ) {
1481 throw new MWException( "wfMsg* function with parsing cannot be used " .
1482 "inside a tag hook. Should use parser->recursiveTagParse() instead" );
1487 if( is_null( $this->getTitle() ) ) {
1488 throw new MWException( 'Empty $mTitle in ' . __METHOD__
);
1491 $popts = $this->parserOptions();
1493 $popts->setInterfaceMessage( true );
1495 if ( $language !== null ) {
1496 $oldLang = $popts->setTargetLanguage( $language );
1499 $parserOutput = $wgParser->parse(
1500 $text, $this->getTitle(), $popts,
1501 $linestart, true, $this->mRevisionId
1505 $popts->setInterfaceMessage( false );
1507 if ( $language !== null ) {
1508 $popts->setTargetLanguage( $oldLang );
1511 return $parserOutput->getText();
1515 * Parse wikitext, strip paragraphs, and return the HTML.
1517 * @param $text String
1518 * @param $linestart Boolean: is this the start of a line?
1519 * @param $interface Boolean: use interface language ($wgLang instead of
1520 * $wgContLang) while parsing language sensitive magic
1521 * words like GRAMMAR and PLURAL
1522 * @return String: HTML
1524 public function parseInline( $text, $linestart = true, $interface = false ) {
1525 $parsed = $this->parse( $text, $linestart, $interface );
1528 if ( preg_match( '/^<p>(.*)\n?<\/p>\n?/sU', $parsed, $m ) ) {
1536 * Set the value of the "s-maxage" part of the "Cache-control" HTTP header
1538 * @param $maxage Integer: maximum cache time on the Squid, in seconds.
1540 public function setSquidMaxage( $maxage ) {
1541 $this->mSquidMaxage
= $maxage;
1545 * Use enableClientCache(false) to force it to send nocache headers
1547 * @param $state bool
1551 public function enableClientCache( $state ) {
1552 return wfSetVar( $this->mEnableClientCache
, $state );
1556 * Get the list of cookies that will influence on the cache
1560 function getCacheVaryCookies() {
1561 global $wgCookiePrefix, $wgCacheVaryCookies;
1563 if ( $cookies === null ) {
1564 $cookies = array_merge(
1566 "{$wgCookiePrefix}Token",
1567 "{$wgCookiePrefix}LoggedOut",
1572 wfRunHooks( 'GetCacheVaryCookies', array( $this, &$cookies ) );
1578 * Return whether this page is not cacheable because "useskin" or "uselang"
1579 * URL parameters were passed.
1583 function uncacheableBecauseRequestVars() {
1584 $request = $this->getRequest();
1585 return $request->getText( 'useskin', false ) === false
1586 && $request->getText( 'uselang', false ) === false;
1590 * Check if the request has a cache-varying cookie header
1591 * If it does, it's very important that we don't allow public caching
1595 function haveCacheVaryCookies() {
1596 $cookieHeader = $this->getRequest()->getHeader( 'cookie' );
1597 if ( $cookieHeader === false ) {
1600 $cvCookies = $this->getCacheVaryCookies();
1601 foreach ( $cvCookies as $cookieName ) {
1602 # Check for a simple string match, like the way squid does it
1603 if ( strpos( $cookieHeader, $cookieName ) !== false ) {
1604 wfDebug( __METHOD__
. ": found $cookieName\n" );
1608 wfDebug( __METHOD__
. ": no cache-varying cookies found\n" );
1613 * Add an HTTP header that will influence on the cache
1615 * @param $header String: header name
1616 * @param $option Array|null
1617 * @todo FIXME: Document the $option parameter; it appears to be for
1618 * X-Vary-Options but what format is acceptable?
1620 public function addVaryHeader( $header, $option = null ) {
1621 if ( !array_key_exists( $header, $this->mVaryHeader
) ) {
1622 $this->mVaryHeader
[$header] = (array)$option;
1623 } elseif( is_array( $option ) ) {
1624 if( is_array( $this->mVaryHeader
[$header] ) ) {
1625 $this->mVaryHeader
[$header] = array_merge( $this->mVaryHeader
[$header], $option );
1627 $this->mVaryHeader
[$header] = $option;
1630 $this->mVaryHeader
[$header] = array_unique( $this->mVaryHeader
[$header] );
1634 * Get a complete X-Vary-Options header
1638 public function getXVO() {
1639 $cvCookies = $this->getCacheVaryCookies();
1641 $cookiesOption = array();
1642 foreach ( $cvCookies as $cookieName ) {
1643 $cookiesOption[] = 'string-contains=' . $cookieName;
1645 $this->addVaryHeader( 'Cookie', $cookiesOption );
1648 foreach( $this->mVaryHeader
as $header => $option ) {
1649 $newheader = $header;
1650 if( is_array( $option ) ) {
1651 $newheader .= ';' . implode( ';', $option );
1653 $headers[] = $newheader;
1655 $xvo = 'X-Vary-Options: ' . implode( ',', $headers );
1661 * bug 21672: Add Accept-Language to Vary and XVO headers
1662 * if there's no 'variant' parameter existed in GET.
1665 * /w/index.php?title=Main_page should always be served; but
1666 * /w/index.php?title=Main_page&variant=zh-cn should never be served.
1668 function addAcceptLanguage() {
1670 if( !$this->getRequest()->getCheck( 'variant' ) && $wgContLang->hasVariants() ) {
1671 $variants = $wgContLang->getVariants();
1672 $aloption = array();
1673 foreach ( $variants as $variant ) {
1674 if( $variant === $wgContLang->getCode() ) {
1677 $aloption[] = 'string-contains=' . $variant;
1679 // IE and some other browsers use another form of language code
1680 // in their Accept-Language header, like "zh-CN" or "zh-TW".
1681 // We should handle these too.
1682 $ievariant = explode( '-', $variant );
1683 if ( count( $ievariant ) == 2 ) {
1684 $ievariant[1] = strtoupper( $ievariant[1] );
1685 $ievariant = implode( '-', $ievariant );
1686 $aloption[] = 'string-contains=' . $ievariant;
1690 $this->addVaryHeader( 'Accept-Language', $aloption );
1695 * Set a flag which will cause an X-Frame-Options header appropriate for
1696 * edit pages to be sent. The header value is controlled by
1697 * $wgEditPageFrameOptions.
1699 * This is the default for special pages. If you display a CSRF-protected
1700 * form on an ordinary view page, then you need to call this function.
1702 * @param $enable bool
1704 public function preventClickjacking( $enable = true ) {
1705 $this->mPreventClickjacking
= $enable;
1709 * Turn off frame-breaking. Alias for $this->preventClickjacking(false).
1710 * This can be called from pages which do not contain any CSRF-protected
1713 public function allowClickjacking() {
1714 $this->mPreventClickjacking
= false;
1718 * Get the X-Frame-Options header value (without the name part), or false
1719 * if there isn't one. This is used by Skin to determine whether to enable
1720 * JavaScript frame-breaking, for clients that don't support X-Frame-Options.
1724 public function getFrameOptions() {
1725 global $wgBreakFrames, $wgEditPageFrameOptions;
1726 if ( $wgBreakFrames ) {
1728 } elseif ( $this->mPreventClickjacking
&& $wgEditPageFrameOptions ) {
1729 return $wgEditPageFrameOptions;
1734 * Send cache control HTTP headers
1736 public function sendCacheControl() {
1737 global $wgUseSquid, $wgUseESI, $wgUseETag, $wgSquidMaxage, $wgUseXVO;
1739 $response = $this->getRequest()->response();
1740 if ( $wgUseETag && $this->mETag
) {
1741 $response->header( "ETag: $this->mETag" );
1744 $this->addAcceptLanguage();
1746 # don't serve compressed data to clients who can't handle it
1747 # maintain different caches for logged-in users and non-logged in ones
1748 $response->header( 'Vary: ' . join( ', ', array_keys( $this->mVaryHeader
) ) );
1751 # Add an X-Vary-Options header for Squid with Wikimedia patches
1752 $response->header( $this->getXVO() );
1755 if( !$this->uncacheableBecauseRequestVars() && $this->mEnableClientCache
) {
1757 $wgUseSquid && session_id() == '' && !$this->isPrintable() &&
1758 $this->mSquidMaxage
!= 0 && !$this->haveCacheVaryCookies()
1762 # We'll purge the proxy cache explicitly, but require end user agents
1763 # to revalidate against the proxy on each visit.
1764 # Surrogate-Control controls our Squid, Cache-Control downstream caches
1765 wfDebug( __METHOD__
. ": proxy caching with ESI; {$this->mLastModified} **\n", false );
1766 # start with a shorter timeout for initial testing
1767 # header( 'Surrogate-Control: max-age=2678400+2678400, content="ESI/1.0"');
1768 $response->header( 'Surrogate-Control: max-age='.$wgSquidMaxage.'+'.$this->mSquidMaxage
.', content="ESI/1.0"');
1769 $response->header( 'Cache-Control: s-maxage=0, must-revalidate, max-age=0' );
1771 # We'll purge the proxy cache for anons explicitly, but require end user agents
1772 # to revalidate against the proxy on each visit.
1773 # IMPORTANT! The Squid needs to replace the Cache-Control header with
1774 # Cache-Control: s-maxage=0, must-revalidate, max-age=0
1775 wfDebug( __METHOD__
. ": local proxy caching; {$this->mLastModified} **\n", false );
1776 # start with a shorter timeout for initial testing
1777 # header( "Cache-Control: s-maxage=2678400, must-revalidate, max-age=0" );
1778 $response->header( 'Cache-Control: s-maxage='.$this->mSquidMaxage
.', must-revalidate, max-age=0' );
1781 # We do want clients to cache if they can, but they *must* check for updates
1782 # on revisiting the page.
1783 wfDebug( __METHOD__
. ": private caching; {$this->mLastModified} **\n", false );
1784 $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
1785 $response->header( "Cache-Control: private, must-revalidate, max-age=0" );
1787 if($this->mLastModified
) {
1788 $response->header( "Last-Modified: {$this->mLastModified}" );
1791 wfDebug( __METHOD__
. ": no caching **\n", false );
1793 # In general, the absence of a last modified header should be enough to prevent
1794 # the client from using its cache. We send a few other things just to make sure.
1795 $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
1796 $response->header( 'Cache-Control: no-cache, no-store, max-age=0, must-revalidate' );
1797 $response->header( 'Pragma: no-cache' );
1802 * Get the message associed with the HTTP response code $code
1804 * @param $code Integer: status code
1805 * @return String or null: message or null if $code is not in the list of
1808 public static function getStatusMessage( $code ) {
1809 static $statusMessage = array(
1811 101 => 'Switching Protocols',
1812 102 => 'Processing',
1816 203 => 'Non-Authoritative Information',
1817 204 => 'No Content',
1818 205 => 'Reset Content',
1819 206 => 'Partial Content',
1820 207 => 'Multi-Status',
1821 300 => 'Multiple Choices',
1822 301 => 'Moved Permanently',
1825 304 => 'Not Modified',
1827 307 => 'Temporary Redirect',
1828 400 => 'Bad Request',
1829 401 => 'Unauthorized',
1830 402 => 'Payment Required',
1833 405 => 'Method Not Allowed',
1834 406 => 'Not Acceptable',
1835 407 => 'Proxy Authentication Required',
1836 408 => 'Request Timeout',
1839 411 => 'Length Required',
1840 412 => 'Precondition Failed',
1841 413 => 'Request Entity Too Large',
1842 414 => 'Request-URI Too Large',
1843 415 => 'Unsupported Media Type',
1844 416 => 'Request Range Not Satisfiable',
1845 417 => 'Expectation Failed',
1846 422 => 'Unprocessable Entity',
1848 424 => 'Failed Dependency',
1849 500 => 'Internal Server Error',
1850 501 => 'Not Implemented',
1851 502 => 'Bad Gateway',
1852 503 => 'Service Unavailable',
1853 504 => 'Gateway Timeout',
1854 505 => 'HTTP Version Not Supported',
1855 507 => 'Insufficient Storage'
1857 return isset( $statusMessage[$code] ) ?
$statusMessage[$code] : null;
1861 * Finally, all the text has been munged and accumulated into
1862 * the object, let's actually output it:
1864 public function output() {
1865 global $wgLanguageCode, $wgDebugRedirects, $wgMimeType;
1867 if( $this->mDoNothing
) {
1871 wfProfileIn( __METHOD__
);
1873 $response = $this->getRequest()->response();
1875 if ( $this->mRedirect
!= '' ) {
1876 # Standards require redirect URLs to be absolute
1877 $this->mRedirect
= wfExpandUrl( $this->mRedirect
);
1878 if( $this->mRedirectCode
== '301' ||
$this->mRedirectCode
== '303' ) {
1879 if( !$wgDebugRedirects ) {
1880 $message = self
::getStatusMessage( $this->mRedirectCode
);
1881 $response->header( "HTTP/1.1 {$this->mRedirectCode} $message" );
1883 $this->mLastModified
= wfTimestamp( TS_RFC2822
);
1885 $this->sendCacheControl();
1887 $response->header( "Content-Type: text/html; charset=utf-8" );
1888 if( $wgDebugRedirects ) {
1889 $url = htmlspecialchars( $this->mRedirect
);
1890 print "<html>\n<head>\n<title>Redirect</title>\n</head>\n<body>\n";
1891 print "<p>Location: <a href=\"$url\">$url</a></p>\n";
1892 print "</body>\n</html>\n";
1894 $response->header( 'Location: ' . $this->mRedirect
);
1896 wfProfileOut( __METHOD__
);
1898 } elseif ( $this->mStatusCode
) {
1899 $message = self
::getStatusMessage( $this->mStatusCode
);
1901 $response->header( 'HTTP/1.1 ' . $this->mStatusCode
. ' ' . $message );
1905 # Buffer output; final headers may depend on later processing
1908 $response->header( "Content-type: $wgMimeType; charset=UTF-8" );
1909 $response->header( 'Content-language: ' . $wgLanguageCode );
1911 // Prevent framing, if requested
1912 $frameOptions = $this->getFrameOptions();
1913 if ( $frameOptions ) {
1914 $response->header( "X-Frame-Options: $frameOptions" );
1917 if ( $this->mArticleBodyOnly
) {
1918 $this->out( $this->mBodytext
);
1920 $this->addDefaultModules();
1922 $sk = $this->getSkin();
1924 // Hook that allows last minute changes to the output page, e.g.
1925 // adding of CSS or Javascript by extensions.
1926 wfRunHooks( 'BeforePageDisplay', array( &$this, &$sk ) );
1928 wfProfileIn( 'Output-skin' );
1929 $sk->outputPage( $this );
1930 wfProfileOut( 'Output-skin' );
1933 $this->sendCacheControl();
1935 wfProfileOut( __METHOD__
);
1939 * Actually output something with print().
1941 * @param $ins String: the string to output
1943 public function out( $ins ) {
1948 * Produce a "user is blocked" page.
1949 * @deprecated since 1.18
1951 function blockedPage() {
1952 throw new UserBlockedError( $this->getUser()->mBlock
);
1956 * Output a standard error page
1958 * @param $title String: message key for page title
1959 * @param $msg String: message key for page text
1960 * @param $params Array: message parameters
1962 public function showErrorPage( $title, $msg, $params = array() ) {
1963 if ( $this->getTitle() ) {
1964 $this->mDebugtext
.= 'Original title: ' . $this->getTitle()->getPrefixedText() . "\n";
1966 $this->setPageTitle( wfMsg( $title ) );
1967 $this->setHTMLTitle( wfMsg( 'errorpagetitle' ) );
1968 $this->setRobotPolicy( 'noindex,nofollow' );
1969 $this->setArticleRelated( false );
1970 $this->enableClientCache( false );
1971 $this->mRedirect
= '';
1972 $this->mBodytext
= '';
1974 $this->addWikiMsgArray( $msg, $params );
1976 $this->returnToMain();
1980 * Output a standard permission error page
1982 * @param $errors Array: error message keys
1983 * @param $action String: action that was denied or null if unknown
1985 public function showPermissionsErrorPage( $errors, $action = null ) {
1986 $this->mDebugtext
.= 'Original title: ' .
1987 $this->getTitle()->getPrefixedText() . "\n";
1988 $this->setPageTitle( wfMsg( 'permissionserrors' ) );
1989 $this->setHTMLTitle( wfMsg( 'permissionserrors' ) );
1990 $this->setRobotPolicy( 'noindex,nofollow' );
1991 $this->setArticleRelated( false );
1992 $this->enableClientCache( false );
1993 $this->mRedirect
= '';
1994 $this->mBodytext
= '';
1995 $this->addWikiText( $this->formatPermissionsErrorMessage( $errors, $action ) );
1999 * Display an error page indicating that a given version of MediaWiki is
2000 * required to use it
2002 * @param $version Mixed: the version of MediaWiki needed to use the page
2004 public function versionRequired( $version ) {
2005 $this->setPageTitle( wfMsg( 'versionrequired', $version ) );
2006 $this->setHTMLTitle( wfMsg( 'versionrequired', $version ) );
2007 $this->setRobotPolicy( 'noindex,nofollow' );
2008 $this->setArticleRelated( false );
2009 $this->mBodytext
= '';
2011 $this->addWikiMsg( 'versionrequiredtext', $version );
2012 $this->returnToMain();
2016 * Display an error page noting that a given permission bit is required.
2017 * @deprecated since 1.18, just throw the exception directly
2018 * @param $permission String: key required
2020 public function permissionRequired( $permission ) {
2021 throw new PermissionsError( $permission );
2025 * Produce the stock "please login to use the wiki" page
2027 public function loginToUse() {
2028 if( $this->getUser()->isLoggedIn() ) {
2029 throw new PermissionsError( 'read' );
2032 $this->setPageTitle( wfMsg( 'loginreqtitle' ) );
2033 $this->setHtmlTitle( wfMsg( 'errorpagetitle' ) );
2034 $this->setRobotPolicy( 'noindex,nofollow' );
2035 $this->setArticleRelated( false );
2037 $loginTitle = SpecialPage
::getTitleFor( 'Userlogin' );
2038 $loginLink = Linker
::link(
2040 wfMsgHtml( 'loginreqlink' ),
2042 array( 'returnto' => $this->getTitle()->getPrefixedText() ),
2043 array( 'known', 'noclasses' )
2045 $this->addWikiMsgArray( 'loginreqpagetext', array( $loginLink ), array( 'replaceafter' ) );
2046 $this->addHTML( "\n<!--" . $this->getTitle()->getPrefixedUrl() . '-->' );
2048 # Don't return to the main page if the user can't read it
2049 # otherwise we'll end up in a pointless loop
2050 $mainPage = Title
::newMainPage();
2051 if( $mainPage->userCanRead() ) {
2052 $this->returnToMain( null, $mainPage );
2057 * Format a list of error messages
2059 * @param $errors Array of arrays returned by Title::getUserPermissionsErrors
2060 * @param $action String: action that was denied or null if unknown
2061 * @return String: the wikitext error-messages, formatted into a list.
2063 public function formatPermissionsErrorMessage( $errors, $action = null ) {
2064 if ( $action == null ) {
2065 $text = wfMsgNoTrans( 'permissionserrorstext', count( $errors ) ) . "\n\n";
2067 $action_desc = wfMsgNoTrans( "action-$action" );
2068 $text = wfMsgNoTrans(
2069 'permissionserrorstext-withaction',
2075 if ( count( $errors ) > 1 ) {
2076 $text .= '<ul class="permissions-errors">' . "\n";
2078 foreach( $errors as $error ) {
2080 $text .= call_user_func_array( 'wfMsgNoTrans', $error );
2085 $text .= "<div class=\"permissions-errors\">\n" .
2086 call_user_func_array( 'wfMsgNoTrans', reset( $errors ) ) .
2094 * Display a page stating that the Wiki is in read-only mode,
2095 * and optionally show the source of the page that the user
2096 * was trying to edit. Should only be called (for this
2097 * purpose) after wfReadOnly() has returned true.
2099 * For historical reasons, this function is _also_ used to
2100 * show the error message when a user tries to edit a page
2101 * they are not allowed to edit. (Unless it's because they're
2102 * blocked, then we show blockedPage() instead.) In this
2103 * case, the second parameter should be set to true and a list
2104 * of reasons supplied as the third parameter.
2106 * @todo Needs to be split into multiple functions.
2108 * @param $source String: source code to show (or null).
2109 * @param $protected Boolean: is this a permissions error?
2110 * @param $reasons Array: list of reasons for this error, as returned by Title::getUserPermissionsErrors().
2111 * @param $action String: action that was denied or null if unknown
2113 public function readOnlyPage( $source = null, $protected = false, $reasons = array(), $action = null ) {
2114 $this->setRobotPolicy( 'noindex,nofollow' );
2115 $this->setArticleRelated( false );
2117 // If no reason is given, just supply a default "I can't let you do
2118 // that, Dave" message. Should only occur if called by legacy code.
2119 if ( $protected && empty( $reasons ) ) {
2120 $reasons[] = array( 'badaccess-group0' );
2123 if ( !empty( $reasons ) ) {
2124 // Permissions error
2126 $this->setPageTitle( wfMsg( 'viewsource' ) );
2128 wfMsg( 'viewsourcefor', Linker
::linkKnown( $this->getTitle() ) )
2131 $this->setPageTitle( wfMsg( 'badaccess' ) );
2133 $this->addWikiText( $this->formatPermissionsErrorMessage( $reasons, $action ) );
2135 // Wiki is read only
2136 throw new ReadOnlyError
;
2139 // Show source, if supplied
2140 if( is_string( $source ) ) {
2141 $this->addWikiMsg( 'viewsourcetext' );
2144 'id' => 'wpTextbox1',
2145 'name' => 'wpTextbox1',
2146 'cols' => $this->getUser()->getOption( 'cols' ),
2147 'rows' => $this->getUser()->getOption( 'rows' ),
2148 'readonly' => 'readonly'
2150 $this->addHTML( Html
::element( 'textarea', $params, $source ) );
2152 // Show templates used by this article
2153 $article = new Article( $this->getTitle() );
2154 $templates = Linker
::formatTemplates( $article->getUsedTemplates() );
2155 $this->addHTML( "<div class='templatesUsed'>
2161 # If the title doesn't exist, it's fairly pointless to print a return
2162 # link to it. After all, you just tried editing it and couldn't, so
2163 # what's there to do there?
2164 if( $this->getTitle()->exists() ) {
2165 $this->returnToMain( null, $this->getTitle() );
2170 * Turn off regular page output and return an error reponse
2171 * for when rate limiting has triggered.
2173 public function rateLimited() {
2174 throw new ThrottledError
;
2178 * Show a warning about slave lag
2180 * If the lag is higher than $wgSlaveLagCritical seconds,
2181 * then the warning is a bit more obvious. If the lag is
2182 * lower than $wgSlaveLagWarning, then no warning is shown.
2184 * @param $lag Integer: slave lag
2186 public function showLagWarning( $lag ) {
2187 global $wgSlaveLagWarning, $wgSlaveLagCritical;
2188 if( $lag >= $wgSlaveLagWarning ) {
2189 $message = $lag < $wgSlaveLagCritical
2192 $wrap = Html
::rawElement( 'div', array( 'class' => "mw-{$message}" ), "\n$1\n" );
2193 $this->wrapWikiMsg( "$wrap\n", array( $message, $this->getContext()->getLang()->formatNum( $lag ) ) );
2197 public function showFatalError( $message ) {
2198 $this->setPageTitle( wfMsg( 'internalerror' ) );
2199 $this->setRobotPolicy( 'noindex,nofollow' );
2200 $this->setArticleRelated( false );
2201 $this->enableClientCache( false );
2202 $this->mRedirect
= '';
2203 $this->mBodytext
= $message;
2206 public function showUnexpectedValueError( $name, $val ) {
2207 $this->showFatalError( wfMsg( 'unexpected', $name, $val ) );
2210 public function showFileCopyError( $old, $new ) {
2211 $this->showFatalError( wfMsg( 'filecopyerror', $old, $new ) );
2214 public function showFileRenameError( $old, $new ) {
2215 $this->showFatalError( wfMsg( 'filerenameerror', $old, $new ) );
2218 public function showFileDeleteError( $name ) {
2219 $this->showFatalError( wfMsg( 'filedeleteerror', $name ) );
2222 public function showFileNotFoundError( $name ) {
2223 $this->showFatalError( wfMsg( 'filenotfound', $name ) );
2227 * Add a "return to" link pointing to a specified title
2229 * @param $title Title to link
2230 * @param $query String query string
2231 * @param $text String text of the link (input is not escaped)
2233 public function addReturnTo( $title, $query = array(), $text = null ) {
2234 $this->addLink( array( 'rel' => 'next', 'href' => $title->getFullURL() ) );
2237 Linker
::link( $title, $text, array(), $query )
2239 $this->addHTML( "<p id=\"mw-returnto\">{$link}</p>\n" );
2243 * Add a "return to" link pointing to a specified title,
2244 * or the title indicated in the request, or else the main page
2246 * @param $unused No longer used
2247 * @param $returnto Title or String to return to
2248 * @param $returntoquery String: query string for the return to link
2250 public function returnToMain( $unused = null, $returnto = null, $returntoquery = null ) {
2251 if ( $returnto == null ) {
2252 $returnto = $this->getRequest()->getText( 'returnto' );
2255 if ( $returntoquery == null ) {
2256 $returntoquery = $this->getRequest()->getText( 'returntoquery' );
2259 if ( $returnto === '' ) {
2260 $returnto = Title
::newMainPage();
2263 if ( is_object( $returnto ) ) {
2264 $titleObj = $returnto;
2266 $titleObj = Title
::newFromText( $returnto );
2268 if ( !is_object( $titleObj ) ) {
2269 $titleObj = Title
::newMainPage();
2272 $this->addReturnTo( $titleObj, $returntoquery );
2276 * @param $sk Skin The given Skin
2277 * @param $includeStyle Boolean: unused
2278 * @return String: The doctype, opening <html>, and head element.
2280 public function headElement( Skin
$sk, $includeStyle = true ) {
2281 global $wgUseTrackbacks;
2283 if ( $sk->commonPrintStylesheet() ) {
2284 $this->addModuleStyles( 'mediawiki.legacy.wikiprintable' );
2286 $sk->setupUserCss( $this );
2289 $ret = Html
::htmlHeader( array( 'lang' => $lang->getCode(), 'dir' => $lang->getDir() ) );
2291 if ( $this->getHTMLTitle() == '' ) {
2292 $this->setHTMLTitle( wfMsg( 'pagetitle', $this->getPageTitle() ) );
2295 $openHead = Html
::openElement( 'head' );
2297 # Don't bother with the newline if $head == ''
2298 $ret .= "$openHead\n";
2301 $ret .= Html
::element( 'title', null, $this->getHTMLTitle() ) . "\n";
2303 $ret .= implode( "\n", array(
2304 $this->getHeadLinks( $sk, true ),
2305 $this->buildCssLinks( $sk ),
2306 $this->getHeadScripts( $sk ),
2307 $this->getHeadItems()
2310 if ( $wgUseTrackbacks && $this->isArticleRelated() ) {
2311 $ret .= $this->getTitle()->trackbackRDF();
2314 $closeHead = Html
::closeElement( 'head' );
2316 $ret .= "$closeHead\n";
2319 $bodyAttrs = array();
2321 # Crazy edit-on-double-click stuff
2322 $action = $this->getRequest()->getVal( 'action', 'view' );
2325 $this->getTitle()->getNamespace() != NS_SPECIAL
&&
2326 in_array( $action, array( 'view', 'purge' ) ) &&
2327 $this->getUser()->getOption( 'editondblclick' )
2330 $editUrl = $this->getTitle()->getLocalUrl( $sk->editUrlOptions() );
2331 $bodyAttrs['ondblclick'] = "document.location = '" .
2332 Xml
::escapeJsString( $editUrl ) . "'";
2336 $dir = wfUILang()->getDir();
2337 $bodyAttrs['class'] = "mediawiki $dir";
2339 if ( $this->getContext()->getLang()->capitalizeAllNouns() ) {
2340 # A <body> class is probably not the best way to do this . . .
2341 $bodyAttrs['class'] .= ' capitalize-all-nouns';
2343 $bodyAttrs['class'] .= ' ' . $sk->getPageClasses( $this->getTitle() );
2344 $bodyAttrs['class'] .= ' skin-' . Sanitizer
::escapeClass( $sk->getSkinName() );
2346 $sk->addToBodyAttributes( $this, $bodyAttrs ); // Allow skins to add body attributes they need
2347 wfRunHooks( 'OutputPageBodyAttributes', array( $this, $sk, &$bodyAttrs ) );
2349 $ret .= Html
::openElement( 'body', $bodyAttrs ) . "\n";
2355 * Add the default ResourceLoader modules to this object
2357 private function addDefaultModules() {
2358 global $wgIncludeLegacyJavaScript,
2359 $wgUseAjax, $wgAjaxWatch, $wgEnableMWSuggest;
2361 // Add base resources
2362 $this->addModules( array(
2365 'mediawiki.page.startup',
2366 'mediawiki.page.ready',
2368 if ( $wgIncludeLegacyJavaScript ){
2369 $this->addModules( 'mediawiki.legacy.wikibits' );
2372 // Add various resources if required
2374 $this->addModules( 'mediawiki.legacy.ajax' );
2376 wfRunHooks( 'AjaxAddScript', array( &$this ) );
2378 if( $wgAjaxWatch && $this->getUser()->isLoggedIn() ) {
2379 $this->addModules( 'mediawiki.action.watch.ajax' );
2382 if ( $wgEnableMWSuggest && !$this->getUser()->getOption( 'disablesuggest', false ) ) {
2383 $this->addModules( 'mediawiki.legacy.mwsuggest' );
2387 if( $this->getUser()->getBoolOption( 'editsectiononrightclick' ) ) {
2388 $this->addModules( 'mediawiki.action.view.rightClickEdit' );
2393 * Get a ResourceLoader object associated with this OutputPage
2395 * @return ResourceLoader
2397 public function getResourceLoader() {
2398 if ( is_null( $this->mResourceLoader
) ) {
2399 $this->mResourceLoader
= new ResourceLoader();
2401 return $this->mResourceLoader
;
2407 * @param $modules Array/string with the module name
2408 * @param $only String ResourceLoaderModule TYPE_ class constant
2409 * @param $useESI boolean
2410 * @return string html <script> and <style> tags
2412 protected function makeResourceLoaderLink( Skin
$skin, $modules, $only, $useESI = false ) {
2413 global $wgLoadScript, $wgResourceLoaderUseESI,
2414 $wgResourceLoaderInlinePrivateModules;
2415 // Lazy-load ResourceLoader
2416 // TODO: Should this be a static function of ResourceLoader instead?
2418 'lang' => $this->getContext()->getLang()->getCode(),
2419 'debug' => ResourceLoader
::inDebugMode() ?
'true' : 'false',
2420 'skin' => $skin->getSkinName(),
2423 // Propagate printable and handheld parameters if present
2424 if ( $this->isPrintable() ) {
2425 $baseQuery['printable'] = 1;
2427 if ( $this->getRequest()->getBool( 'handheld' ) ) {
2428 $baseQuery['handheld'] = 1;
2431 if ( !count( $modules ) ) {
2435 if ( count( $modules ) > 1 ) {
2436 // Remove duplicate module requests
2437 $modules = array_unique( (array) $modules );
2438 // Sort module names so requests are more uniform
2441 if ( ResourceLoader
::inDebugMode() ) {
2442 // Recursively call us for every item
2444 foreach ( $modules as $name ) {
2445 $links .= $this->makeResourceLoaderLink( $skin, $name, $only, $useESI );
2451 // Create keyed-by-group list of module objects from modules list
2453 $resourceLoader = $this->getResourceLoader();
2454 foreach ( (array) $modules as $name ) {
2455 $module = $resourceLoader->getModule( $name );
2456 # Check that we're allowed to include this module on this page
2457 if ( ( $module->getOrigin() > $this->getAllowedModules( ResourceLoaderModule
::TYPE_SCRIPTS
)
2458 && $only == ResourceLoaderModule
::TYPE_SCRIPTS
)
2459 ||
( $module->getOrigin() > $this->getAllowedModules( ResourceLoaderModule
::TYPE_STYLES
)
2460 && $only == ResourceLoaderModule
::TYPE_STYLES
)
2466 $group = $module->getGroup();
2467 if ( !isset( $groups[$group] ) ) {
2468 $groups[$group] = array();
2470 $groups[$group][$name] = $module;
2474 foreach ( $groups as $group => $modules ) {
2475 $query = $baseQuery;
2476 // Special handling for user-specific groups
2477 if ( ( $group === 'user' ||
$group === 'private' ) && $this->getUser()->isLoggedIn() ) {
2478 $query['user'] = $this->getUser()->getName();
2481 // Create a fake request based on the one we are about to make so modules return
2482 // correct timestamp and emptiness data
2483 $context = new ResourceLoaderContext( $resourceLoader, new FauxRequest( $query ) );
2484 // Drop modules that know they're empty
2485 foreach ( $modules as $key => $module ) {
2486 if ( $module->isKnownEmpty( $context ) ) {
2487 unset( $modules[$key] );
2490 // If there are no modules left, skip this group
2491 if ( $modules === array() ) {
2495 $query['modules'] = ResourceLoader
::makePackedModulesString( array_keys( $modules ) );
2497 // Support inlining of private modules if configured as such
2498 if ( $group === 'private' && $wgResourceLoaderInlinePrivateModules ) {
2499 if ( $only == ResourceLoaderModule
::TYPE_STYLES
) {
2500 $links .= Html
::inlineStyle(
2501 $resourceLoader->makeModuleResponse( $context, $modules )
2504 $links .= Html
::inlineScript(
2505 ResourceLoader
::makeLoaderConditionalScript(
2506 $resourceLoader->makeModuleResponse( $context, $modules )
2512 // Special handling for the user group; because users might change their stuff
2513 // on-wiki like user pages, or user preferences; we need to find the highest
2514 // timestamp of these user-changable modules so we can ensure cache misses on change
2515 // This should NOT be done for the site group (bug 27564) because anons get that too
2516 // and we shouldn't be putting timestamps in Squid-cached HTML
2517 if ( $group === 'user' ) {
2518 // Get the maximum timestamp
2520 foreach ( $modules as $module ) {
2521 $timestamp = max( $timestamp, $module->getModifiedTime( $context ) );
2523 // Add a version parameter so cache will break when things change
2524 $query['version'] = wfTimestamp( TS_ISO_8601_BASIC
, $timestamp );
2526 // Make queries uniform in order
2529 $url = wfAppendQuery( $wgLoadScript, $query );
2530 // Prevent the IE6 extension check from being triggered (bug 28840)
2531 // by appending a character that's invalid in Windows extensions ('*')
2533 if ( $useESI && $wgResourceLoaderUseESI ) {
2534 $esi = Xml
::element( 'esi:include', array( 'src' => $url ) );
2535 if ( $only == ResourceLoaderModule
::TYPE_STYLES
) {
2536 $link = Html
::inlineStyle( $esi );
2538 $link = Html
::inlineScript( $esi );
2541 // Automatically select style/script elements
2542 if ( $only === ResourceLoaderModule
::TYPE_STYLES
) {
2543 $link = Html
::linkedStyle( $url );
2545 $link = Html
::linkedScript( $url );
2549 if( $group == 'noscript' ){
2550 $links .= Html
::rawElement( 'noscript', array(), $link ) . "\n";
2552 $links .= $link . "\n";
2559 * JS stuff to put in the <head>. This is the startup module, config
2560 * vars and modules marked with position 'top'
2562 * @param $sk Skin object to use
2563 * @return String: HTML fragment
2565 function getHeadScripts( Skin
$sk ) {
2566 // Startup - this will immediately load jquery and mediawiki modules
2567 $scripts = $this->makeResourceLoaderLink( $sk, 'startup', ResourceLoaderModule
::TYPE_SCRIPTS
, true );
2569 // Load config before anything else
2570 $scripts .= Html
::inlineScript(
2571 ResourceLoader
::makeLoaderConditionalScript(
2572 ResourceLoader
::makeConfigSetScript( $this->getJSVars() )
2576 // Script and Messages "only" requests marked for top inclusion
2577 // Messages should go first
2578 $scripts .= $this->makeResourceLoaderLink( $sk, $this->getModuleMessages( true, 'top' ), ResourceLoaderModule
::TYPE_MESSAGES
);
2579 $scripts .= $this->makeResourceLoaderLink( $sk, $this->getModuleScripts( true, 'top' ), ResourceLoaderModule
::TYPE_SCRIPTS
);
2581 // Modules requests - let the client calculate dependencies and batch requests as it likes
2582 // Only load modules that have marked themselves for loading at the top
2583 $modules = $this->getModules( true, 'top' );
2585 $scripts .= Html
::inlineScript(
2586 ResourceLoader
::makeLoaderConditionalScript(
2587 Xml
::encodeJsCall( 'mw.loader.load', array( $modules ) )
2596 * JS stuff to put at the bottom of the <body>: modules marked with position 'bottom',
2597 * legacy scripts ($this->mScripts), user preferences, site JS and user JS
2603 function getBottomScripts( Skin
$sk ) {
2604 global $wgUseSiteJs, $wgAllowUserJs;
2606 // Script and Messages "only" requests marked for bottom inclusion
2607 // Messages should go first
2608 $scripts = $this->makeResourceLoaderLink( $sk, $this->getModuleMessages( true, 'bottom' ), ResourceLoaderModule
::TYPE_MESSAGES
);
2609 $scripts .= $this->makeResourceLoaderLink( $sk, $this->getModuleScripts( true, 'bottom' ), ResourceLoaderModule
::TYPE_SCRIPTS
);
2611 // Modules requests - let the client calculate dependencies and batch requests as it likes
2612 // Only load modules that have marked themselves for loading at the bottom
2613 $modules = $this->getModules( true, 'bottom' );
2615 $scripts .= Html
::inlineScript(
2616 ResourceLoader
::makeLoaderConditionalScript(
2617 Xml
::encodeJsCall( 'mw.loader.load', array( $modules ) )
2623 $scripts .= "\n" . $this->mScripts
;
2625 $userScripts = array( 'user.options', 'user.tokens' );
2627 // Add site JS if enabled
2628 if ( $wgUseSiteJs ) {
2629 $scripts .= $this->makeResourceLoaderLink( $sk, 'site', ResourceLoaderModule
::TYPE_SCRIPTS
);
2630 if( $this->getUser()->isLoggedIn() ){
2631 $userScripts[] = 'user.groups';
2635 // Add user JS if enabled
2636 if ( $wgAllowUserJs && $this->getUser()->isLoggedIn() ) {
2637 $action = $this->getRequest()->getVal( 'action', 'view' );
2638 if( $this->getTitle() && $this->getTitle()->isJsSubpage() && $sk->userCanPreview( $action ) ) {
2639 # XXX: additional security check/prompt?
2640 $scripts .= Html
::inlineScript( "\n" . $this->getRequest()->getText( 'wpTextbox1' ) . "\n" ) . "\n";
2642 # @todo FIXME: This means that User:Me/Common.js doesn't load when previewing
2643 # User:Me/Vector.js, and vice versa (bug26283)
2644 $userScripts[] = 'user';
2647 $scripts .= $this->makeResourceLoaderLink( $sk, $userScripts, ResourceLoaderModule
::TYPE_SCRIPTS
);
2653 * Get an array containing global JS variables
2655 * Do not add things here which can be evaluated in
2656 * ResourceLoaderStartupScript - in other words, without state.
2657 * You will only be adding bloat to the page and causing page caches to
2658 * have to be purged on configuration changes.
2660 protected function getJSVars() {
2661 global $wgUseAjax, $wgEnableMWSuggest, $wgContLang;
2663 $title = $this->getTitle();
2664 $ns = $title->getNamespace();
2665 $nsname = MWNamespace
::exists( $ns ) ? MWNamespace
::getCanonicalName( $ns ) : $title->getNsText();
2666 if ( $ns == NS_SPECIAL
) {
2667 list( $canonicalName, /*...*/ ) = SpecialPageFactory
::resolveAlias( $title->getDBkey() );
2669 $canonicalName = false; # bug 21115
2673 'wgCanonicalNamespace' => $nsname,
2674 'wgCanonicalSpecialPageName' => $canonicalName,
2675 'wgNamespaceNumber' => $title->getNamespace(),
2676 'wgPageName' => $title->getPrefixedDBKey(),
2677 'wgTitle' => $title->getText(),
2678 'wgCurRevisionId' => $title->getLatestRevID(),
2679 'wgArticleId' => $title->getArticleId(),
2680 'wgIsArticle' => $this->isArticle(),
2681 'wgAction' => $this->getRequest()->getText( 'action', 'view' ),
2682 'wgUserName' => $this->getUser()->isAnon() ?
null : $this->getUser()->getName(),
2683 'wgUserGroups' => $this->getUser()->getEffectiveGroups(),
2684 'wgCategories' => $this->getCategories(),
2685 'wgBreakFrames' => $this->getFrameOptions() == 'DENY',
2687 if ( $wgContLang->hasVariants() ) {
2688 $vars['wgUserVariant'] = $wgContLang->getPreferredVariant();
2690 foreach ( $title->getRestrictionTypes() as $type ) {
2691 $vars['wgRestriction' . ucfirst( $type )] = $title->getRestrictions( $type );
2693 if ( $wgUseAjax && $wgEnableMWSuggest && !$this->getUser()->getOption( 'disablesuggest', false ) ) {
2694 $vars['wgSearchNamespaces'] = SearchEngine
::userNamespaces( $this->getUser() );
2696 if ( $title->isMainPage() ) {
2697 $vars['wgIsMainPage'] = true;
2700 // Allow extensions to add their custom variables to the global JS variables
2701 wfRunHooks( 'MakeGlobalVariablesScript', array( &$vars ) );
2708 * @param $addContentType bool
2710 * @return string HTML tag links to be put in the header.
2712 public function getHeadLinks( Skin
$sk, $addContentType = false ) {
2713 global $wgUniversalEditButton, $wgFavicon, $wgAppleTouchIcon, $wgEnableAPI,
2714 $wgSitename, $wgVersion, $wgHtml5, $wgMimeType,
2715 $wgFeed, $wgOverrideSiteFeed, $wgAdvertisedFeedTypes,
2716 $wgDisableLangConversion, $wgCanonicalLanguageLinks, $wgContLang,
2717 $wgRightsPage, $wgRightsUrl;
2721 if ( $addContentType ) {
2723 # More succinct than <meta http-equiv=Content-Type>, has the
2725 $tags[] = Html
::element( 'meta', array( 'charset' => 'UTF-8' ) );
2727 $tags[] = Html
::element( 'meta', array(
2728 'http-equiv' => 'Content-Type',
2729 'content' => "$wgMimeType; charset=UTF-8"
2731 $tags[] = Html
::element( 'meta', array( // bug 15835
2732 'http-equiv' => 'Content-Style-Type',
2733 'content' => 'text/css'
2738 $tags[] = Html
::element( 'meta', array(
2739 'name' => 'generator',
2740 'content' => "MediaWiki $wgVersion",
2743 $p = "{$this->mIndexPolicy},{$this->mFollowPolicy}";
2744 if( $p !== 'index,follow' ) {
2745 // http://www.robotstxt.org/wc/meta-user.html
2746 // Only show if it's different from the default robots policy
2747 $tags[] = Html
::element( 'meta', array(
2753 if ( count( $this->mKeywords
) > 0 ) {
2755 "/<.*?" . ">/" => '',
2758 $tags[] = Html
::element( 'meta', array(
2759 'name' => 'keywords',
2760 'content' => preg_replace(
2761 array_keys( $strip ),
2762 array_values( $strip ),
2763 implode( ',', $this->mKeywords
)
2768 foreach ( $this->mMetatags
as $tag ) {
2769 if ( 0 == strcasecmp( 'http:', substr( $tag[0], 0, 5 ) ) ) {
2771 $tag[0] = substr( $tag[0], 5 );
2775 $tags[] = Html
::element( 'meta',
2778 'content' => $tag[1]
2783 foreach ( $this->mLinktags
as $tag ) {
2784 $tags[] = Html
::element( 'link', $tag );
2787 # Universal edit button
2788 if ( $wgUniversalEditButton ) {
2789 if ( $this->isArticleRelated() && $this->getTitle() && $this->getTitle()->quickUserCan( 'edit' )
2790 && ( $this->getTitle()->exists() ||
$this->getTitle()->quickUserCan( 'create' ) ) ) {
2791 // Original UniversalEditButton
2792 $msg = wfMsg( 'edit' );
2793 $tags[] = Html
::element( 'link', array(
2794 'rel' => 'alternate',
2795 'type' => 'application/x-wiki',
2797 'href' => $this->getTitle()->getLocalURL( 'action=edit' )
2799 // Alternate edit link
2800 $tags[] = Html
::element( 'link', array(
2803 'href' => $this->getTitle()->getLocalURL( 'action=edit' )
2808 # Generally the order of the favicon and apple-touch-icon links
2809 # should not matter, but Konqueror (3.5.9 at least) incorrectly
2810 # uses whichever one appears later in the HTML source. Make sure
2811 # apple-touch-icon is specified first to avoid this.
2812 if ( $wgAppleTouchIcon !== false ) {
2813 $tags[] = Html
::element( 'link', array( 'rel' => 'apple-touch-icon', 'href' => $wgAppleTouchIcon ) );
2816 if ( $wgFavicon !== false ) {
2817 $tags[] = Html
::element( 'link', array( 'rel' => 'shortcut icon', 'href' => $wgFavicon ) );
2820 # OpenSearch description link
2821 $tags[] = Html
::element( 'link', array(
2823 'type' => 'application/opensearchdescription+xml',
2824 'href' => wfScript( 'opensearch_desc' ),
2825 'title' => wfMsgForContent( 'opensearch-desc' ),
2828 if ( $wgEnableAPI ) {
2829 # Real Simple Discovery link, provides auto-discovery information
2830 # for the MediaWiki API (and potentially additional custom API
2831 # support such as WordPress or Twitter-compatible APIs for a
2832 # blogging extension, etc)
2833 $tags[] = Html
::element( 'link', array(
2835 'type' => 'application/rsd+xml',
2836 'href' => wfExpandUrl( wfAppendQuery( wfScript( 'api' ), array( 'action' => 'rsd' ) ) ),
2841 if ( !$wgDisableLangConversion && $wgCanonicalLanguageLinks
2842 && $wgContLang->hasVariants() ) {
2844 $urlvar = $wgContLang->getURLVariant();
2847 $variants = $wgContLang->getVariants();
2848 foreach ( $variants as $_v ) {
2849 $tags[] = Html
::element( 'link', array(
2850 'rel' => 'alternate',
2852 'href' => $this->getTitle()->getLocalURL( '', $_v ) )
2856 $tags[] = Html
::element( 'link', array(
2857 'rel' => 'canonical',
2858 'href' => $this->getTitle()->getFullURL() )
2865 if ( $wgRightsPage ) {
2866 $copy = Title
::newFromText( $wgRightsPage );
2869 $copyright = $copy->getLocalURL();
2873 if ( !$copyright && $wgRightsUrl ) {
2874 $copyright = $wgRightsUrl;
2878 $tags[] = Html
::element( 'link', array(
2879 'rel' => 'copyright',
2880 'href' => $copyright )
2886 foreach( $this->getSyndicationLinks() as $format => $link ) {
2887 # Use the page name for the title. In principle, this could
2888 # lead to issues with having the same name for different feeds
2889 # corresponding to the same page, but we can't avoid that at
2892 $tags[] = $this->feedLink(
2895 # Used messages: 'page-rss-feed' and 'page-atom-feed' (for an easier grep)
2896 wfMsg( "page-{$format}-feed", $this->getTitle()->getPrefixedText() )
2900 # Recent changes feed should appear on every page (except recentchanges,
2901 # that would be redundant). Put it after the per-page feed to avoid
2902 # changing existing behavior. It's still available, probably via a
2903 # menu in your browser. Some sites might have a different feed they'd
2904 # like to promote instead of the RC feed (maybe like a "Recent New Articles"
2905 # or "Breaking news" one). For this, we see if $wgOverrideSiteFeed is defined.
2906 # If so, use it instead.
2908 $rctitle = SpecialPage
::getTitleFor( 'Recentchanges' );
2910 if ( $wgOverrideSiteFeed ) {
2911 foreach ( $wgOverrideSiteFeed as $type => $feedUrl ) {
2912 $tags[] = $this->feedLink(
2914 htmlspecialchars( $feedUrl ),
2915 wfMsg( "site-{$type}-feed", $wgSitename )
2918 } elseif ( $this->getTitle()->getPrefixedText() != $rctitle->getPrefixedText() ) {
2919 foreach ( $wgAdvertisedFeedTypes as $format ) {
2920 $tags[] = $this->feedLink(
2922 $rctitle->getLocalURL( "feed={$format}" ),
2923 wfMsg( "site-{$format}-feed", $wgSitename ) # For grep: 'site-rss-feed', 'site-atom-feed'.
2928 return implode( "\n", $tags );
2932 * Generate a <link rel/> for a feed.
2934 * @param $type String: feed type
2935 * @param $url String: URL to the feed
2936 * @param $text String: value of the "title" attribute
2937 * @return String: HTML fragment
2939 private function feedLink( $type, $url, $text ) {
2940 return Html
::element( 'link', array(
2941 'rel' => 'alternate',
2942 'type' => "application/$type+xml",
2949 * Add a local or specified stylesheet, with the given media options.
2950 * Meant primarily for internal use...
2952 * @param $style String: URL to the file
2953 * @param $media String: to specify a media type, 'screen', 'printable', 'handheld' or any.
2954 * @param $condition String: for IE conditional comments, specifying an IE version
2955 * @param $dir String: set to 'rtl' or 'ltr' for direction-specific sheets
2957 public function addStyle( $style, $media = '', $condition = '', $dir = '' ) {
2959 // Even though we expect the media type to be lowercase, but here we
2960 // force it to lowercase to be safe.
2962 $options['media'] = $media;
2965 $options['condition'] = $condition;
2968 $options['dir'] = $dir;
2970 $this->styles
[$style] = $options;
2974 * Adds inline CSS styles
2975 * @param $style_css Mixed: inline CSS
2977 public function addInlineStyle( $style_css ){
2978 $this->mInlineStyles
.= Html
::inlineStyle( $style_css );
2982 * Build a set of <link>s for the stylesheets specified in the $this->styles array.
2983 * These will be applied to various media & IE conditionals.
2984 * @param $sk Skin object
2988 public function buildCssLinks( $sk ) {
2990 // Add ResourceLoader styles
2991 // Split the styles into four groups
2992 $styles = array( 'other' => array(), 'user' => array(), 'site' => array(), 'private' => array(), 'noscript' => array() );
2993 $resourceLoader = $this->getResourceLoader();
2994 foreach ( $this->getModuleStyles() as $name ) {
2995 $group = $resourceLoader->getModule( $name )->getGroup();
2996 // Modules in groups named "other" or anything different than "user", "site" or "private"
2997 // will be placed in the "other" group
2998 $styles[isset( $styles[$group] ) ?
$group : 'other'][] = $name;
3001 // We want site, private and user styles to override dynamically added styles from modules, but we want
3002 // dynamically added styles to override statically added styles from other modules. So the order
3003 // has to be other, dynamic, site, private, user
3004 // Add statically added styles for other modules
3005 $ret .= $this->makeResourceLoaderLink( $sk, $styles['other'], ResourceLoaderModule
::TYPE_STYLES
);
3006 // Add normal styles added through addStyle()/addInlineStyle() here
3007 $ret .= implode( "\n", $this->buildCssLinksArray() ) . $this->mInlineStyles
;
3008 // Add marker tag to mark the place where the client-side loader should inject dynamic styles
3009 // We use a <meta> tag with a made-up name for this because that's valid HTML
3010 $ret .= Html
::element( 'meta', array( 'name' => 'ResourceLoaderDynamicStyles', 'content' => '' ) ) . "\n";
3012 // Add site, private and user styles
3013 // 'private' at present only contains user.options, so put that before 'user'
3014 // Any future private modules will likely have a similar user-specific character
3015 foreach ( array( 'site', 'noscript', 'private', 'user' ) as $group ) {
3016 $ret .= $this->makeResourceLoaderLink( $sk, $styles[$group],
3017 ResourceLoaderModule
::TYPE_STYLES
3023 public function buildCssLinksArray() {
3025 foreach( $this->styles
as $file => $options ) {
3026 $link = $this->styleLink( $file, $options );
3028 $links[$file] = $link;
3035 * Generate \<link\> tags for stylesheets
3037 * @param $style String: URL to the file
3038 * @param $options Array: option, can contain 'condition', 'dir', 'media'
3040 * @return String: HTML fragment
3042 protected function styleLink( $style, $options ) {
3043 if( isset( $options['dir'] ) ) {
3044 $siteDir = wfUILang()->getDir();
3045 if( $siteDir != $options['dir'] ) {
3050 if( isset( $options['media'] ) ) {
3051 $media = self
::transformCssMedia( $options['media'] );
3052 if( is_null( $media ) ) {
3059 if( substr( $style, 0, 1 ) == '/' ||
3060 substr( $style, 0, 5 ) == 'http:' ||
3061 substr( $style, 0, 6 ) == 'https:' ) {
3064 global $wgStylePath, $wgStyleVersion;
3065 $url = $wgStylePath . '/' . $style . '?' . $wgStyleVersion;
3068 $link = Html
::linkedStyle( $url, $media );
3070 if( isset( $options['condition'] ) ) {
3071 $condition = htmlspecialchars( $options['condition'] );
3072 $link = "<!--[if $condition]>$link<![endif]-->";
3078 * Transform "media" attribute based on request parameters
3080 * @param $media String: current value of the "media" attribute
3081 * @return String: modified value of the "media" attribute
3083 public static function transformCssMedia( $media ) {
3084 global $wgRequest, $wgHandheldForIPhone;
3086 // Switch in on-screen display for media testing
3088 'printable' => 'print',
3089 'handheld' => 'handheld',
3091 foreach( $switches as $switch => $targetMedia ) {
3092 if( $wgRequest->getBool( $switch ) ) {
3093 if( $media == $targetMedia ) {
3095 } elseif( $media == 'screen' ) {
3101 // Expand longer media queries as iPhone doesn't grok 'handheld'
3102 if( $wgHandheldForIPhone ) {
3103 $mediaAliases = array(
3104 'screen' => 'screen and (min-device-width: 481px)',
3105 'handheld' => 'handheld, only screen and (max-device-width: 480px)',
3108 if( isset( $mediaAliases[$media] ) ) {
3109 $media = $mediaAliases[$media];
3117 * Add a wikitext-formatted message to the output.
3118 * This is equivalent to:
3120 * $wgOut->addWikiText( wfMsgNoTrans( ... ) )
3122 public function addWikiMsg( /*...*/ ) {
3123 $args = func_get_args();
3124 $name = array_shift( $args );
3125 $this->addWikiMsgArray( $name, $args );
3129 * Add a wikitext-formatted message to the output.
3130 * Like addWikiMsg() except the parameters are taken as an array
3131 * instead of a variable argument list.
3133 * $options is passed through to wfMsgExt(), see that function for details.
3135 * @param $name string
3136 * @param $args array
3137 * @param $options array
3139 public function addWikiMsgArray( $name, $args, $options = array() ) {
3140 $options[] = 'parse';
3141 $text = wfMsgExt( $name, $options, $args );
3142 $this->addHTML( $text );
3146 * This function takes a number of message/argument specifications, wraps them in
3147 * some overall structure, and then parses the result and adds it to the output.
3149 * In the $wrap, $1 is replaced with the first message, $2 with the second, and so
3150 * on. The subsequent arguments may either be strings, in which case they are the
3151 * message names, or arrays, in which case the first element is the message name,
3152 * and subsequent elements are the parameters to that message.
3154 * The special named parameter 'options' in a message specification array is passed
3155 * through to the $options parameter of wfMsgExt().
3157 * Don't use this for messages that are not in users interface language.
3161 * $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>", 'some-error' );
3165 * $wgOut->addWikiText( "<div class='error'>\n" . wfMsgNoTrans( 'some-error' ) . "\n</div>" );
3167 * The newline after opening div is needed in some wikitext. See bug 19226.
3169 * @param $wrap string
3171 public function wrapWikiMsg( $wrap /*, ...*/ ) {
3172 $msgSpecs = func_get_args();
3173 array_shift( $msgSpecs );
3174 $msgSpecs = array_values( $msgSpecs );
3176 foreach ( $msgSpecs as $n => $spec ) {
3178 if ( is_array( $spec ) ) {
3180 $name = array_shift( $args );
3181 if ( isset( $args['options'] ) ) {
3182 $options = $args['options'];
3183 unset( $args['options'] );
3189 $s = str_replace( '$' . ( $n +
1 ), wfMsgExt( $name, $options, $args ), $s );
3191 $this->addWikiText( $s );
3195 * Include jQuery core. Use this to avoid loading it multiple times
3196 * before we get a usable script loader.
3198 * @param $modules Array: list of jQuery modules which should be loaded
3199 * @return Array: the list of modules which were not loaded.
3201 * @deprecated since 1.17
3203 public function includeJQuery( $modules = array() ) {