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 HTTP1/1 protocols 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 private 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
396 protected function filterModules( $modules, $position = null, $type = ResourceLoaderModule
::TYPE_COMBINED
){
397 $resourceLoader = $this->getResourceLoader();
398 $filteredModules = array();
399 foreach( $modules as $val ){
400 $module = $resourceLoader->getModule( $val );
401 if( $module instanceof ResourceLoaderModule
402 && $module->getOrigin() <= $this->getAllowedModules( $type )
403 && ( is_null( $position ) ||
$module->getPosition() == $position ) )
405 $filteredModules[] = $val;
408 return $filteredModules;
412 * Get the list of modules to include on this page
414 * @param $filter Bool whether to filter out insufficiently trustworthy modules
415 * @param $position String if not null, only return modules with this position
416 * @return Array of module names
418 public function getModules( $filter = false, $position = null, $param = 'mModules' ) {
419 $modules = array_values( array_unique( $this->$param ) );
421 ?
$this->filterModules( $modules, $position )
426 * Add one or more modules recognized by the resource loader. Modules added
427 * through this function will be loaded by the resource loader when the
430 * @param $modules Mixed: module name (string) or array of module names
432 public function addModules( $modules ) {
433 $this->mModules
= array_merge( $this->mModules
, (array)$modules );
437 * Get the list of module JS to include on this page
438 * @return array of module names
440 public function getModuleScripts( $filter = false, $position = null ) {
441 return $this->getModules( $filter, $position, 'mModuleScripts' );
445 * Add only JS of one or more modules recognized by the resource loader. Module
446 * scripts added through this function will be loaded by the resource loader when
449 * @param $modules Mixed: module name (string) or array of module names
451 public function addModuleScripts( $modules ) {
452 $this->mModuleScripts
= array_merge( $this->mModuleScripts
, (array)$modules );
456 * Get the list of module CSS to include on this page
458 * @return Array of module names
460 public function getModuleStyles( $filter = false, $position = null ) {
461 return $this->getModules( $filter, $position, 'mModuleStyles' );
465 * Add only CSS of one or more modules recognized by the resource loader. Module
466 * styles added through this function will be loaded by the resource loader when
469 * @param $modules Mixed: module name (string) or array of module names
471 public function addModuleStyles( $modules ) {
472 $this->mModuleStyles
= array_merge( $this->mModuleStyles
, (array)$modules );
476 * Get the list of module messages to include on this page
478 * @return Array of module names
480 public function getModuleMessages( $filter = false, $position = null ) {
481 return $this->getModules( $filter, $position, 'mModuleMessages' );
485 * Add only messages of one or more modules recognized by the resource loader.
486 * Module messages added through this function will be loaded by the resource
487 * loader when the page loads.
489 * @param $modules Mixed: module name (string) or array of module names
491 public function addModuleMessages( $modules ) {
492 $this->mModuleMessages
= array_merge( $this->mModuleMessages
, (array)$modules );
496 * Get all header items in a string
500 function getHeadItems() {
502 foreach ( $this->mHeadItems
as $item ) {
509 * Add or replace an header item to the output
511 * @param $name String: item name
512 * @param $value String: raw HTML
514 public function addHeadItem( $name, $value ) {
515 $this->mHeadItems
[$name] = $value;
519 * Check if the header item $name is already set
521 * @param $name String: item name
524 public function hasHeadItem( $name ) {
525 return isset( $this->mHeadItems
[$name] );
529 * Set the value of the ETag HTTP header, only used if $wgUseETag is true
531 * @param $tag String: value of "ETag" header
533 function setETag( $tag ) {
538 * Set whether the output should only contain the body of the article,
539 * without any skin, sidebar, etc.
540 * Used e.g. when calling with "action=render".
542 * @param $only Boolean: whether to output only the body of the article
544 public function setArticleBodyOnly( $only ) {
545 $this->mArticleBodyOnly
= $only;
549 * Return whether the output will contain only the body of the article
553 public function getArticleBodyOnly() {
554 return $this->mArticleBodyOnly
;
558 * checkLastModified tells the client to use the client-cached page if
559 * possible. If sucessful, the OutputPage is disabled so that
560 * any future call to OutputPage->output() have no effect.
562 * Side effect: sets mLastModified for Last-Modified header
564 * @return Boolean: true iff cache-ok headers was sent.
566 public function checkLastModified( $timestamp ) {
567 global $wgCachePages, $wgCacheEpoch;
569 if ( !$timestamp ||
$timestamp == '19700101000000' ) {
570 wfDebug( __METHOD__
. ": CACHE DISABLED, NO TIMESTAMP\n" );
573 if( !$wgCachePages ) {
574 wfDebug( __METHOD__
. ": CACHE DISABLED\n", false );
577 if( $this->getUser()->getOption( 'nocache' ) ) {
578 wfDebug( __METHOD__
. ": USER DISABLED CACHE\n", false );
582 $timestamp = wfTimestamp( TS_MW
, $timestamp );
583 $modifiedTimes = array(
584 'page' => $timestamp,
585 'user' => $this->getUser()->getTouched(),
586 'epoch' => $wgCacheEpoch
588 wfRunHooks( 'OutputPageCheckLastModified', array( &$modifiedTimes ) );
590 $maxModified = max( $modifiedTimes );
591 $this->mLastModified
= wfTimestamp( TS_RFC2822
, $maxModified );
593 if( empty( $_SERVER['HTTP_IF_MODIFIED_SINCE'] ) ) {
594 wfDebug( __METHOD__
. ": client did not send If-Modified-Since header\n", false );
600 foreach ( $modifiedTimes as $name => $value ) {
601 if ( $info !== '' ) {
604 $info .= "$name=" . wfTimestamp( TS_ISO_8601
, $value );
607 # IE sends sizes after the date like this:
608 # Wed, 20 Aug 2003 06:51:19 GMT; length=5202
609 # this breaks strtotime().
610 $clientHeader = preg_replace( '/;.*$/', '', $_SERVER["HTTP_IF_MODIFIED_SINCE"] );
612 wfSuppressWarnings(); // E_STRICT system time bitching
613 $clientHeaderTime = strtotime( $clientHeader );
615 if ( !$clientHeaderTime ) {
616 wfDebug( __METHOD__
. ": unable to parse the client's If-Modified-Since header: $clientHeader\n" );
619 $clientHeaderTime = wfTimestamp( TS_MW
, $clientHeaderTime );
621 wfDebug( __METHOD__
. ": client sent If-Modified-Since: " .
622 wfTimestamp( TS_ISO_8601
, $clientHeaderTime ) . "\n", false );
623 wfDebug( __METHOD__
. ": effective Last-Modified: " .
624 wfTimestamp( TS_ISO_8601
, $maxModified ) . "\n", false );
625 if( $clientHeaderTime < $maxModified ) {
626 wfDebug( __METHOD__
. ": STALE, $info\n", false );
631 # Give a 304 response code and disable body output
632 wfDebug( __METHOD__
. ": NOT MODIFIED, $info\n", false );
633 ini_set( 'zlib.output_compression', 0 );
634 $this->getRequest()->response()->header( "HTTP/1.1 304 Not Modified" );
635 $this->sendCacheControl();
638 // Don't output a compressed blob when using ob_gzhandler;
639 // it's technically against HTTP spec and seems to confuse
640 // Firefox when the response gets split over two packets.
641 wfClearOutputBuffers();
647 * Override the last modified timestamp
649 * @param $timestamp String: new timestamp, in a format readable by
652 public function setLastModified( $timestamp ) {
653 $this->mLastModified
= wfTimestamp( TS_RFC2822
, $timestamp );
657 * Set the robot policy for the page: <http://www.robotstxt.org/meta.html>
659 * @param $policy String: the literal string to output as the contents of
660 * the meta tag. Will be parsed according to the spec and output in
664 public function setRobotPolicy( $policy ) {
665 $policy = Article
::formatRobotPolicy( $policy );
667 if( isset( $policy['index'] ) ) {
668 $this->setIndexPolicy( $policy['index'] );
670 if( isset( $policy['follow'] ) ) {
671 $this->setFollowPolicy( $policy['follow'] );
676 * Set the index policy for the page, but leave the follow policy un-
679 * @param $policy string Either 'index' or 'noindex'.
682 public function setIndexPolicy( $policy ) {
683 $policy = trim( $policy );
684 if( in_array( $policy, array( 'index', 'noindex' ) ) ) {
685 $this->mIndexPolicy
= $policy;
690 * Set the follow policy for the page, but leave the index policy un-
693 * @param $policy String: either 'follow' or 'nofollow'.
696 public function setFollowPolicy( $policy ) {
697 $policy = trim( $policy );
698 if( in_array( $policy, array( 'follow', 'nofollow' ) ) ) {
699 $this->mFollowPolicy
= $policy;
704 * Set the new value of the "action text", this will be added to the
705 * "HTML title", separated from it with " - ".
707 * @param $text String: new value of the "action text"
709 public function setPageTitleActionText( $text ) {
710 $this->mPageTitleActionText
= $text;
714 * Get the value of the "action text"
718 public function getPageTitleActionText() {
719 if ( isset( $this->mPageTitleActionText
) ) {
720 return $this->mPageTitleActionText
;
725 * "HTML title" means the contents of <title>.
726 * It is stored as plain, unescaped text and will be run through htmlspecialchars in the skin file.
728 public function setHTMLTitle( $name ) {
729 $this->mHTMLtitle
= $name;
733 * Return the "HTML title", i.e. the content of the <title> tag.
737 public function getHTMLTitle() {
738 return $this->mHTMLtitle
;
742 * "Page title" means the contents of \<h1\>. It is stored as a valid HTML fragment.
743 * This function allows good tags like \<sup\> in the \<h1\> tag, but not bad tags like \<script\>.
744 * This function automatically sets \<title\> to the same content as \<h1\> but with all tags removed.
745 * Bad tags that were escaped in \<h1\> will still be escaped in \<title\>, and good tags like \<i\> will be dropped entirely.
747 public function setPageTitle( $name ) {
748 # change "<script>foo&bar</script>" to "<script>foo&bar</script>"
749 # but leave "<i>foobar</i>" alone
750 $nameWithTags = Sanitizer
::normalizeCharReferences( Sanitizer
::removeHTMLtags( $name ) );
751 $this->mPagetitle
= $nameWithTags;
753 # change "<i>foo&bar</i>" to "foo&bar"
754 $this->setHTMLTitle( wfMsg( 'pagetitle', Sanitizer
::stripAllTags( $nameWithTags ) ) );
758 * Return the "page title", i.e. the content of the \<h1\> tag.
762 public function getPageTitle() {
763 return $this->mPagetitle
;
767 * Get the RequestContext used in this instance
769 * @return RequestContext
771 private function getContext() {
772 if ( !isset($this->mContext
) ) {
773 wfDebug( __METHOD__
. " called and \$mContext is null. Using RequestContext::getMain(); for sanity\n" );
774 $this->mContext
= RequestContext
::getMain();
776 return $this->mContext
;
780 * Get the WebRequest being used for this instance
785 public function getRequest() {
786 return $this->getContext()->getRequest();
790 * Set the Title object to use
792 * @param $t Title object
794 public function setTitle( $t ) {
795 $this->getContext()->setTitle( $t );
799 * Get the Title object used in this instance
803 public function getTitle() {
804 return $this->getContext()->getTitle();
808 * Get the User object used in this instance
813 public function getUser() {
814 return $this->getContext()->getUser();
818 * Get the Skin object used to render this instance
823 public function getSkin() {
824 return $this->getContext()->getSkin();
828 * Replace the subtile with $str
830 * @param $str String: new value of the subtitle
832 public function setSubtitle( $str ) {
833 $this->mSubtitle
= /*$this->parse(*/ $str /*)*/; // @bug 2514
837 * Add $str to the subtitle
839 * @param $str String to add to the subtitle
841 public function appendSubtitle( $str ) {
842 $this->mSubtitle
.= /*$this->parse(*/ $str /*)*/; // @bug 2514
850 public function getSubtitle() {
851 return $this->mSubtitle
;
855 * Set the page as printable, i.e. it'll be displayed with with all
856 * print styles included
858 public function setPrintable() {
859 $this->mPrintable
= true;
863 * Return whether the page is "printable"
867 public function isPrintable() {
868 return $this->mPrintable
;
872 * Disable output completely, i.e. calling output() will have no effect
874 public function disable() {
875 $this->mDoNothing
= true;
879 * Return whether the output will be completely disabled
883 public function isDisabled() {
884 return $this->mDoNothing
;
888 * Show an "add new section" link?
892 public function showNewSectionLink() {
893 return $this->mNewSectionLink
;
897 * Forcibly hide the new section link?
901 public function forceHideNewSectionLink() {
902 return $this->mHideNewSectionLink
;
906 * Add or remove feed links in the page header
907 * This is mainly kept for backward compatibility, see OutputPage::addFeedLink()
908 * for the new version
911 * @param $show Boolean: true: add default feeds, false: remove all feeds
913 public function setSyndicated( $show = true ) {
915 $this->setFeedAppendQuery( false );
917 $this->mFeedLinks
= array();
922 * Add default feeds to the page header
923 * This is mainly kept for backward compatibility, see OutputPage::addFeedLink()
924 * for the new version
927 * @param $val String: query to append to feed links or false to output
930 public function setFeedAppendQuery( $val ) {
931 global $wgAdvertisedFeedTypes;
933 $this->mFeedLinks
= array();
935 foreach ( $wgAdvertisedFeedTypes as $type ) {
936 $query = "feed=$type";
937 if ( is_string( $val ) ) {
938 $query .= '&' . $val;
940 $this->mFeedLinks
[$type] = $this->getTitle()->getLocalURL( $query );
945 * Add a feed link to the page header
947 * @param $format String: feed type, should be a key of $wgFeedClasses
948 * @param $href String: URL
950 public function addFeedLink( $format, $href ) {
951 global $wgAdvertisedFeedTypes;
953 if ( in_array( $format, $wgAdvertisedFeedTypes ) ) {
954 $this->mFeedLinks
[$format] = $href;
959 * Should we output feed links for this page?
962 public function isSyndicated() {
963 return count( $this->mFeedLinks
) > 0;
967 * Return URLs for each supported syndication format for this page.
968 * @return array associating format keys with URLs
970 public function getSyndicationLinks() {
971 return $this->mFeedLinks
;
975 * Will currently always return null
979 public function getFeedAppendQuery() {
980 return $this->mFeedLinksAppendQuery
;
984 * Set whether the displayed content is related to the source of the
985 * corresponding article on the wiki
986 * Setting true will cause the change "article related" toggle to true
990 public function setArticleFlag( $v ) {
991 $this->mIsarticle
= $v;
993 $this->mIsArticleRelated
= $v;
998 * Return whether the content displayed page is related to the source of
999 * the corresponding article on the wiki
1003 public function isArticle() {
1004 return $this->mIsarticle
;
1008 * Set whether this page is related an article on the wiki
1009 * Setting false will cause the change of "article flag" toggle to false
1013 public function setArticleRelated( $v ) {
1014 $this->mIsArticleRelated
= $v;
1016 $this->mIsarticle
= false;
1021 * Return whether this page is related an article on the wiki
1025 public function isArticleRelated() {
1026 return $this->mIsArticleRelated
;
1030 * Add new language links
1032 * @param $newLinkArray Associative array mapping language code to the page
1035 public function addLanguageLinks( $newLinkArray ) {
1036 $this->mLanguageLinks +
= $newLinkArray;
1040 * Reset the language links and add new language links
1042 * @param $newLinkArray Associative array mapping language code to the page
1045 public function setLanguageLinks( $newLinkArray ) {
1046 $this->mLanguageLinks
= $newLinkArray;
1050 * Get the list of language links
1052 * @return Array of Interwiki Prefixed (non DB key) Titles (e.g. 'fr:Test page')
1054 public function getLanguageLinks() {
1055 return $this->mLanguageLinks
;
1059 * Add an array of categories, with names in the keys
1061 * @param $categories Array mapping category name => sort key
1063 public function addCategoryLinks( $categories ) {
1066 if ( !is_array( $categories ) ||
count( $categories ) == 0 ) {
1070 # Add the links to a LinkBatch
1071 $arr = array( NS_CATEGORY
=> $categories );
1072 $lb = new LinkBatch
;
1073 $lb->setArray( $arr );
1075 # Fetch existence plus the hiddencat property
1076 $dbr = wfGetDB( DB_SLAVE
);
1077 $res = $dbr->select( array( 'page', 'page_props' ),
1078 array( 'page_id', 'page_namespace', 'page_title', 'page_len', 'page_is_redirect', 'page_latest', 'pp_value' ),
1079 $lb->constructSet( 'page', $dbr ),
1082 array( 'page_props' => array( 'LEFT JOIN', array( 'pp_propname' => 'hiddencat', 'pp_page = page_id' ) ) )
1085 # Add the results to the link cache
1086 $lb->addResultToCache( LinkCache
::singleton(), $res );
1088 # Set all the values to 'normal'. This can be done with array_fill_keys in PHP 5.2.0+
1089 $categories = array_combine(
1090 array_keys( $categories ),
1091 array_fill( 0, count( $categories ), 'normal' )
1094 # Mark hidden categories
1095 foreach ( $res as $row ) {
1096 if ( isset( $row->pp_value
) ) {
1097 $categories[$row->page_title
] = 'hidden';
1101 # Add the remaining categories to the skin
1102 if ( wfRunHooks( 'OutputPageMakeCategoryLinks', array( &$this, $categories, &$this->mCategoryLinks
) ) ) {
1103 foreach ( $categories as $category => $type ) {
1104 $origcategory = $category;
1105 $title = Title
::makeTitleSafe( NS_CATEGORY
, $category );
1106 $wgContLang->findVariantLink( $category, $title, true );
1107 if ( $category != $origcategory ) {
1108 if ( array_key_exists( $category, $categories ) ) {
1112 $text = $wgContLang->convertHtml( $title->getText() );
1113 $this->mCategories
[] = $title->getText();
1114 $this->mCategoryLinks
[$type][] = $this->getSkin()->link( $title, $text );
1120 * Reset the category links (but not the category list) and add $categories
1122 * @param $categories Array mapping category name => sort key
1124 public function setCategoryLinks( $categories ) {
1125 $this->mCategoryLinks
= array();
1126 $this->addCategoryLinks( $categories );
1130 * Get the list of category links, in a 2-D array with the following format:
1131 * $arr[$type][] = $link, where $type is either "normal" or "hidden" (for
1132 * hidden categories) and $link a HTML fragment with a link to the category
1137 public function getCategoryLinks() {
1138 return $this->mCategoryLinks
;
1142 * Get the list of category names this page belongs to
1144 * @return Array of strings
1146 public function getCategories() {
1147 return $this->mCategories
;
1151 * Do not allow scripts which can be modified by wiki users to load on this page;
1152 * only allow scripts bundled with, or generated by, the software.
1154 public function disallowUserJs() {
1155 $this->reduceAllowedModules(
1156 ResourceLoaderModule
::TYPE_SCRIPTS
,
1157 ResourceLoaderModule
::ORIGIN_CORE_INDIVIDUAL
1162 * Return whether user JavaScript is allowed for this page
1163 * @deprecated since 1.18 Load modules with ResourceLoader, and origin and
1164 * trustworthiness is identified and enforced automagically.
1167 public function isUserJsAllowed() {
1168 return $this->getAllowedModules( ResourceLoaderModule
::TYPE_SCRIPTS
) >= ResourceLoaderModule
::ORIGIN_USER_INDIVIDUAL
;
1172 * Show what level of JavaScript / CSS untrustworthiness is allowed on this page
1173 * @see ResourceLoaderModule::$origin
1174 * @param $type String ResourceLoaderModule TYPE_ constant
1175 * @return Int ResourceLoaderModule ORIGIN_ class constant
1177 public function getAllowedModules( $type ){
1178 if( $type == ResourceLoaderModule
::TYPE_COMBINED
){
1179 return min( array_values( $this->mAllowedModules
) );
1181 return isset( $this->mAllowedModules
[$type] )
1182 ?
$this->mAllowedModules
[$type]
1183 : ResourceLoaderModule
::ORIGIN_ALL
;
1188 * Set the highest level of CSS/JS untrustworthiness allowed
1189 * @param $type String ResourceLoaderModule TYPE_ constant
1190 * @param $level Int ResourceLoaderModule class constant
1192 public function setAllowedModules( $type, $level ){
1193 $this->mAllowedModules
[$type] = $level;
1197 * As for setAllowedModules(), but don't inadvertantly make the page more accessible
1198 * @param $type String
1199 * @param $level Int ResourceLoaderModule class constant
1201 public function reduceAllowedModules( $type, $level ){
1202 $this->mAllowedModules
[$type] = min( $this->getAllowedModules($type), $level );
1206 * Prepend $text to the body HTML
1208 * @param $text String: HTML
1210 public function prependHTML( $text ) {
1211 $this->mBodytext
= $text . $this->mBodytext
;
1215 * Append $text to the body HTML
1217 * @param $text String: HTML
1219 public function addHTML( $text ) {
1220 $this->mBodytext
.= $text;
1224 * Clear the body HTML
1226 public function clearHTML() {
1227 $this->mBodytext
= '';
1233 * @return String: HTML
1235 public function getHTML() {
1236 return $this->mBodytext
;
1240 * Add $text to the debug output
1242 * @param $text String: debug text
1244 public function debug( $text ) {
1245 $this->mDebugtext
.= $text;
1249 * Get/set the ParserOptions object to use for wikitext parsing
1251 * @param $options either the ParserOption to use or null to only get the
1252 * current ParserOption object
1253 * @return ParserOptions object
1255 public function parserOptions( $options = null ) {
1256 if ( !$this->mParserOptions
) {
1257 $this->mParserOptions
= new ParserOptions
;
1259 return wfSetVar( $this->mParserOptions
, $options );
1263 * Set the revision ID which will be seen by the wiki text parser
1264 * for things such as embedded {{REVISIONID}} variable use.
1266 * @param $revid Mixed: an positive integer, or null
1267 * @return Mixed: previous value
1269 public function setRevisionId( $revid ) {
1270 $val = is_null( $revid ) ?
null : intval( $revid );
1271 return wfSetVar( $this->mRevisionId
, $val );
1275 * Get the current revision ID
1279 public function getRevisionId() {
1280 return $this->mRevisionId
;
1284 * Get the templates used on this page
1286 * @return Array (namespace => dbKey => revId)
1289 public function getTemplateIds() {
1290 return $this->mTemplateIds
;
1294 * Get the files used on this page
1296 * @return Array (dbKey => array('time' => MW timestamp or null, 'sha1' => sha1 or ''))
1299 public function getImageTimeKeys() {
1300 return $this->mImageTimeKeys
;
1304 * Convert wikitext to HTML and add it to the buffer
1305 * Default assumes that the current page title will be used.
1307 * @param $text String
1308 * @param $linestart Boolean: is this the start of a line?
1310 public function addWikiText( $text, $linestart = true ) {
1311 $title = $this->getTitle(); // Work arround E_STRICT
1312 $this->addWikiTextTitle( $text, $title, $linestart );
1316 * Add wikitext with a custom Title object
1318 * @param $text String: wikitext
1319 * @param $title Title object
1320 * @param $linestart Boolean: is this the start of a line?
1322 public function addWikiTextWithTitle( $text, &$title, $linestart = true ) {
1323 $this->addWikiTextTitle( $text, $title, $linestart );
1327 * Add wikitext with a custom Title object and
1329 * @param $text String: wikitext
1330 * @param $title Title object
1331 * @param $linestart Boolean: is this the start of a line?
1333 function addWikiTextTitleTidy( $text, &$title, $linestart = true ) {
1334 $this->addWikiTextTitle( $text, $title, $linestart, true );
1338 * Add wikitext with tidy enabled
1340 * @param $text String: wikitext
1341 * @param $linestart Boolean: is this the start of a line?
1343 public function addWikiTextTidy( $text, $linestart = true ) {
1344 $title = $this->getTitle();
1345 $this->addWikiTextTitleTidy( $text, $title, $linestart );
1349 * Add wikitext with a custom Title object
1351 * @param $text String: wikitext
1352 * @param $title Title object
1353 * @param $linestart Boolean: is this the start of a line?
1354 * @param $tidy Boolean: whether to use tidy
1356 public function addWikiTextTitle( $text, &$title, $linestart, $tidy = false ) {
1359 wfProfileIn( __METHOD__
);
1361 wfIncrStats( 'pcache_not_possible' );
1363 $popts = $this->parserOptions();
1364 $oldTidy = $popts->setTidy( $tidy );
1366 $parserOutput = $wgParser->parse(
1367 $text, $title, $popts,
1368 $linestart, true, $this->mRevisionId
1371 $popts->setTidy( $oldTidy );
1373 $this->addParserOutput( $parserOutput );
1375 wfProfileOut( __METHOD__
);
1379 * Add a ParserOutput object, but without Html
1381 * @param $parserOutput ParserOutput object
1383 public function addParserOutputNoText( &$parserOutput ) {
1384 $this->mLanguageLinks +
= $parserOutput->getLanguageLinks();
1385 $this->addCategoryLinks( $parserOutput->getCategories() );
1386 $this->mNewSectionLink
= $parserOutput->getNewSection();
1387 $this->mHideNewSectionLink
= $parserOutput->getHideNewSection();
1389 $this->mParseWarnings
= $parserOutput->getWarnings();
1390 if ( !$parserOutput->isCacheable() ) {
1391 $this->enableClientCache( false );
1393 $this->mNoGallery
= $parserOutput->getNoGallery();
1394 $this->mHeadItems
= array_merge( $this->mHeadItems
, $parserOutput->getHeadItems() );
1395 $this->addModules( $parserOutput->getModules() );
1397 // Template versioning...
1398 foreach ( (array)$parserOutput->getTemplateIds() as $ns => $dbks ) {
1399 if ( isset( $this->mTemplateIds
[$ns] ) ) {
1400 $this->mTemplateIds
[$ns] = $dbks +
$this->mTemplateIds
[$ns];
1402 $this->mTemplateIds
[$ns] = $dbks;
1405 // File versioning...
1406 foreach ( (array)$parserOutput->getImageTimeKeys() as $dbk => $data ) {
1407 $this->mImageTimeKeys
[$dbk] = $data;
1410 // Hooks registered in the object
1411 global $wgParserOutputHooks;
1412 foreach ( $parserOutput->getOutputHooks() as $hookInfo ) {
1413 list( $hookName, $data ) = $hookInfo;
1414 if ( isset( $wgParserOutputHooks[$hookName] ) ) {
1415 call_user_func( $wgParserOutputHooks[$hookName], $this, $parserOutput, $data );
1419 wfRunHooks( 'OutputPageParserOutput', array( &$this, $parserOutput ) );
1423 * Add a ParserOutput object
1425 * @param $parserOutput ParserOutput
1427 function addParserOutput( &$parserOutput ) {
1428 $this->addParserOutputNoText( $parserOutput );
1429 $text = $parserOutput->getText();
1430 wfRunHooks( 'OutputPageBeforeHTML', array( &$this, &$text ) );
1431 $this->addHTML( $text );
1436 * Add the output of a QuickTemplate to the output buffer
1438 * @param $template QuickTemplate
1440 public function addTemplate( &$template ) {
1442 $template->execute();
1443 $this->addHTML( ob_get_contents() );
1448 * Parse wikitext and return the HTML.
1450 * @param $text String
1451 * @param $linestart Boolean: is this the start of a line?
1452 * @param $interface Boolean: use interface language ($wgLang instead of
1453 * $wgContLang) while parsing language sensitive magic
1454 * words like GRAMMAR and PLURAL
1455 * @param $language Language object: target language object, will override
1457 * @return String: HTML
1459 public function parse( $text, $linestart = true, $interface = false, $language = null ) {
1460 // Check one for one common cause for parser state resetting
1461 $callers = wfGetAllCallers( 10 );
1462 if ( strpos( $callers, 'Parser::extensionSubstitution' ) !== false ) {
1463 throw new MWException( "wfMsg* function with parsing cannot be used " .
1464 "inside a tag hook. Should use parser->recursiveTagParse() instead" );
1469 if( is_null( $this->getTitle() ) ) {
1470 throw new MWException( 'Empty $mTitle in ' . __METHOD__
);
1473 $popts = $this->parserOptions();
1475 $popts->setInterfaceMessage( true );
1477 if ( $language !== null ) {
1478 $oldLang = $popts->setTargetLanguage( $language );
1481 $parserOutput = $wgParser->parse(
1482 $text, $this->getTitle(), $popts,
1483 $linestart, true, $this->mRevisionId
1487 $popts->setInterfaceMessage( false );
1489 if ( $language !== null ) {
1490 $popts->setTargetLanguage( $oldLang );
1493 return $parserOutput->getText();
1497 * Parse wikitext, strip paragraphs, and return the HTML.
1499 * @param $text String
1500 * @param $linestart Boolean: is this the start of a line?
1501 * @param $interface Boolean: use interface language ($wgLang instead of
1502 * $wgContLang) while parsing language sensitive magic
1503 * words like GRAMMAR and PLURAL
1504 * @return String: HTML
1506 public function parseInline( $text, $linestart = true, $interface = false ) {
1507 $parsed = $this->parse( $text, $linestart, $interface );
1510 if ( preg_match( '/^<p>(.*)\n?<\/p>\n?/sU', $parsed, $m ) ) {
1518 * Set the value of the "s-maxage" part of the "Cache-control" HTTP header
1520 * @param $maxage Integer: maximum cache time on the Squid, in seconds.
1522 public function setSquidMaxage( $maxage ) {
1523 $this->mSquidMaxage
= $maxage;
1527 * Use enableClientCache(false) to force it to send nocache headers
1531 public function enableClientCache( $state ) {
1532 return wfSetVar( $this->mEnableClientCache
, $state );
1536 * Get the list of cookies that will influence on the cache
1540 function getCacheVaryCookies() {
1541 global $wgCookiePrefix, $wgCacheVaryCookies;
1543 if ( $cookies === null ) {
1544 $cookies = array_merge(
1546 "{$wgCookiePrefix}Token",
1547 "{$wgCookiePrefix}LoggedOut",
1552 wfRunHooks( 'GetCacheVaryCookies', array( $this, &$cookies ) );
1558 * Return whether this page is not cacheable because "useskin" or "uselang"
1559 * URL parameters were passed.
1563 function uncacheableBecauseRequestVars() {
1564 $request = $this->getRequest();
1565 return $request->getText( 'useskin', false ) === false
1566 && $request->getText( 'uselang', false ) === false;
1570 * Check if the request has a cache-varying cookie header
1571 * If it does, it's very important that we don't allow public caching
1575 function haveCacheVaryCookies() {
1576 $cookieHeader = $this->getRequest()->getHeader( 'cookie' );
1577 if ( $cookieHeader === false ) {
1580 $cvCookies = $this->getCacheVaryCookies();
1581 foreach ( $cvCookies as $cookieName ) {
1582 # Check for a simple string match, like the way squid does it
1583 if ( strpos( $cookieHeader, $cookieName ) !== false ) {
1584 wfDebug( __METHOD__
. ": found $cookieName\n" );
1588 wfDebug( __METHOD__
. ": no cache-varying cookies found\n" );
1593 * Add an HTTP header that will influence on the cache
1595 * @param $header String: header name
1596 * @param $option Array|null
1597 * @todo FIXME: Document the $option parameter; it appears to be for
1598 * X-Vary-Options but what format is acceptable?
1600 public function addVaryHeader( $header, $option = null ) {
1601 if ( !array_key_exists( $header, $this->mVaryHeader
) ) {
1602 $this->mVaryHeader
[$header] = (array)$option;
1603 } elseif( is_array( $option ) ) {
1604 if( is_array( $this->mVaryHeader
[$header] ) ) {
1605 $this->mVaryHeader
[$header] = array_merge( $this->mVaryHeader
[$header], $option );
1607 $this->mVaryHeader
[$header] = $option;
1610 $this->mVaryHeader
[$header] = array_unique( $this->mVaryHeader
[$header] );
1614 * Get a complete X-Vary-Options header
1618 public function getXVO() {
1619 $cvCookies = $this->getCacheVaryCookies();
1621 $cookiesOption = array();
1622 foreach ( $cvCookies as $cookieName ) {
1623 $cookiesOption[] = 'string-contains=' . $cookieName;
1625 $this->addVaryHeader( 'Cookie', $cookiesOption );
1628 foreach( $this->mVaryHeader
as $header => $option ) {
1629 $newheader = $header;
1630 if( is_array( $option ) ) {
1631 $newheader .= ';' . implode( ';', $option );
1633 $headers[] = $newheader;
1635 $xvo = 'X-Vary-Options: ' . implode( ',', $headers );
1641 * bug 21672: Add Accept-Language to Vary and XVO headers
1642 * if there's no 'variant' parameter existed in GET.
1645 * /w/index.php?title=Main_page should always be served; but
1646 * /w/index.php?title=Main_page&variant=zh-cn should never be served.
1648 function addAcceptLanguage() {
1650 if( !$this->getRequest()->getCheck( 'variant' ) && $wgContLang->hasVariants() ) {
1651 $variants = $wgContLang->getVariants();
1652 $aloption = array();
1653 foreach ( $variants as $variant ) {
1654 if( $variant === $wgContLang->getCode() ) {
1657 $aloption[] = 'string-contains=' . $variant;
1659 // IE and some other browsers use another form of language code
1660 // in their Accept-Language header, like "zh-CN" or "zh-TW".
1661 // We should handle these too.
1662 $ievariant = explode( '-', $variant );
1663 if ( count( $ievariant ) == 2 ) {
1664 $ievariant[1] = strtoupper( $ievariant[1] );
1665 $ievariant = implode( '-', $ievariant );
1666 $aloption[] = 'string-contains=' . $ievariant;
1670 $this->addVaryHeader( 'Accept-Language', $aloption );
1675 * Set a flag which will cause an X-Frame-Options header appropriate for
1676 * edit pages to be sent. The header value is controlled by
1677 * $wgEditPageFrameOptions.
1679 * This is the default for special pages. If you display a CSRF-protected
1680 * form on an ordinary view page, then you need to call this function.
1682 public function preventClickjacking( $enable = true ) {
1683 $this->mPreventClickjacking
= $enable;
1687 * Turn off frame-breaking. Alias for $this->preventClickjacking(false).
1688 * This can be called from pages which do not contain any CSRF-protected
1691 public function allowClickjacking() {
1692 $this->mPreventClickjacking
= false;
1696 * Get the X-Frame-Options header value (without the name part), or false
1697 * if there isn't one. This is used by Skin to determine whether to enable
1698 * JavaScript frame-breaking, for clients that don't support X-Frame-Options.
1700 public function getFrameOptions() {
1701 global $wgBreakFrames, $wgEditPageFrameOptions;
1702 if ( $wgBreakFrames ) {
1704 } elseif ( $this->mPreventClickjacking
&& $wgEditPageFrameOptions ) {
1705 return $wgEditPageFrameOptions;
1710 * Send cache control HTTP headers
1712 public function sendCacheControl() {
1713 global $wgUseSquid, $wgUseESI, $wgUseETag, $wgSquidMaxage, $wgUseXVO;
1715 $response = $this->getRequest()->response();
1716 if ( $wgUseETag && $this->mETag
) {
1717 $response->header( "ETag: $this->mETag" );
1720 $this->addAcceptLanguage();
1722 # don't serve compressed data to clients who can't handle it
1723 # maintain different caches for logged-in users and non-logged in ones
1724 $response->header( 'Vary: ' . join( ', ', array_keys( $this->mVaryHeader
) ) );
1727 # Add an X-Vary-Options header for Squid with Wikimedia patches
1728 $response->header( $this->getXVO() );
1731 if( !$this->uncacheableBecauseRequestVars() && $this->mEnableClientCache
) {
1733 $wgUseSquid && session_id() == '' && !$this->isPrintable() &&
1734 $this->mSquidMaxage
!= 0 && !$this->haveCacheVaryCookies()
1738 # We'll purge the proxy cache explicitly, but require end user agents
1739 # to revalidate against the proxy on each visit.
1740 # Surrogate-Control controls our Squid, Cache-Control downstream caches
1741 wfDebug( __METHOD__
. ": proxy caching with ESI; {$this->mLastModified} **\n", false );
1742 # start with a shorter timeout for initial testing
1743 # header( 'Surrogate-Control: max-age=2678400+2678400, content="ESI/1.0"');
1744 $response->header( 'Surrogate-Control: max-age='.$wgSquidMaxage.'+'.$this->mSquidMaxage
.', content="ESI/1.0"');
1745 $response->header( 'Cache-Control: s-maxage=0, must-revalidate, max-age=0' );
1747 # We'll purge the proxy cache for anons explicitly, but require end user agents
1748 # to revalidate against the proxy on each visit.
1749 # IMPORTANT! The Squid needs to replace the Cache-Control header with
1750 # Cache-Control: s-maxage=0, must-revalidate, max-age=0
1751 wfDebug( __METHOD__
. ": local proxy caching; {$this->mLastModified} **\n", false );
1752 # start with a shorter timeout for initial testing
1753 # header( "Cache-Control: s-maxage=2678400, must-revalidate, max-age=0" );
1754 $response->header( 'Cache-Control: s-maxage='.$this->mSquidMaxage
.', must-revalidate, max-age=0' );
1757 # We do want clients to cache if they can, but they *must* check for updates
1758 # on revisiting the page.
1759 wfDebug( __METHOD__
. ": private caching; {$this->mLastModified} **\n", false );
1760 $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
1761 $response->header( "Cache-Control: private, must-revalidate, max-age=0" );
1763 if($this->mLastModified
) {
1764 $response->header( "Last-Modified: {$this->mLastModified}" );
1767 wfDebug( __METHOD__
. ": no caching **\n", false );
1769 # In general, the absence of a last modified header should be enough to prevent
1770 # the client from using its cache. We send a few other things just to make sure.
1771 $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
1772 $response->header( 'Cache-Control: no-cache, no-store, max-age=0, must-revalidate' );
1773 $response->header( 'Pragma: no-cache' );
1778 * Get the message associed with the HTTP response code $code
1780 * @param $code Integer: status code
1781 * @return String or null: message or null if $code is not in the list of
1784 public static function getStatusMessage( $code ) {
1785 static $statusMessage = array(
1787 101 => 'Switching Protocols',
1788 102 => 'Processing',
1792 203 => 'Non-Authoritative Information',
1793 204 => 'No Content',
1794 205 => 'Reset Content',
1795 206 => 'Partial Content',
1796 207 => 'Multi-Status',
1797 300 => 'Multiple Choices',
1798 301 => 'Moved Permanently',
1801 304 => 'Not Modified',
1803 307 => 'Temporary Redirect',
1804 400 => 'Bad Request',
1805 401 => 'Unauthorized',
1806 402 => 'Payment Required',
1809 405 => 'Method Not Allowed',
1810 406 => 'Not Acceptable',
1811 407 => 'Proxy Authentication Required',
1812 408 => 'Request Timeout',
1815 411 => 'Length Required',
1816 412 => 'Precondition Failed',
1817 413 => 'Request Entity Too Large',
1818 414 => 'Request-URI Too Large',
1819 415 => 'Unsupported Media Type',
1820 416 => 'Request Range Not Satisfiable',
1821 417 => 'Expectation Failed',
1822 422 => 'Unprocessable Entity',
1824 424 => 'Failed Dependency',
1825 500 => 'Internal Server Error',
1826 501 => 'Not Implemented',
1827 502 => 'Bad Gateway',
1828 503 => 'Service Unavailable',
1829 504 => 'Gateway Timeout',
1830 505 => 'HTTP Version Not Supported',
1831 507 => 'Insufficient Storage'
1833 return isset( $statusMessage[$code] ) ?
$statusMessage[$code] : null;
1837 * Finally, all the text has been munged and accumulated into
1838 * the object, let's actually output it:
1840 public function output() {
1841 global $wgLanguageCode, $wgDebugRedirects, $wgMimeType;
1843 if( $this->mDoNothing
) {
1847 wfProfileIn( __METHOD__
);
1849 $response = $this->getRequest()->response();
1851 if ( $this->mRedirect
!= '' ) {
1852 # Standards require redirect URLs to be absolute
1853 $this->mRedirect
= wfExpandUrl( $this->mRedirect
);
1854 if( $this->mRedirectCode
== '301' ||
$this->mRedirectCode
== '303' ) {
1855 if( !$wgDebugRedirects ) {
1856 $message = self
::getStatusMessage( $this->mRedirectCode
);
1857 $response->header( "HTTP/1.1 {$this->mRedirectCode} $message" );
1859 $this->mLastModified
= wfTimestamp( TS_RFC2822
);
1861 $this->sendCacheControl();
1863 $response->header( "Content-Type: text/html; charset=utf-8" );
1864 if( $wgDebugRedirects ) {
1865 $url = htmlspecialchars( $this->mRedirect
);
1866 print "<html>\n<head>\n<title>Redirect</title>\n</head>\n<body>\n";
1867 print "<p>Location: <a href=\"$url\">$url</a></p>\n";
1868 print "</body>\n</html>\n";
1870 $response->header( 'Location: ' . $this->mRedirect
);
1872 wfProfileOut( __METHOD__
);
1874 } elseif ( $this->mStatusCode
) {
1875 $message = self
::getStatusMessage( $this->mStatusCode
);
1877 $response->header( 'HTTP/1.1 ' . $this->mStatusCode
. ' ' . $message );
1881 # Buffer output; final headers may depend on later processing
1884 $response->header( "Content-type: $wgMimeType; charset=UTF-8" );
1885 $response->header( 'Content-language: ' . $wgLanguageCode );
1887 // Prevent framing, if requested
1888 $frameOptions = $this->getFrameOptions();
1889 if ( $frameOptions ) {
1890 $response->header( "X-Frame-Options: $frameOptions" );
1893 if ( $this->mArticleBodyOnly
) {
1894 $this->out( $this->mBodytext
);
1896 $this->addDefaultModules();
1898 $sk = $this->getSkin( $this->getTitle() );
1900 // Hook that allows last minute changes to the output page, e.g.
1901 // adding of CSS or Javascript by extensions.
1902 wfRunHooks( 'BeforePageDisplay', array( &$this, &$sk ) );
1904 wfProfileIn( 'Output-skin' );
1905 $sk->outputPage( $this );
1906 wfProfileOut( 'Output-skin' );
1909 $this->sendCacheControl();
1911 wfProfileOut( __METHOD__
);
1915 * Actually output something with print().
1917 * @param $ins String: the string to output
1919 public function out( $ins ) {
1924 * Produce a "user is blocked" page.
1925 * @deprecated since 1.18
1927 function blockedPage() {
1928 throw new UserBlockedError( $this->getUser()->mBlock
);
1932 * Output a standard error page
1934 * @param $title String: message key for page title
1935 * @param $msg String: message key for page text
1936 * @param $params Array: message parameters
1938 public function showErrorPage( $title, $msg, $params = array() ) {
1939 if ( $this->getTitle() ) {
1940 $this->mDebugtext
.= 'Original title: ' . $this->getTitle()->getPrefixedText() . "\n";
1942 $this->setPageTitle( wfMsg( $title ) );
1943 $this->setHTMLTitle( wfMsg( 'errorpagetitle' ) );
1944 $this->setRobotPolicy( 'noindex,nofollow' );
1945 $this->setArticleRelated( false );
1946 $this->enableClientCache( false );
1947 $this->mRedirect
= '';
1948 $this->mBodytext
= '';
1950 $this->addWikiMsgArray( $msg, $params );
1952 $this->returnToMain();
1956 * Output a standard permission error page
1958 * @param $errors Array: error message keys
1959 * @param $action String: action that was denied or null if unknown
1961 public function showPermissionsErrorPage( $errors, $action = null ) {
1962 $this->mDebugtext
.= 'Original title: ' .
1963 $this->getTitle()->getPrefixedText() . "\n";
1964 $this->setPageTitle( wfMsg( 'permissionserrors' ) );
1965 $this->setHTMLTitle( wfMsg( 'permissionserrors' ) );
1966 $this->setRobotPolicy( 'noindex,nofollow' );
1967 $this->setArticleRelated( false );
1968 $this->enableClientCache( false );
1969 $this->mRedirect
= '';
1970 $this->mBodytext
= '';
1971 $this->addWikiText( $this->formatPermissionsErrorMessage( $errors, $action ) );
1975 * Display an error page indicating that a given version of MediaWiki is
1976 * required to use it
1978 * @param $version Mixed: the version of MediaWiki needed to use the page
1980 public function versionRequired( $version ) {
1981 $this->setPageTitle( wfMsg( 'versionrequired', $version ) );
1982 $this->setHTMLTitle( wfMsg( 'versionrequired', $version ) );
1983 $this->setRobotPolicy( 'noindex,nofollow' );
1984 $this->setArticleRelated( false );
1985 $this->mBodytext
= '';
1987 $this->addWikiMsg( 'versionrequiredtext', $version );
1988 $this->returnToMain();
1992 * Display an error page noting that a given permission bit is required.
1993 * @deprecated since 1.18, just throw the exception directly
1994 * @param $permission String: key required
1996 public function permissionRequired( $permission ) {
1997 throw new PermissionsError( $permission );
2001 * Produce the stock "please login to use the wiki" page
2003 public function loginToUse() {
2004 if( $this->getUser()->isLoggedIn() ) {
2005 throw new PermissionsError( 'read' );
2008 $this->setPageTitle( wfMsg( 'loginreqtitle' ) );
2009 $this->setHtmlTitle( wfMsg( 'errorpagetitle' ) );
2010 $this->setRobotPolicy( 'noindex,nofollow' );
2011 $this->setArticleRelated( false );
2013 $loginTitle = SpecialPage
::getTitleFor( 'Userlogin' );
2014 $loginLink = $this->getSkin()->link(
2016 wfMsgHtml( 'loginreqlink' ),
2018 array( 'returnto' => $this->getTitle()->getPrefixedText() ),
2019 array( 'known', 'noclasses' )
2021 $this->addWikiMsgArray( 'loginreqpagetext', array( $loginLink ), array( 'replaceafter' ) );
2022 $this->addHTML( "\n<!--" . $this->getTitle()->getPrefixedUrl() . '-->' );
2024 # Don't return to the main page if the user can't read it
2025 # otherwise we'll end up in a pointless loop
2026 $mainPage = Title
::newMainPage();
2027 if( $mainPage->userCanRead() ) {
2028 $this->returnToMain( null, $mainPage );
2033 * Format a list of error messages
2035 * @param $errors Array of arrays returned by Title::getUserPermissionsErrors
2036 * @param $action String: action that was denied or null if unknown
2037 * @return String: the wikitext error-messages, formatted into a list.
2039 public function formatPermissionsErrorMessage( $errors, $action = null ) {
2040 if ( $action == null ) {
2041 $text = wfMsgNoTrans( 'permissionserrorstext', count( $errors ) ) . "\n\n";
2043 $action_desc = wfMsgNoTrans( "action-$action" );
2044 $text = wfMsgNoTrans(
2045 'permissionserrorstext-withaction',
2051 if ( count( $errors ) > 1 ) {
2052 $text .= '<ul class="permissions-errors">' . "\n";
2054 foreach( $errors as $error ) {
2056 $text .= call_user_func_array( 'wfMsgNoTrans', $error );
2061 $text .= "<div class=\"permissions-errors\">\n" .
2062 call_user_func_array( 'wfMsgNoTrans', reset( $errors ) ) .
2070 * Display a page stating that the Wiki is in read-only mode,
2071 * and optionally show the source of the page that the user
2072 * was trying to edit. Should only be called (for this
2073 * purpose) after wfReadOnly() has returned true.
2075 * For historical reasons, this function is _also_ used to
2076 * show the error message when a user tries to edit a page
2077 * they are not allowed to edit. (Unless it's because they're
2078 * blocked, then we show blockedPage() instead.) In this
2079 * case, the second parameter should be set to true and a list
2080 * of reasons supplied as the third parameter.
2082 * @todo Needs to be split into multiple functions.
2084 * @param $source String: source code to show (or null).
2085 * @param $protected Boolean: is this a permissions error?
2086 * @param $reasons Array: list of reasons for this error, as returned by Title::getUserPermissionsErrors().
2087 * @param $action String: action that was denied or null if unknown
2089 public function readOnlyPage( $source = null, $protected = false, $reasons = array(), $action = null ) {
2090 $this->setRobotPolicy( 'noindex,nofollow' );
2091 $this->setArticleRelated( false );
2093 // If no reason is given, just supply a default "I can't let you do
2094 // that, Dave" message. Should only occur if called by legacy code.
2095 if ( $protected && empty( $reasons ) ) {
2096 $reasons[] = array( 'badaccess-group0' );
2099 if ( !empty( $reasons ) ) {
2100 // Permissions error
2102 $this->setPageTitle( wfMsg( 'viewsource' ) );
2104 wfMsg( 'viewsourcefor', $this->getSkin()->linkKnown( $this->getTitle() ) )
2107 $this->setPageTitle( wfMsg( 'badaccess' ) );
2109 $this->addWikiText( $this->formatPermissionsErrorMessage( $reasons, $action ) );
2111 // Wiki is read only
2112 throw new ReadOnlyError
;
2115 // Show source, if supplied
2116 if( is_string( $source ) ) {
2117 $this->addWikiMsg( 'viewsourcetext' );
2120 'id' => 'wpTextbox1',
2121 'name' => 'wpTextbox1',
2122 'cols' => $this->getUser()->getOption( 'cols' ),
2123 'rows' => $this->getUser()->getOption( 'rows' ),
2124 'readonly' => 'readonly'
2126 $this->addHTML( Html
::element( 'textarea', $params, $source ) );
2128 // Show templates used by this article
2129 $skin = $this->getSkin();
2130 $article = new Article( $this->getTitle() );
2131 $this->addHTML( "<div class='templatesUsed'>
2132 {$skin->formatTemplates( $article->getUsedTemplates() )}
2137 # If the title doesn't exist, it's fairly pointless to print a return
2138 # link to it. After all, you just tried editing it and couldn't, so
2139 # what's there to do there?
2140 if( $this->getTitle()->exists() ) {
2141 $this->returnToMain( null, $this->getTitle() );
2146 * Turn off regular page output and return an error reponse
2147 * for when rate limiting has triggered.
2149 public function rateLimited() {
2150 throw new ThrottledError
;
2154 * Show a warning about slave lag
2156 * If the lag is higher than $wgSlaveLagCritical seconds,
2157 * then the warning is a bit more obvious. If the lag is
2158 * lower than $wgSlaveLagWarning, then no warning is shown.
2160 * @param $lag Integer: slave lag
2162 public function showLagWarning( $lag ) {
2163 global $wgSlaveLagWarning, $wgSlaveLagCritical;
2164 if( $lag >= $wgSlaveLagWarning ) {
2165 $message = $lag < $wgSlaveLagCritical
2168 $wrap = Html
::rawElement( 'div', array( 'class' => "mw-{$message}" ), "\n$1\n" );
2169 $this->wrapWikiMsg( "$wrap\n", array( $message, $this->getContext()->getLang()->formatNum( $lag ) ) );
2173 public function showFatalError( $message ) {
2174 $this->setPageTitle( wfMsg( 'internalerror' ) );
2175 $this->setRobotPolicy( 'noindex,nofollow' );
2176 $this->setArticleRelated( false );
2177 $this->enableClientCache( false );
2178 $this->mRedirect
= '';
2179 $this->mBodytext
= $message;
2182 public function showUnexpectedValueError( $name, $val ) {
2183 $this->showFatalError( wfMsg( 'unexpected', $name, $val ) );
2186 public function showFileCopyError( $old, $new ) {
2187 $this->showFatalError( wfMsg( 'filecopyerror', $old, $new ) );
2190 public function showFileRenameError( $old, $new ) {
2191 $this->showFatalError( wfMsg( 'filerenameerror', $old, $new ) );
2194 public function showFileDeleteError( $name ) {
2195 $this->showFatalError( wfMsg( 'filedeleteerror', $name ) );
2198 public function showFileNotFoundError( $name ) {
2199 $this->showFatalError( wfMsg( 'filenotfound', $name ) );
2203 * Add a "return to" link pointing to a specified title
2205 * @param $title Title to link
2206 * @param $query String: query string
2207 * @param $text String text of the link (input is not escaped)
2209 public function addReturnTo( $title, $query = array(), $text = null ) {
2210 $this->addLink( array( 'rel' => 'next', 'href' => $title->getFullURL() ) );
2213 $this->getSkin()->link( $title, $text, array(), $query )
2215 $this->addHTML( "<p id=\"mw-returnto\">{$link}</p>\n" );
2219 * Add a "return to" link pointing to a specified title,
2220 * or the title indicated in the request, or else the main page
2222 * @param $unused No longer used
2223 * @param $returnto Title or String to return to
2224 * @param $returntoquery String: query string for the return to link
2226 public function returnToMain( $unused = null, $returnto = null, $returntoquery = null ) {
2227 if ( $returnto == null ) {
2228 $returnto = $this->getRequest()->getText( 'returnto' );
2231 if ( $returntoquery == null ) {
2232 $returntoquery = $this->getRequest()->getText( 'returntoquery' );
2235 if ( $returnto === '' ) {
2236 $returnto = Title
::newMainPage();
2239 if ( is_object( $returnto ) ) {
2240 $titleObj = $returnto;
2242 $titleObj = Title
::newFromText( $returnto );
2244 if ( !is_object( $titleObj ) ) {
2245 $titleObj = Title
::newMainPage();
2248 $this->addReturnTo( $titleObj, $returntoquery );
2252 * @param $sk Skin The given Skin
2253 * @param $includeStyle Boolean: unused
2254 * @return String: The doctype, opening <html>, and head element.
2256 public function headElement( Skin
$sk, $includeStyle = true ) {
2257 global $wgUseTrackbacks;
2259 if ( $sk->commonPrintStylesheet() ) {
2260 $this->addModuleStyles( 'mediawiki.legacy.wikiprintable' );
2262 $sk->setupUserCss( $this );
2265 $ret = Html
::htmlHeader( array( 'lang' => $lang->getCode(), 'dir' => $lang->getDir() ) );
2267 if ( $this->getHTMLTitle() == '' ) {
2268 $this->setHTMLTitle( wfMsg( 'pagetitle', $this->getPageTitle() ) );
2271 $openHead = Html
::openElement( 'head' );
2273 # Don't bother with the newline if $head == ''
2274 $ret .= "$openHead\n";
2277 $ret .= Html
::element( 'title', null, $this->getHTMLTitle() ) . "\n";
2279 $ret .= implode( "\n", array(
2280 $this->getHeadLinks( $sk, true ),
2281 $this->buildCssLinks( $sk ),
2282 $this->getHeadScripts( $sk ),
2283 $this->getHeadItems()
2286 if ( $wgUseTrackbacks && $this->isArticleRelated() ) {
2287 $ret .= $this->getTitle()->trackbackRDF();
2290 $closeHead = Html
::closeElement( 'head' );
2292 $ret .= "$closeHead\n";
2295 $bodyAttrs = array();
2297 # Crazy edit-on-double-click stuff
2298 $action = $this->getRequest()->getVal( 'action', 'view' );
2301 $this->getTitle()->getNamespace() != NS_SPECIAL
&&
2302 in_array( $action, array( 'view', 'purge' ) ) &&
2303 $this->getUser()->getOption( 'editondblclick' )
2306 $editUrl = $this->getTitle()->getLocalUrl( $sk->editUrlOptions() );
2307 $bodyAttrs['ondblclick'] = "document.location = '" .
2308 Xml
::escapeJsString( $editUrl ) . "'";
2312 $dir = wfUILang()->getDir();
2313 $bodyAttrs['class'] = "mediawiki $dir";
2315 if ( $this->getContext()->getLang()->capitalizeAllNouns() ) {
2316 # A <body> class is probably not the best way to do this . . .
2317 $bodyAttrs['class'] .= ' capitalize-all-nouns';
2319 $bodyAttrs['class'] .= ' ' . $sk->getPageClasses( $this->getTitle() );
2320 $bodyAttrs['class'] .= ' skin-' . Sanitizer
::escapeClass( $sk->getSkinName() );
2322 $sk->addToBodyAttributes( $this, $bodyAttrs ); // Allow skins to add body attributes they need
2323 wfRunHooks( 'OutputPageBodyAttributes', array( $this, $sk, &$bodyAttrs ) );
2325 $ret .= Html
::openElement( 'body', $bodyAttrs ) . "\n";
2331 * Add the default ResourceLoader modules to this object
2333 private function addDefaultModules() {
2334 global $wgIncludeLegacyJavaScript,
2335 $wgUseAjax, $wgAjaxWatch, $wgEnableMWSuggest;
2337 // Add base resources
2338 $this->addModules( array( 'mediawiki.user', 'mediawiki.util', 'mediawiki.action.view.tablesorting' ) );
2339 if ( $wgIncludeLegacyJavaScript ){
2340 $this->addModules( 'mediawiki.legacy.wikibits' );
2343 // Add various resources if required
2345 $this->addModules( 'mediawiki.legacy.ajax' );
2347 wfRunHooks( 'AjaxAddScript', array( &$this ) );
2349 if( $wgAjaxWatch && $this->getUser()->isLoggedIn() ) {
2350 $this->addModules( 'mediawiki.action.watch.ajax' );
2353 if ( $wgEnableMWSuggest && !$this->getUser()->getOption( 'disablesuggest', false ) ) {
2354 $this->addModules( 'mediawiki.legacy.mwsuggest' );
2358 if( $this->getUser()->getBoolOption( 'editsectiononrightclick' ) ) {
2359 $this->addModules( 'mediawiki.action.view.rightClickEdit' );
2364 * Get a ResourceLoader object associated with this OutputPage
2366 * @return ResourceLoader
2368 public function getResourceLoader() {
2369 if ( is_null( $this->mResourceLoader
) ) {
2370 $this->mResourceLoader
= new ResourceLoader();
2372 return $this->mResourceLoader
;
2378 * @param $modules Array/string with the module name
2379 * @param $only String ResourceLoaderModule TYPE_ class constant
2380 * @param $useESI boolean
2381 * @return string html <script> and <style> tags
2383 protected function makeResourceLoaderLink( Skin
$skin, $modules, $only, $useESI = false ) {
2384 global $wgLoadScript, $wgResourceLoaderUseESI,
2385 $wgResourceLoaderInlinePrivateModules;
2386 // Lazy-load ResourceLoader
2387 // TODO: Should this be a static function of ResourceLoader instead?
2389 'lang' => $this->getContext()->getLang()->getCode(),
2390 'debug' => ResourceLoader
::inDebugMode() ?
'true' : 'false',
2391 'skin' => $skin->getSkinName(),
2394 // Propagate printable and handheld parameters if present
2395 if ( $this->isPrintable() ) {
2396 $baseQuery['printable'] = 1;
2398 if ( $this->getRequest()->getBool( 'handheld' ) ) {
2399 $baseQuery['handheld'] = 1;
2402 if ( !count( $modules ) ) {
2406 if ( count( $modules ) > 1 ) {
2407 // Remove duplicate module requests
2408 $modules = array_unique( (array) $modules );
2409 // Sort module names so requests are more uniform
2412 if ( ResourceLoader
::inDebugMode() ) {
2413 // Recursively call us for every item
2415 foreach ( $modules as $name ) {
2416 $links .= $this->makeResourceLoaderLink( $skin, $name, $only, $useESI );
2422 // Create keyed-by-group list of module objects from modules list
2424 $resourceLoader = $this->getResourceLoader();
2425 foreach ( (array) $modules as $name ) {
2426 $module = $resourceLoader->getModule( $name );
2427 # Check that we're allowed to include this module on this page
2428 if ( ( $module->getOrigin() > $this->getAllowedModules( ResourceLoaderModule
::TYPE_SCRIPTS
)
2429 && $only == ResourceLoaderModule
::TYPE_SCRIPTS
)
2430 ||
( $module->getOrigin() > $this->getAllowedModules( ResourceLoaderModule
::TYPE_STYLES
)
2431 && $only == ResourceLoaderModule
::TYPE_STYLES
)
2437 $group = $module->getGroup();
2438 if ( !isset( $groups[$group] ) ) {
2439 $groups[$group] = array();
2441 $groups[$group][$name] = $module;
2445 foreach ( $groups as $group => $modules ) {
2446 $query = $baseQuery;
2447 // Special handling for user-specific groups
2448 if ( ( $group === 'user' ||
$group === 'private' ) && $this->getUser()->isLoggedIn() ) {
2449 $query['user'] = $this->getUser()->getName();
2452 // Create a fake request based on the one we are about to make so modules return
2453 // correct timestamp and emptiness data
2454 $context = new ResourceLoaderContext( $resourceLoader, new FauxRequest( $query ) );
2455 // Drop modules that know they're empty
2456 foreach ( $modules as $key => $module ) {
2457 if ( $module->isKnownEmpty( $context ) ) {
2458 unset( $modules[$key] );
2461 // If there are no modules left, skip this group
2462 if ( $modules === array() ) {
2466 $query['modules'] = ResourceLoader
::makePackedModulesString( array_keys( $modules ) );
2468 // Support inlining of private modules if configured as such
2469 if ( $group === 'private' && $wgResourceLoaderInlinePrivateModules ) {
2470 if ( $only == ResourceLoaderModule
::TYPE_STYLES
) {
2471 $links .= Html
::inlineStyle(
2472 $resourceLoader->makeModuleResponse( $context, $modules )
2475 $links .= Html
::inlineScript(
2476 ResourceLoader
::makeLoaderConditionalScript(
2477 $resourceLoader->makeModuleResponse( $context, $modules )
2483 // Special handling for the user group; because users might change their stuff
2484 // on-wiki like user pages, or user preferences; we need to find the highest
2485 // timestamp of these user-changable modules so we can ensure cache misses on change
2486 // This should NOT be done for the site group (bug 27564) because anons get that too
2487 // and we shouldn't be putting timestamps in Squid-cached HTML
2488 if ( $group === 'user' ) {
2489 // Get the maximum timestamp
2491 foreach ( $modules as $module ) {
2492 $timestamp = max( $timestamp, $module->getModifiedTime( $context ) );
2494 // Add a version parameter so cache will break when things change
2495 $query['version'] = wfTimestamp( TS_ISO_8601_BASIC
, $timestamp );
2497 // Make queries uniform in order
2500 $url = wfAppendQuery( $wgLoadScript, $query );
2501 if ( $useESI && $wgResourceLoaderUseESI ) {
2502 $esi = Xml
::element( 'esi:include', array( 'src' => $url ) );
2503 if ( $only == ResourceLoaderModule
::TYPE_STYLES
) {
2504 $link = Html
::inlineStyle( $esi );
2506 $link = Html
::inlineScript( $esi );
2509 // Automatically select style/script elements
2510 if ( $only === ResourceLoaderModule
::TYPE_STYLES
) {
2511 $link = Html
::linkedStyle( wfAppendQuery( $wgLoadScript, $query ) );
2513 $link = Html
::linkedScript( wfAppendQuery( $wgLoadScript, $query ) );
2517 if( $group == 'noscript' ){
2518 $links .= Html
::rawElement( 'noscript', array(), $link ) . "\n";
2520 $links .= $link . "\n";
2527 * JS stuff to put in the <head>. This is the startup module, config
2528 * vars and modules marked with position 'top'
2530 * @param $sk Skin object to use
2531 * @return String: HTML fragment
2533 function getHeadScripts( Skin
$sk ) {
2534 // Startup - this will immediately load jquery and mediawiki modules
2535 $scripts = $this->makeResourceLoaderLink( $sk, 'startup', ResourceLoaderModule
::TYPE_SCRIPTS
, true );
2537 // Load config before anything else
2538 $scripts .= Html
::inlineScript(
2539 ResourceLoader
::makeLoaderConditionalScript(
2540 ResourceLoader
::makeConfigSetScript( $this->getJSVars() )
2544 // Script and Messages "only" requests marked for top inclusion
2545 // Messages should go first
2546 $scripts .= $this->makeResourceLoaderLink( $sk, $this->getModuleMessages( true, 'top' ), ResourceLoaderModule
::TYPE_MESSAGES
);
2547 $scripts .= $this->makeResourceLoaderLink( $sk, $this->getModuleScripts( true, 'top' ), ResourceLoaderModule
::TYPE_SCRIPTS
);
2549 // Modules requests - let the client calculate dependencies and batch requests as it likes
2550 // Only load modules that have marked themselves for loading at the top
2551 $modules = $this->getModules( true, 'top' );
2553 $scripts .= Html
::inlineScript(
2554 ResourceLoader
::makeLoaderConditionalScript(
2555 Xml
::encodeJsCall( 'mw.loader.load', array( $modules ) ) .
2556 Xml
::encodeJsCall( 'mw.loader.go', array() )
2565 * JS stuff to put at the bottom of the <body>: modules marked with position 'bottom',
2566 * legacy scripts ($this->mScripts), user preferences, site JS and user JS
2568 function getBottomScripts( Skin
$sk ) {
2569 global $wgUseSiteJs, $wgAllowUserJs;
2571 // Script and Messages "only" requests marked for bottom inclusion
2572 // Messages should go first
2573 $scripts = $this->makeResourceLoaderLink( $sk, $this->getModuleMessages( true, 'bottom' ), ResourceLoaderModule
::TYPE_MESSAGES
);
2574 $scripts .= $this->makeResourceLoaderLink( $sk, $this->getModuleScripts( true, 'bottom' ), ResourceLoaderModule
::TYPE_SCRIPTS
);
2576 // Modules requests - let the client calculate dependencies and batch requests as it likes
2577 // Only load modules that have marked themselves for loading at the bottom
2578 $modules = $this->getModules( true, 'bottom' );
2580 $scripts .= Html
::inlineScript(
2581 ResourceLoader
::makeLoaderConditionalScript(
2582 Xml
::encodeJsCall( 'mw.loader.load', array( $modules ) )
2588 $scripts .= "\n" . $this->mScripts
;
2590 $userScripts = array( 'user.options' );
2592 // Add site JS if enabled
2593 if ( $wgUseSiteJs ) {
2594 $scripts .= $this->makeResourceLoaderLink( $sk, 'site', ResourceLoaderModule
::TYPE_SCRIPTS
);
2595 if( $this->getUser()->isLoggedIn() ){
2596 $userScripts[] = 'user.groups';
2600 // Add user JS if enabled
2601 if ( $wgAllowUserJs && $this->getUser()->isLoggedIn() ) {
2602 $action = $this->getRequest()->getVal( 'action', 'view' );
2603 if( $this->getTitle() && $this->getTitle()->isJsSubpage() && $sk->userCanPreview( $action ) ) {
2604 # XXX: additional security check/prompt?
2605 $scripts .= Html
::inlineScript( "\n" . $this->getRequest()->getText( 'wpTextbox1' ) . "\n" ) . "\n";
2607 # @todo FIXME: This means that User:Me/Common.js doesn't load when previewing
2608 # User:Me/Vector.js, and vice versa (bug26283)
2609 $userScripts[] = 'user';
2612 $scripts .= $this->makeResourceLoaderLink( $sk, $userScripts, ResourceLoaderModule
::TYPE_SCRIPTS
);
2618 * Get an array containing global JS variables
2620 * Do not add things here which can be evaluated in
2621 * ResourceLoaderStartupScript - in other words, without state.
2622 * You will only be adding bloat to the page and causing page caches to
2623 * have to be purged on configuration changes.
2625 protected function getJSVars() {
2626 global $wgUseAjax, $wgEnableMWSuggest, $wgContLang;
2628 $title = $this->getTitle();
2629 $ns = $title->getNamespace();
2630 $nsname = MWNamespace
::exists( $ns ) ? MWNamespace
::getCanonicalName( $ns ) : $title->getNsText();
2631 if ( $ns == NS_SPECIAL
) {
2632 list( $canonicalName, /*...*/ ) = SpecialPageFactory
::resolveAlias( $title->getDBkey() );
2634 $canonicalName = false; # bug 21115
2638 'wgCanonicalNamespace' => $nsname,
2639 'wgCanonicalSpecialPageName' => $canonicalName,
2640 'wgNamespaceNumber' => $title->getNamespace(),
2641 'wgPageName' => $title->getPrefixedDBKey(),
2642 'wgTitle' => $title->getText(),
2643 'wgCurRevisionId' => $title->getLatestRevID(),
2644 'wgArticleId' => $title->getArticleId(),
2645 'wgIsArticle' => $this->isArticle(),
2646 'wgAction' => $this->getRequest()->getText( 'action', 'view' ),
2647 'wgUserName' => $this->getUser()->isAnon() ?
null : $this->getUser()->getName(),
2648 'wgUserGroups' => $this->getUser()->getEffectiveGroups(),
2649 'wgCategories' => $this->getCategories(),
2650 'wgBreakFrames' => $this->getFrameOptions() == 'DENY',
2651 'wgIsMainPage' => $title->isMainPage(),
2653 if ( $wgContLang->hasVariants() ) {
2654 $vars['wgUserVariant'] = $wgContLang->getPreferredVariant();
2656 foreach ( $title->getRestrictionTypes() as $type ) {
2657 $vars['wgRestriction' . ucfirst( $type )] = $title->getRestrictions( $type );
2659 if ( $wgUseAjax && $wgEnableMWSuggest && !$this->getUser()->getOption( 'disablesuggest', false ) ) {
2660 $vars['wgSearchNamespaces'] = SearchEngine
::userNamespaces( $this->getUser() );
2663 // Allow extensions to add their custom variables to the global JS variables
2664 wfRunHooks( 'MakeGlobalVariablesScript', array( &$vars ) );
2670 * @return string HTML tag links to be put in the header.
2672 public function getHeadLinks( Skin
$sk, $addContentType = false ) {
2673 global $wgUniversalEditButton, $wgFavicon, $wgAppleTouchIcon, $wgEnableAPI,
2674 $wgSitename, $wgVersion, $wgHtml5, $wgMimeType,
2675 $wgFeed, $wgOverrideSiteFeed, $wgAdvertisedFeedTypes,
2676 $wgEnableDublinCoreRdf, $wgEnableCreativeCommonsRdf,
2677 $wgDisableLangConversion, $wgCanonicalLanguageLinks, $wgContLang,
2678 $wgRightsPage, $wgRightsUrl;
2682 if ( $addContentType ) {
2684 # More succinct than <meta http-equiv=Content-Type>, has the
2686 $tags[] = Html
::element( 'meta', array( 'charset' => 'UTF-8' ) );
2688 $tags[] = Html
::element( 'meta', array(
2689 'http-equiv' => 'Content-Type',
2690 'content' => "$wgMimeType; charset=UTF-8"
2692 $tags[] = Html
::element( 'meta', array( // bug 15835
2693 'http-equiv' => 'Content-Style-Type',
2694 'content' => 'text/css'
2699 $tags[] = Html
::element( 'meta', array(
2700 'name' => 'generator',
2701 'content' => "MediaWiki $wgVersion",
2704 $p = "{$this->mIndexPolicy},{$this->mFollowPolicy}";
2705 if( $p !== 'index,follow' ) {
2706 // http://www.robotstxt.org/wc/meta-user.html
2707 // Only show if it's different from the default robots policy
2708 $tags[] = Html
::element( 'meta', array(
2714 if ( count( $this->mKeywords
) > 0 ) {
2716 "/<.*?" . ">/" => '',
2719 $tags[] = Html
::element( 'meta', array(
2720 'name' => 'keywords',
2721 'content' => preg_replace(
2722 array_keys( $strip ),
2723 array_values( $strip ),
2724 implode( ',', $this->mKeywords
)
2729 foreach ( $this->mMetatags
as $tag ) {
2730 if ( 0 == strcasecmp( 'http:', substr( $tag[0], 0, 5 ) ) ) {
2732 $tag[0] = substr( $tag[0], 5 );
2736 $tags[] = Html
::element( 'meta',
2739 'content' => $tag[1]
2744 foreach ( $this->mLinktags
as $tag ) {
2745 $tags[] = Html
::element( 'link', $tag );
2748 # Universal edit button
2749 if ( $wgUniversalEditButton ) {
2750 if ( $this->isArticleRelated() && $this->getTitle() && $this->getTitle()->quickUserCan( 'edit' )
2751 && ( $this->getTitle()->exists() ||
$this->getTitle()->quickUserCan( 'create' ) ) ) {
2752 // Original UniversalEditButton
2753 $msg = wfMsg( 'edit' );
2754 $tags[] = Html
::element( 'link', array(
2755 'rel' => 'alternate',
2756 'type' => 'application/x-wiki',
2758 'href' => $this->getTitle()->getLocalURL( 'action=edit' )
2760 // Alternate edit link
2761 $tags[] = Html
::element( 'link', array(
2764 'href' => $this->getTitle()->getLocalURL( 'action=edit' )
2769 # Generally the order of the favicon and apple-touch-icon links
2770 # should not matter, but Konqueror (3.5.9 at least) incorrectly
2771 # uses whichever one appears later in the HTML source. Make sure
2772 # apple-touch-icon is specified first to avoid this.
2773 if ( $wgAppleTouchIcon !== false ) {
2774 $tags[] = Html
::element( 'link', array( 'rel' => 'apple-touch-icon', 'href' => $wgAppleTouchIcon ) );
2777 if ( $wgFavicon !== false ) {
2778 $tags[] = Html
::element( 'link', array( 'rel' => 'shortcut icon', 'href' => $wgFavicon ) );
2781 # OpenSearch description link
2782 $tags[] = Html
::element( 'link', array(
2784 'type' => 'application/opensearchdescription+xml',
2785 'href' => wfScript( 'opensearch_desc' ),
2786 'title' => wfMsgForContent( 'opensearch-desc' ),
2789 if ( $wgEnableAPI ) {
2790 # Real Simple Discovery link, provides auto-discovery information
2791 # for the MediaWiki API (and potentially additional custom API
2792 # support such as WordPress or Twitter-compatible APIs for a
2793 # blogging extension, etc)
2794 $tags[] = Html
::element( 'link', array(
2796 'type' => 'application/rsd+xml',
2797 'href' => wfExpandUrl( wfAppendQuery( wfScript( 'api' ), array( 'action' => 'rsd' ) ) ),
2802 # - Creative Commons
2803 # See http://wiki.creativecommons.org/Extend_Metadata.
2805 # Use hreflang to specify canonical and alternate links
2806 # See http://www.google.com/support/webmasters/bin/answer.py?answer=189077
2807 if ( $this->isArticleRelated() ) {
2808 # note: buggy CC software only reads first "meta" link
2809 if ( $wgEnableCreativeCommonsRdf ) {
2810 $tags[] = Html
::element( 'link', array(
2811 'rel' => $this->getMetadataAttribute(),
2812 'title' => 'Creative Commons',
2813 'type' => 'application/rdf+xml',
2814 'href' => $this->getTitle()->getLocalURL( 'action=creativecommons' ) )
2818 if ( $wgEnableDublinCoreRdf ) {
2819 $tags[] = Html
::element( 'link', array(
2820 'rel' => $this->getMetadataAttribute(),
2821 'title' => 'Dublin Core',
2822 'type' => 'application/rdf+xml',
2823 'href' => $this->getTitle()->getLocalURL( 'action=dublincore' ) )
2829 if ( !$wgDisableLangConversion && $wgCanonicalLanguageLinks
2830 && $wgContLang->hasVariants() ) {
2832 $urlvar = $wgContLang->getURLVariant();
2835 $variants = $wgContLang->getVariants();
2836 foreach ( $variants as $_v ) {
2837 $tags[] = Html
::element( 'link', array(
2838 'rel' => 'alternate',
2840 'href' => $this->getTitle()->getLocalURL( '', $_v ) )
2844 $tags[] = Html
::element( 'link', array(
2845 'rel' => 'canonical',
2846 'href' => $this->getTitle()->getFullURL() )
2853 if ( $wgRightsPage ) {
2854 $copy = Title
::newFromText( $wgRightsPage );
2857 $copyright = $copy->getLocalURL();
2861 if ( !$copyright && $wgRightsUrl ) {
2862 $copyright = $wgRightsUrl;
2866 $tags[] = Html
::element( 'link', array(
2867 'rel' => 'copyright',
2868 'href' => $copyright )
2874 foreach( $this->getSyndicationLinks() as $format => $link ) {
2875 # Use the page name for the title (accessed through $wgTitle since
2876 # there's no other way). In principle, this could lead to issues
2877 # with having the same name for different feeds corresponding to
2878 # the same page, but we can't avoid that at this low a level.
2880 $tags[] = $this->feedLink(
2883 # Used messages: 'page-rss-feed' and 'page-atom-feed' (for an easier grep)
2884 wfMsg( "page-{$format}-feed", $this->getTitle()->getPrefixedText() )
2888 # Recent changes feed should appear on every page (except recentchanges,
2889 # that would be redundant). Put it after the per-page feed to avoid
2890 # changing existing behavior. It's still available, probably via a
2891 # menu in your browser. Some sites might have a different feed they'd
2892 # like to promote instead of the RC feed (maybe like a "Recent New Articles"
2893 # or "Breaking news" one). For this, we see if $wgOverrideSiteFeed is defined.
2894 # If so, use it instead.
2896 $rctitle = SpecialPage
::getTitleFor( 'Recentchanges' );
2898 if ( $wgOverrideSiteFeed ) {
2899 foreach ( $wgOverrideSiteFeed as $type => $feedUrl ) {
2900 $tags[] = $this->feedLink(
2902 htmlspecialchars( $feedUrl ),
2903 wfMsg( "site-{$type}-feed", $wgSitename )
2906 } elseif ( $this->getTitle()->getPrefixedText() != $rctitle->getPrefixedText() ) {
2907 foreach ( $wgAdvertisedFeedTypes as $format ) {
2908 $tags[] = $this->feedLink(
2910 $rctitle->getLocalURL( "feed={$format}" ),
2911 wfMsg( "site-{$format}-feed", $wgSitename ) # For grep: 'site-rss-feed', 'site-atom-feed'.
2916 return implode( "\n", $tags );
2920 * Generate a <link rel/> for a feed.
2922 * @param $type String: feed type
2923 * @param $url String: URL to the feed
2924 * @param $text String: value of the "title" attribute
2925 * @return String: HTML fragment
2927 private function feedLink( $type, $url, $text ) {
2928 return Html
::element( 'link', array(
2929 'rel' => 'alternate',
2930 'type' => "application/$type+xml",
2937 * Add a local or specified stylesheet, with the given media options.
2938 * Meant primarily for internal use...
2940 * @param $style String: URL to the file
2941 * @param $media String: to specify a media type, 'screen', 'printable', 'handheld' or any.
2942 * @param $condition String: for IE conditional comments, specifying an IE version
2943 * @param $dir String: set to 'rtl' or 'ltr' for direction-specific sheets
2945 public function addStyle( $style, $media = '', $condition = '', $dir = '' ) {
2947 // Even though we expect the media type to be lowercase, but here we
2948 // force it to lowercase to be safe.
2950 $options['media'] = $media;
2953 $options['condition'] = $condition;
2956 $options['dir'] = $dir;
2958 $this->styles
[$style] = $options;
2962 * Adds inline CSS styles
2963 * @param $style_css Mixed: inline CSS
2965 public function addInlineStyle( $style_css ){
2966 $this->mInlineStyles
.= Html
::inlineStyle( $style_css );
2970 * Build a set of <link>s for the stylesheets specified in the $this->styles array.
2971 * These will be applied to various media & IE conditionals.
2972 * @param $sk Skin object
2974 public function buildCssLinks( $sk ) {
2976 // Add ResourceLoader styles
2977 // Split the styles into four groups
2978 $styles = array( 'other' => array(), 'user' => array(), 'site' => array(), 'private' => array(), 'noscript' => array() );
2979 $resourceLoader = $this->getResourceLoader();
2980 foreach ( $this->getModuleStyles() as $name ) {
2981 $group = $resourceLoader->getModule( $name )->getGroup();
2982 // Modules in groups named "other" or anything different than "user", "site" or "private"
2983 // will be placed in the "other" group
2984 $styles[isset( $styles[$group] ) ?
$group : 'other'][] = $name;
2987 // We want site, private and user styles to override dynamically added styles from modules, but we want
2988 // dynamically added styles to override statically added styles from other modules. So the order
2989 // has to be other, dynamic, site, private, user
2990 // Add statically added styles for other modules
2991 $ret .= $this->makeResourceLoaderLink( $sk, $styles['other'], ResourceLoaderModule
::TYPE_STYLES
);
2992 // Add normal styles added through addStyle()/addInlineStyle() here
2993 $ret .= implode( "\n", $this->buildCssLinksArray() ) . $this->mInlineStyles
;
2994 // Add marker tag to mark the place where the client-side loader should inject dynamic styles
2995 // We use a <meta> tag with a made-up name for this because that's valid HTML
2996 $ret .= Html
::element( 'meta', array( 'name' => 'ResourceLoaderDynamicStyles', 'content' => '' ) ) . "\n";
2998 // Add site, private and user styles
2999 // 'private' at present only contains user.options, so put that before 'user'
3000 // Any future private modules will likely have a similar user-specific character
3001 foreach ( array( 'site', 'noscript', 'private', 'user' ) as $group ) {
3002 $ret .= $this->makeResourceLoaderLink( $sk, $styles[$group],
3003 ResourceLoaderModule
::TYPE_STYLES
3009 public function buildCssLinksArray() {
3011 foreach( $this->styles
as $file => $options ) {
3012 $link = $this->styleLink( $file, $options );
3014 $links[$file] = $link;
3021 * Generate \<link\> tags for stylesheets
3023 * @param $style String: URL to the file
3024 * @param $options Array: option, can contain 'condition', 'dir', 'media'
3026 * @return String: HTML fragment
3028 protected function styleLink( $style, $options ) {
3029 if( isset( $options['dir'] ) ) {
3030 $siteDir = wfUILang()->getDir();
3031 if( $siteDir != $options['dir'] ) {
3036 if( isset( $options['media'] ) ) {
3037 $media = self
::transformCssMedia( $options['media'] );
3038 if( is_null( $media ) ) {
3045 if( substr( $style, 0, 1 ) == '/' ||
3046 substr( $style, 0, 5 ) == 'http:' ||
3047 substr( $style, 0, 6 ) == 'https:' ) {
3050 global $wgStylePath, $wgStyleVersion;
3051 $url = $wgStylePath . '/' . $style . '?' . $wgStyleVersion;
3054 $link = Html
::linkedStyle( $url, $media );
3056 if( isset( $options['condition'] ) ) {
3057 $condition = htmlspecialchars( $options['condition'] );
3058 $link = "<!--[if $condition]>$link<![endif]-->";
3064 * Transform "media" attribute based on request parameters
3066 * @param $media String: current value of the "media" attribute
3067 * @return String: modified value of the "media" attribute
3069 public static function transformCssMedia( $media ) {
3070 global $wgRequest, $wgHandheldForIPhone;
3072 // Switch in on-screen display for media testing
3074 'printable' => 'print',
3075 'handheld' => 'handheld',
3077 foreach( $switches as $switch => $targetMedia ) {
3078 if( $wgRequest->getBool( $switch ) ) {
3079 if( $media == $targetMedia ) {
3081 } elseif( $media == 'screen' ) {
3087 // Expand longer media queries as iPhone doesn't grok 'handheld'
3088 if( $wgHandheldForIPhone ) {
3089 $mediaAliases = array(
3090 'screen' => 'screen and (min-device-width: 481px)',
3091 'handheld' => 'handheld, only screen and (max-device-width: 480px)',
3094 if( isset( $mediaAliases[$media] ) ) {
3095 $media = $mediaAliases[$media];
3103 * Add a wikitext-formatted message to the output.
3104 * This is equivalent to:
3106 * $wgOut->addWikiText( wfMsgNoTrans( ... ) )
3108 public function addWikiMsg( /*...*/ ) {
3109 $args = func_get_args();
3110 $name = array_shift( $args );
3111 $this->addWikiMsgArray( $name, $args );
3115 * Add a wikitext-formatted message to the output.
3116 * Like addWikiMsg() except the parameters are taken as an array
3117 * instead of a variable argument list.
3119 * $options is passed through to wfMsgExt(), see that function for details.
3121 public function addWikiMsgArray( $name, $args, $options = array() ) {
3122 $options[] = 'parse';
3123 $text = wfMsgExt( $name, $options, $args );
3124 $this->addHTML( $text );
3128 * This function takes a number of message/argument specifications, wraps them in
3129 * some overall structure, and then parses the result and adds it to the output.
3131 * In the $wrap, $1 is replaced with the first message, $2 with the second, and so
3132 * on. The subsequent arguments may either be strings, in which case they are the
3133 * message names, or arrays, in which case the first element is the message name,
3134 * and subsequent elements are the parameters to that message.
3136 * The special named parameter 'options' in a message specification array is passed
3137 * through to the $options parameter of wfMsgExt().
3139 * Don't use this for messages that are not in users interface language.
3143 * $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>", 'some-error' );
3147 * $wgOut->addWikiText( "<div class='error'>\n" . wfMsgNoTrans( 'some-error' ) . "\n</div>" );
3149 * The newline after opening div is needed in some wikitext. See bug 19226.
3151 public function wrapWikiMsg( $wrap /*, ...*/ ) {
3152 $msgSpecs = func_get_args();
3153 array_shift( $msgSpecs );
3154 $msgSpecs = array_values( $msgSpecs );
3156 foreach ( $msgSpecs as $n => $spec ) {
3158 if ( is_array( $spec ) ) {
3160 $name = array_shift( $args );
3161 if ( isset( $args['options'] ) ) {
3162 $options = $args['options'];
3163 unset( $args['options'] );
3169 $s = str_replace( '$' . ( $n +
1 ), wfMsgExt( $name, $options, $args ), $s );
3171 $this->addWikiText( $s );
3175 * Include jQuery core. Use this to avoid loading it multiple times
3176 * before we get a usable script loader.
3178 * @param $modules Array: list of jQuery modules which should be loaded
3179 * @return Array: the list of modules which were not loaded.
3181 * @deprecated since 1.17
3183 public function includeJQuery( $modules = array() ) {