"
var $mMetatags = array();
var $mLinktags = array();
var $mCanonicalUrl = false;
/// Additional stylesheets. Looks like this is for extensions. Might be replaced by resource loader.
var $mExtStyles = array();
/// Should be private - has getter and setter. Contains the HTML title
var $mPagetitle = '';
/// Contains all of the "
" content. Should be private we got set/get accessors and the append() method.
var $mBodytext = '';
/**
* Holds the debug lines that will be output as comments in page source if
* $wgDebugComments is enabled. See also $wgShowDebug.
* @deprecated since 1.20; use MWDebug class instead.
*/
public $mDebugtext = '';
/// Should be private. Stores contents of "" tag
var $mHTMLtitle = '';
/// Should be private. Is the displayed content related to the source of the corresponding wiki article.
var $mIsarticle = false;
/**
* Should be private. Has get/set methods properly documented.
* Stores "article flag" toggle.
*/
var $mIsArticleRelated = true;
/**
* Should be private. We have to set isPrintable(). Some pages should
* never be printed (ex: redirections).
*/
var $mPrintable = false;
/**
* Should be private. We have set/get/append methods.
*
* Contains the page subtitle. Special pages usually have some links here.
* Don't confuse with site subtitle added by skins.
*/
private $mSubtitle = array();
var $mRedirect = '';
var $mStatusCode;
/**
* mLastModified and mEtag are used for sending cache control.
* The whole caching system should probably be moved into its own class.
*/
var $mLastModified = '';
/**
* Should be private. No getter but used in sendCacheControl();
* Contains an HTTP Entity Tags (see RFC 2616 section 3.13) which is used
* as a unique identifier for the content. It is later used by the client
* to compare its cached version with the server version. Client sends
* headers If-Match and If-None-Match containing its locally cached ETAG value.
*
* To get more information, you will have to look at HTTP/1.1 protocol which
* is properly described in RFC 2616 : http://tools.ietf.org/html/rfc2616
*/
var $mETag = false;
var $mCategoryLinks = array();
var $mCategories = array();
/// Should be private. Array of Interwiki Prefixed (non DB key) Titles (e.g. 'fr:Test page')
var $mLanguageLinks = array();
/**
* Should be private. Used for JavaScript (pre resource loader)
* We should split js / css.
* mScripts content is inserted as is in "" by Skin. This might
* contains either a link to a stylesheet or inline css.
*/
var $mScripts = '';
/**
* Inline CSS styles. Use addInlineStyle() sparingly
*/
var $mInlineStyles = '';
//
var $mLinkColours;
/**
* Used by skin template.
* Example: $tpl->set( 'displaytitle', $out->mPageLinkTitle );
*/
var $mPageLinkTitle = '';
/// Array of elements in "". Parser might add its own headers!
var $mHeadItems = array();
// @todo FIXME: Next variables probably comes from the resource loader
var $mModules = array(), $mModuleScripts = array(), $mModuleStyles = array(), $mModuleMessages = array();
var $mResourceLoader;
var $mJsConfigVars = array();
/** @todo FIXME: Is this still used ?*/
var $mInlineMsg = array();
var $mTemplateIds = array();
var $mImageTimeKeys = array();
var $mRedirectCode = '';
var $mFeedLinksAppendQuery = null;
# What level of 'untrustworthiness' is allowed in CSS/JS modules loaded on this page?
# @see ResourceLoaderModule::$origin
# ResourceLoaderModule::ORIGIN_ALL is assumed unless overridden;
protected $mAllowedModules = array(
ResourceLoaderModule::TYPE_COMBINED => ResourceLoaderModule::ORIGIN_ALL,
);
/**
* @EasterEgg I just love the name for this self documenting variable.
* @todo document
*/
var $mDoNothing = false;
// Parser related.
var $mContainsOldMagic = 0, $mContainsNewMagic = 0;
/**
* lazy initialised, use parserOptions()
* @var ParserOptions
*/
protected $mParserOptions = null;
/**
* Handles the atom / rss links.
* We probably only support atom in 2011.
* Looks like a private variable.
* @see $wgAdvertisedFeedTypes
*/
var $mFeedLinks = array();
// Gwicke work on squid caching? Roughly from 2003.
var $mEnableClientCache = true;
/**
* Flag if output should only contain the body of the article.
* Should be private.
*/
var $mArticleBodyOnly = false;
var $mNewSectionLink = false;
var $mHideNewSectionLink = false;
/**
* Comes from the parser. This was probably made to load CSS/JS only
* if we had "". Used directly in CategoryPage.php
* Looks like resource loader can replace this.
*/
var $mNoGallery = false;
// should be private.
var $mPageTitleActionText = '';
var $mParseWarnings = array();
// Cache stuff. Looks like mEnableClientCache
var $mSquidMaxage = 0;
// @todo document
var $mPreventClickjacking = true;
/// should be private. To include the variable {{REVISIONID}}
var $mRevisionId = null;
private $mRevisionTimestamp = null;
var $mFileVersion = null;
/**
* An array of stylesheet filenames (relative from skins path), with options
* for CSS media, IE conditions, and RTL/LTR direction.
* For internal use; add settings in the skin via $this->addStyle()
*
* Style again! This seems like a code duplication since we already have
* mStyles. This is what makes OpenSource amazing.
*/
var $styles = array();
/**
* Whether jQuery is already handled.
*/
protected $mJQueryDone = false;
private $mIndexPolicy = 'index';
private $mFollowPolicy = 'follow';
private $mVaryHeader = array(
'Accept-Encoding' => array( 'list-contains=gzip' ),
);
/**
* If the current page was reached through a redirect, $mRedirectedFrom contains the Title
* of the redirect.
*
* @var Title
*/
private $mRedirectedFrom = null;
/**
* Additional key => value data
*/
private $mProperties = array();
/**
* @var string|null: ResourceLoader target for load.php links. If null, will be omitted
*/
private $mTarget = null;
/**
* @var bool: Whether output should contain table of contents
*/
private $mEnableTOC = true;
/**
* Constructor for OutputPage. This should not be called directly.
* Instead a new RequestContext should be created and it will implicitly create
* a OutputPage tied to that context.
*/
function __construct( IContextSource $context = null ) {
if ( $context === null ) {
# Extensions should use `new RequestContext` instead of `new OutputPage` now.
wfDeprecated( __METHOD__, '1.18' );
} else {
$this->setContext( $context );
}
}
/**
* Redirect to $url rather than displaying the normal page
*
* @param string $url URL
* @param string $responsecode HTTP status code
*/
public function redirect( $url, $responsecode = '302' ) {
# Strip newlines as a paranoia check for header injection in PHP<5.1.2
$this->mRedirect = str_replace( "\n", '', $url );
$this->mRedirectCode = $responsecode;
}
/**
* Get the URL to redirect to, or an empty string if not redirect URL set
*
* @return String
*/
public function getRedirect() {
return $this->mRedirect;
}
/**
* Set the HTTP status code to send with the output.
*
* @param $statusCode Integer
*/
public function setStatusCode( $statusCode ) {
$this->mStatusCode = $statusCode;
}
/**
* Add a new "" tag
* To add an http-equiv meta tag, precede the name with "http:"
*
* @param string $name tag name
* @param string $val tag value
*/
function addMeta( $name, $val ) {
array_push( $this->mMetatags, array( $name, $val ) );
}
/**
* Add a new \ tag to the page header.
*
* Note: use setCanonicalUrl() for rel=canonical.
*
* @param array $linkarr associative array of attributes.
*/
function addLink( $linkarr ) {
array_push( $this->mLinktags, $linkarr );
}
/**
* Add a new \ with "rel" attribute set to "meta"
*
* @param array $linkarr associative array mapping attribute names to their
* values, both keys and values will be escaped, and the
* "rel" attribute will be automatically added
*/
function addMetadataLink( $linkarr ) {
$linkarr['rel'] = $this->getMetadataAttribute();
$this->addLink( $linkarr );
}
/**
* Set the URL to be used for the . This should be used
* in preference to addLink(), to avoid duplicate link tags.
*/
function setCanonicalUrl( $url ) {
$this->mCanonicalUrl = $url;
}
/**
* Get the value of the "rel" attribute for metadata links
*
* @return String
*/
public function getMetadataAttribute() {
# note: buggy CC software only reads first "meta" link
static $haveMeta = false;
if ( $haveMeta ) {
return 'alternate meta';
} else {
$haveMeta = true;
return 'meta';
}
}
/**
* Add raw HTML to the list of scripts (including \" to "<script>foo&bar</script>"
# but leave "foobar" alone
$nameWithTags = Sanitizer::normalizeCharReferences( Sanitizer::removeHTMLtags( $name ) );
$this->mPagetitle = $nameWithTags;
# change "foo&bar" to "foo&bar"
$this->setHTMLTitle( $this->msg( 'pagetitle' )->rawParams( Sanitizer::stripAllTags( $nameWithTags ) ) );
}
/**
* Return the "page title", i.e. the content of the \
tag.
*
* @return String
*/
public function getPageTitle() {
return $this->mPagetitle;
}
/**
* Set the Title object to use
*
* @param $t Title object
*/
public function setTitle( Title $t ) {
$this->getContext()->setTitle( $t );
}
/**
* Replace the subtitle with $str
*
* @param string|Message $str new value of the subtitle. String should be safe HTML.
*/
public function setSubtitle( $str ) {
$this->clearSubtitle();
$this->addSubtitle( $str );
}
/**
* Add $str to the subtitle
*
* @deprecated in 1.19; use addSubtitle() instead
* @param string|Message $str to add to the subtitle
*/
public function appendSubtitle( $str ) {
$this->addSubtitle( $str );
}
/**
* Add $str to the subtitle
*
* @param string|Message $str to add to the subtitle. String should be safe HTML.
*/
public function addSubtitle( $str ) {
if ( $str instanceof Message ) {
$this->mSubtitle[] = $str->setContext( $this->getContext() )->parse();
} else {
$this->mSubtitle[] = $str;
}
}
/**
* Add a subtitle containing a backlink to a page
*
* @param $title Title to link to
*/
public function addBacklinkSubtitle( Title $title ) {
$query = array();
if ( $title->isRedirect() ) {
$query['redirect'] = 'no';
}
$this->addSubtitle( $this->msg( 'backlinksubtitle' )->rawParams( Linker::link( $title, null, array(), $query ) ) );
}
/**
* Clear the subtitles
*/
public function clearSubtitle() {
$this->mSubtitle = array();
}
/**
* Get the subtitle
*
* @return String
*/
public function getSubtitle() {
return implode( " \n\t\t\t\t", $this->mSubtitle );
}
/**
* Set the page as printable, i.e. it'll be displayed with with all
* print styles included
*/
public function setPrintable() {
$this->mPrintable = true;
}
/**
* Return whether the page is "printable"
*
* @return Boolean
*/
public function isPrintable() {
return $this->mPrintable;
}
/**
* Disable output completely, i.e. calling output() will have no effect
*/
public function disable() {
$this->mDoNothing = true;
}
/**
* Return whether the output will be completely disabled
*
* @return Boolean
*/
public function isDisabled() {
return $this->mDoNothing;
}
/**
* Show an "add new section" link?
*
* @return Boolean
*/
public function showNewSectionLink() {
return $this->mNewSectionLink;
}
/**
* Forcibly hide the new section link?
*
* @return Boolean
*/
public function forceHideNewSectionLink() {
return $this->mHideNewSectionLink;
}
/**
* Add or remove feed links in the page header
* This is mainly kept for backward compatibility, see OutputPage::addFeedLink()
* for the new version
* @see addFeedLink()
*
* @param $show Boolean: true: add default feeds, false: remove all feeds
*/
public function setSyndicated( $show = true ) {
if ( $show ) {
$this->setFeedAppendQuery( false );
} else {
$this->mFeedLinks = array();
}
}
/**
* Add default feeds to the page header
* This is mainly kept for backward compatibility, see OutputPage::addFeedLink()
* for the new version
* @see addFeedLink()
*
* @param string $val query to append to feed links or false to output
* default links
*/
public function setFeedAppendQuery( $val ) {
global $wgAdvertisedFeedTypes;
$this->mFeedLinks = array();
foreach ( $wgAdvertisedFeedTypes as $type ) {
$query = "feed=$type";
if ( is_string( $val ) ) {
$query .= '&' . $val;
}
$this->mFeedLinks[$type] = $this->getTitle()->getLocalURL( $query );
}
}
/**
* Add a feed link to the page header
*
* @param string $format feed type, should be a key of $wgFeedClasses
* @param string $href URL
*/
public function addFeedLink( $format, $href ) {
global $wgAdvertisedFeedTypes;
if ( in_array( $format, $wgAdvertisedFeedTypes ) ) {
$this->mFeedLinks[$format] = $href;
}
}
/**
* Should we output feed links for this page?
* @return Boolean
*/
public function isSyndicated() {
return count( $this->mFeedLinks ) > 0;
}
/**
* Return URLs for each supported syndication format for this page.
* @return array associating format keys with URLs
*/
public function getSyndicationLinks() {
return $this->mFeedLinks;
}
/**
* Will currently always return null
*
* @return null
*/
public function getFeedAppendQuery() {
return $this->mFeedLinksAppendQuery;
}
/**
* Set whether the displayed content is related to the source of the
* corresponding article on the wiki
* Setting true will cause the change "article related" toggle to true
*
* @param $v Boolean
*/
public function setArticleFlag( $v ) {
$this->mIsarticle = $v;
if ( $v ) {
$this->mIsArticleRelated = $v;
}
}
/**
* Return whether the content displayed page is related to the source of
* the corresponding article on the wiki
*
* @return Boolean
*/
public function isArticle() {
return $this->mIsarticle;
}
/**
* Set whether this page is related an article on the wiki
* Setting false will cause the change of "article flag" toggle to false
*
* @param $v Boolean
*/
public function setArticleRelated( $v ) {
$this->mIsArticleRelated = $v;
if ( !$v ) {
$this->mIsarticle = false;
}
}
/**
* Return whether this page is related an article on the wiki
*
* @return Boolean
*/
public function isArticleRelated() {
return $this->mIsArticleRelated;
}
/**
* Add new language links
*
* @param array $newLinkArray Associative array mapping language code to the page
* name
*/
public function addLanguageLinks( $newLinkArray ) {
$this->mLanguageLinks += $newLinkArray;
}
/**
* Reset the language links and add new language links
*
* @param array $newLinkArray Associative array mapping language code to the page
* name
*/
public function setLanguageLinks( $newLinkArray ) {
$this->mLanguageLinks = $newLinkArray;
}
/**
* Get the list of language links
*
* @return Array of Interwiki Prefixed (non DB key) Titles (e.g. 'fr:Test page')
*/
public function getLanguageLinks() {
return $this->mLanguageLinks;
}
/**
* Add an array of categories, with names in the keys
*
* @param array $categories mapping category name => sort key
*/
public function addCategoryLinks( $categories ) {
global $wgContLang;
if ( !is_array( $categories ) || count( $categories ) == 0 ) {
return;
}
# Add the links to a LinkBatch
$arr = array( NS_CATEGORY => $categories );
$lb = new LinkBatch;
$lb->setArray( $arr );
# Fetch existence plus the hiddencat property
$dbr = wfGetDB( DB_SLAVE );
$res = $dbr->select( array( 'page', 'page_props' ),
array( 'page_id', 'page_namespace', 'page_title', 'page_len', 'page_is_redirect', 'page_latest', 'pp_value' ),
$lb->constructSet( 'page', $dbr ),
__METHOD__,
array(),
array( 'page_props' => array( 'LEFT JOIN', array( 'pp_propname' => 'hiddencat', 'pp_page = page_id' ) ) )
);
# Add the results to the link cache
$lb->addResultToCache( LinkCache::singleton(), $res );
# Set all the values to 'normal'. This can be done with array_fill_keys in PHP 5.2.0+
$categories = array_combine(
array_keys( $categories ),
array_fill( 0, count( $categories ), 'normal' )
);
# Mark hidden categories
foreach ( $res as $row ) {
if ( isset( $row->pp_value ) ) {
$categories[$row->page_title] = 'hidden';
}
}
# Add the remaining categories to the skin
if ( wfRunHooks( 'OutputPageMakeCategoryLinks', array( &$this, $categories, &$this->mCategoryLinks ) ) ) {
foreach ( $categories as $category => $type ) {
$origcategory = $category;
$title = Title::makeTitleSafe( NS_CATEGORY, $category );
$wgContLang->findVariantLink( $category, $title, true );
if ( $category != $origcategory ) {
if ( array_key_exists( $category, $categories ) ) {
continue;
}
}
$text = $wgContLang->convertHtml( $title->getText() );
$this->mCategories[] = $title->getText();
$this->mCategoryLinks[$type][] = Linker::link( $title, $text );
}
}
}
/**
* Reset the category links (but not the category list) and add $categories
*
* @param array $categories mapping category name => sort key
*/
public function setCategoryLinks( $categories ) {
$this->mCategoryLinks = array();
$this->addCategoryLinks( $categories );
}
/**
* Get the list of category links, in a 2-D array with the following format:
* $arr[$type][] = $link, where $type is either "normal" or "hidden" (for
* hidden categories) and $link a HTML fragment with a link to the category
* page
*
* @return Array
*/
public function getCategoryLinks() {
return $this->mCategoryLinks;
}
/**
* Get the list of category names this page belongs to
*
* @return Array of strings
*/
public function getCategories() {
return $this->mCategories;
}
/**
* Do not allow scripts which can be modified by wiki users to load on this page;
* only allow scripts bundled with, or generated by, the software.
*/
public function disallowUserJs() {
$this->reduceAllowedModules(
ResourceLoaderModule::TYPE_SCRIPTS,
ResourceLoaderModule::ORIGIN_CORE_INDIVIDUAL
);
}
/**
* Return whether user JavaScript is allowed for this page
* @deprecated since 1.18 Load modules with ResourceLoader, and origin and
* trustworthiness is identified and enforced automagically.
* @return Boolean
*/
public function isUserJsAllowed() {
wfDeprecated( __METHOD__, '1.18' );
return $this->getAllowedModules( ResourceLoaderModule::TYPE_SCRIPTS ) >= ResourceLoaderModule::ORIGIN_USER_INDIVIDUAL;
}
/**
* Show what level of JavaScript / CSS untrustworthiness is allowed on this page
* @see ResourceLoaderModule::$origin
* @param string $type ResourceLoaderModule TYPE_ constant
* @return Int ResourceLoaderModule ORIGIN_ class constant
*/
public function getAllowedModules( $type ) {
if ( $type == ResourceLoaderModule::TYPE_COMBINED ) {
return min( array_values( $this->mAllowedModules ) );
} else {
return isset( $this->mAllowedModules[$type] )
? $this->mAllowedModules[$type]
: ResourceLoaderModule::ORIGIN_ALL;
}
}
/**
* Set the highest level of CSS/JS untrustworthiness allowed
* @param $type String ResourceLoaderModule TYPE_ constant
* @param $level Int ResourceLoaderModule class constant
*/
public function setAllowedModules( $type, $level ) {
$this->mAllowedModules[$type] = $level;
}
/**
* As for setAllowedModules(), but don't inadvertently make the page more accessible
* @param $type String
* @param $level Int ResourceLoaderModule class constant
*/
public function reduceAllowedModules( $type, $level ) {
$this->mAllowedModules[$type] = min( $this->getAllowedModules( $type ), $level );
}
/**
* Prepend $text to the body HTML
*
* @param string $text HTML
*/
public function prependHTML( $text ) {
$this->mBodytext = $text . $this->mBodytext;
}
/**
* Append $text to the body HTML
*
* @param string $text HTML
*/
public function addHTML( $text ) {
$this->mBodytext .= $text;
}
/**
* Shortcut for adding an Html::element via addHTML.
*
* @since 1.19
*
* @param $element string
* @param $attribs array
* @param $contents string
*/
public function addElement( $element, $attribs = array(), $contents = '' ) {
$this->addHTML( Html::element( $element, $attribs, $contents ) );
}
/**
* Clear the body HTML
*/
public function clearHTML() {
$this->mBodytext = '';
}
/**
* Get the body HTML
*
* @return String: HTML
*/
public function getHTML() {
return $this->mBodytext;
}
/**
* Get/set the ParserOptions object to use for wikitext parsing
*
* @param $options ParserOptions|null either the ParserOption to use or null to only get the
* current ParserOption object
* @return ParserOptions object
*/
public function parserOptions( $options = null ) {
if ( !$this->mParserOptions ) {
$this->mParserOptions = ParserOptions::newFromContext( $this->getContext() );
$this->mParserOptions->setEditSection( false );
}
return wfSetVar( $this->mParserOptions, $options );
}
/**
* Set the revision ID which will be seen by the wiki text parser
* for things such as embedded {{REVISIONID}} variable use.
*
* @param $revid Mixed: an positive integer, or null
* @return Mixed: previous value
*/
public function setRevisionId( $revid ) {
$val = is_null( $revid ) ? null : intval( $revid );
return wfSetVar( $this->mRevisionId, $val );
}
/**
* Get the displayed revision ID
*
* @return Integer
*/
public function getRevisionId() {
return $this->mRevisionId;
}
/**
* Set the timestamp of the revision which will be displayed. This is used
* to avoid a extra DB call in Skin::lastModified().
*
* @param $timestamp Mixed: string, or null
* @return Mixed: previous value
*/
public function setRevisionTimestamp( $timestamp ) {
return wfSetVar( $this->mRevisionTimestamp, $timestamp );
}
/**
* Get the timestamp of displayed revision.
* This will be null if not filled by setRevisionTimestamp().
*
* @return String or null
*/
public function getRevisionTimestamp() {
return $this->mRevisionTimestamp;
}
/**
* Set the displayed file version
*
* @param $file File|bool
* @return Mixed: previous value
*/
public function setFileVersion( $file ) {
$val = null;
if ( $file instanceof File && $file->exists() ) {
$val = array( 'time' => $file->getTimestamp(), 'sha1' => $file->getSha1() );
}
return wfSetVar( $this->mFileVersion, $val, true );
}
/**
* Get the displayed file version
*
* @return Array|null ('time' => MW timestamp, 'sha1' => sha1)
*/
public function getFileVersion() {
return $this->mFileVersion;
}
/**
* Get the templates used on this page
*
* @return Array (namespace => dbKey => revId)
* @since 1.18
*/
public function getTemplateIds() {
return $this->mTemplateIds;
}
/**
* Get the files used on this page
*
* @return Array (dbKey => array('time' => MW timestamp or null, 'sha1' => sha1 or ''))
* @since 1.18
*/
public function getFileSearchOptions() {
return $this->mImageTimeKeys;
}
/**
* Convert wikitext to HTML and add it to the buffer
* Default assumes that the current page title will be used.
*
* @param $text String
* @param $linestart Boolean: is this the start of a line?
* @param $interface Boolean: is this text in the user interface language?
*/
public function addWikiText( $text, $linestart = true, $interface = true ) {
$title = $this->getTitle(); // Work around E_STRICT
if ( !$title ) {
throw new MWException( 'Title is null' );
}
$this->addWikiTextTitle( $text, $title, $linestart, /*tidy*/false, $interface );
}
/**
* Add wikitext with a custom Title object
*
* @param string $text wikitext
* @param $title Title object
* @param $linestart Boolean: is this the start of a line?
*/
public function addWikiTextWithTitle( $text, &$title, $linestart = true ) {
$this->addWikiTextTitle( $text, $title, $linestart );
}
/**
* Add wikitext with a custom Title object and tidy enabled.
*
* @param string $text wikitext
* @param $title Title object
* @param $linestart Boolean: is this the start of a line?
*/
function addWikiTextTitleTidy( $text, &$title, $linestart = true ) {
$this->addWikiTextTitle( $text, $title, $linestart, true );
}
/**
* Add wikitext with tidy enabled
*
* @param string $text wikitext
* @param $linestart Boolean: is this the start of a line?
*/
public function addWikiTextTidy( $text, $linestart = true ) {
$title = $this->getTitle();
$this->addWikiTextTitleTidy( $text, $title, $linestart );
}
/**
* Add wikitext with a custom Title object
*
* @param string $text wikitext
* @param $title Title object
* @param $linestart Boolean: is this the start of a line?
* @param $tidy Boolean: whether to use tidy
* @param $interface Boolean: whether it is an interface message
* (for example disables conversion)
*/
public function addWikiTextTitle( $text, Title $title, $linestart, $tidy = false, $interface = false ) {
global $wgParser;
wfProfileIn( __METHOD__ );
$popts = $this->parserOptions();
$oldTidy = $popts->setTidy( $tidy );
$popts->setInterfaceMessage( (bool)$interface );
$parserOutput = $wgParser->parse(
$text, $title, $popts,
$linestart, true, $this->mRevisionId
);
$popts->setTidy( $oldTidy );
$this->addParserOutput( $parserOutput );
wfProfileOut( __METHOD__ );
}
/**
* Add a ParserOutput object, but without Html
*
* @param $parserOutput ParserOutput object
*/
public function addParserOutputNoText( &$parserOutput ) {
$this->mLanguageLinks += $parserOutput->getLanguageLinks();
$this->addCategoryLinks( $parserOutput->getCategories() );
$this->mNewSectionLink = $parserOutput->getNewSection();
$this->mHideNewSectionLink = $parserOutput->getHideNewSection();
$this->mParseWarnings = $parserOutput->getWarnings();
if ( !$parserOutput->isCacheable() ) {
$this->enableClientCache( false );
}
$this->mNoGallery = $parserOutput->getNoGallery();
$this->mHeadItems = array_merge( $this->mHeadItems, $parserOutput->getHeadItems() );
$this->addModules( $parserOutput->getModules() );
$this->addModuleScripts( $parserOutput->getModuleScripts() );
$this->addModuleStyles( $parserOutput->getModuleStyles() );
$this->addModuleMessages( $parserOutput->getModuleMessages() );
// Template versioning...
foreach ( (array)$parserOutput->getTemplateIds() as $ns => $dbks ) {
if ( isset( $this->mTemplateIds[$ns] ) ) {
$this->mTemplateIds[$ns] = $dbks + $this->mTemplateIds[$ns];
} else {
$this->mTemplateIds[$ns] = $dbks;
}
}
// File versioning...
foreach ( (array)$parserOutput->getFileSearchOptions() as $dbk => $data ) {
$this->mImageTimeKeys[$dbk] = $data;
}
// Hooks registered in the object
global $wgParserOutputHooks;
foreach ( $parserOutput->getOutputHooks() as $hookInfo ) {
list( $hookName, $data ) = $hookInfo;
if ( isset( $wgParserOutputHooks[$hookName] ) ) {
call_user_func( $wgParserOutputHooks[$hookName], $this, $parserOutput, $data );
}
}
// Link flags are ignored for now, but may in the future be
// used to mark individual language links.
$linkFlags = array();
wfRunHooks( 'LanguageLinks', array( $this->getTitle(), &$this->mLanguageLinks, &$linkFlags ) );
wfRunHooks( 'OutputPageParserOutput', array( &$this, $parserOutput ) );
}
/**
* Add a ParserOutput object
*
* @param $parserOutput ParserOutput
*/
function addParserOutput( &$parserOutput ) {
$this->addParserOutputNoText( $parserOutput );
$parserOutput->setTOCEnabled( $this->mEnableTOC );
$text = $parserOutput->getText();
wfRunHooks( 'OutputPageBeforeHTML', array( &$this, &$text ) );
$this->addHTML( $text );
}
/**
* Add the output of a QuickTemplate to the output buffer
*
* @param $template QuickTemplate
*/
public function addTemplate( &$template ) {
ob_start();
$template->execute();
$this->addHTML( ob_get_contents() );
ob_end_clean();
}
/**
* Parse wikitext and return the HTML.
*
* @param $text String
* @param $linestart Boolean: is this the start of a line?
* @param $interface Boolean: use interface language ($wgLang instead of
* $wgContLang) while parsing language sensitive magic
* words like GRAMMAR and PLURAL. This also disables
* LanguageConverter.
* @param $language Language object: target language object, will override
* $interface
* @throws MWException
* @return String: HTML
*/
public function parse( $text, $linestart = true, $interface = false, $language = null ) {
global $wgParser;
if ( is_null( $this->getTitle() ) ) {
throw new MWException( 'Empty $mTitle in ' . __METHOD__ );
}
$popts = $this->parserOptions();
if ( $interface ) {
$popts->setInterfaceMessage( true );
}
if ( $language !== null ) {
$oldLang = $popts->setTargetLanguage( $language );
}
$parserOutput = $wgParser->parse(
$text, $this->getTitle(), $popts,
$linestart, true, $this->mRevisionId
);
if ( $interface ) {
$popts->setInterfaceMessage( false );
}
if ( $language !== null ) {
$popts->setTargetLanguage( $oldLang );
}
return $parserOutput->getText();
}
/**
* Parse wikitext, strip paragraphs, and return the HTML.
*
* @param $text String
* @param $linestart Boolean: is this the start of a line?
* @param $interface Boolean: use interface language ($wgLang instead of
* $wgContLang) while parsing language sensitive magic
* words like GRAMMAR and PLURAL
* @return String: HTML
*/
public function parseInline( $text, $linestart = true, $interface = false ) {
$parsed = $this->parse( $text, $linestart, $interface );
$m = array();
if ( preg_match( '/^
(.*)\n?<\/p>\n?/sU', $parsed, $m ) ) {
$parsed = $m[1];
}
return $parsed;
}
/**
* Set the value of the "s-maxage" part of the "Cache-control" HTTP header
*
* @param $maxage Integer: maximum cache time on the Squid, in seconds.
*/
public function setSquidMaxage( $maxage ) {
$this->mSquidMaxage = $maxage;
}
/**
* Use enableClientCache(false) to force it to send nocache headers
*
* @param $state bool
*
* @return bool
*/
public function enableClientCache( $state ) {
return wfSetVar( $this->mEnableClientCache, $state );
}
/**
* Get the list of cookies that will influence on the cache
*
* @return Array
*/
function getCacheVaryCookies() {
global $wgCookiePrefix, $wgCacheVaryCookies;
static $cookies;
if ( $cookies === null ) {
$cookies = array_merge(
array(
"{$wgCookiePrefix}Token",
"{$wgCookiePrefix}LoggedOut",
"forceHTTPS",
session_name()
),
$wgCacheVaryCookies
);
wfRunHooks( 'GetCacheVaryCookies', array( $this, &$cookies ) );
}
return $cookies;
}
/**
* Check if the request has a cache-varying cookie header
* If it does, it's very important that we don't allow public caching
*
* @return Boolean
*/
function haveCacheVaryCookies() {
$cookieHeader = $this->getRequest()->getHeader( 'cookie' );
if ( $cookieHeader === false ) {
return false;
}
$cvCookies = $this->getCacheVaryCookies();
foreach ( $cvCookies as $cookieName ) {
# Check for a simple string match, like the way squid does it
if ( strpos( $cookieHeader, $cookieName ) !== false ) {
wfDebug( __METHOD__ . ": found $cookieName\n" );
return true;
}
}
wfDebug( __METHOD__ . ": no cache-varying cookies found\n" );
return false;
}
/**
* Add an HTTP header that will influence on the cache
*
* @param string $header header name
* @param $option Array|null
* @todo FIXME: Document the $option parameter; it appears to be for
* X-Vary-Options but what format is acceptable?
*/
public function addVaryHeader( $header, $option = null ) {
if ( !array_key_exists( $header, $this->mVaryHeader ) ) {
$this->mVaryHeader[$header] = (array)$option;
} elseif ( is_array( $option ) ) {
if ( is_array( $this->mVaryHeader[$header] ) ) {
$this->mVaryHeader[$header] = array_merge( $this->mVaryHeader[$header], $option );
} else {
$this->mVaryHeader[$header] = $option;
}
}
$this->mVaryHeader[$header] = array_unique( (array)$this->mVaryHeader[$header] );
}
/**
* Return a Vary: header on which to vary caches. Based on the keys of $mVaryHeader,
* such as Accept-Encoding or Cookie
*
* @return String
*/
public function getVaryHeader() {
return 'Vary: ' . join( ', ', array_keys( $this->mVaryHeader ) );
}
/**
* Get a complete X-Vary-Options header
*
* @return String
*/
public function getXVO() {
$cvCookies = $this->getCacheVaryCookies();
$cookiesOption = array();
foreach ( $cvCookies as $cookieName ) {
$cookiesOption[] = 'string-contains=' . $cookieName;
}
$this->addVaryHeader( 'Cookie', $cookiesOption );
$headers = array();
foreach ( $this->mVaryHeader as $header => $option ) {
$newheader = $header;
if ( is_array( $option ) && count( $option ) > 0 ) {
$newheader .= ';' . implode( ';', $option );
}
$headers[] = $newheader;
}
$xvo = 'X-Vary-Options: ' . implode( ',', $headers );
return $xvo;
}
/**
* bug 21672: Add Accept-Language to Vary and XVO headers
* if there's no 'variant' parameter existed in GET.
*
* For example:
* /w/index.php?title=Main_page should always be served; but
* /w/index.php?title=Main_page&variant=zh-cn should never be served.
*/
function addAcceptLanguage() {
$lang = $this->getTitle()->getPageLanguage();
if ( !$this->getRequest()->getCheck( 'variant' ) && $lang->hasVariants() ) {
$variants = $lang->getVariants();
$aloption = array();
foreach ( $variants as $variant ) {
if ( $variant === $lang->getCode() ) {
continue;
} else {
$aloption[] = 'string-contains=' . $variant;
// IE and some other browsers use BCP 47 standards in
// their Accept-Language header, like "zh-CN" or "zh-Hant".
// We should handle these too.
$variantBCP47 = wfBCP47( $variant );
if ( $variantBCP47 !== $variant ) {
$aloption[] = 'string-contains=' . $variantBCP47;
}
}
}
$this->addVaryHeader( 'Accept-Language', $aloption );
}
}
/**
* Set a flag which will cause an X-Frame-Options header appropriate for
* edit pages to be sent. The header value is controlled by
* $wgEditPageFrameOptions.
*
* This is the default for special pages. If you display a CSRF-protected
* form on an ordinary view page, then you need to call this function.
*
* @param $enable bool
*/
public function preventClickjacking( $enable = true ) {
$this->mPreventClickjacking = $enable;
}
/**
* Turn off frame-breaking. Alias for $this->preventClickjacking(false).
* This can be called from pages which do not contain any CSRF-protected
* HTML form.
*/
public function allowClickjacking() {
$this->mPreventClickjacking = false;
}
/**
* Get the X-Frame-Options header value (without the name part), or false
* if there isn't one. This is used by Skin to determine whether to enable
* JavaScript frame-breaking, for clients that don't support X-Frame-Options.
*
* @return string
*/
public function getFrameOptions() {
global $wgBreakFrames, $wgEditPageFrameOptions;
if ( $wgBreakFrames ) {
return 'DENY';
} elseif ( $this->mPreventClickjacking && $wgEditPageFrameOptions ) {
return $wgEditPageFrameOptions;
}
return false;
}
/**
* Send cache control HTTP headers
*/
public function sendCacheControl() {
global $wgUseSquid, $wgUseESI, $wgUseETag, $wgSquidMaxage, $wgUseXVO;
$response = $this->getRequest()->response();
if ( $wgUseETag && $this->mETag ) {
$response->header( "ETag: $this->mETag" );
}
$this->addVaryHeader( 'Cookie' );
$this->addAcceptLanguage();
# don't serve compressed data to clients who can't handle it
# maintain different caches for logged-in users and non-logged in ones
$response->header( $this->getVaryHeader() );
if ( $wgUseXVO ) {
# Add an X-Vary-Options header for Squid with Wikimedia patches
$response->header( $this->getXVO() );
}
if ( $this->mEnableClientCache ) {
if (
$wgUseSquid && session_id() == '' && !$this->isPrintable() &&
$this->mSquidMaxage != 0 && !$this->haveCacheVaryCookies()
) {
if ( $wgUseESI ) {
# We'll purge the proxy cache explicitly, but require end user agents
# to revalidate against the proxy on each visit.
# Surrogate-Control controls our Squid, Cache-Control downstream caches
wfDebug( __METHOD__ . ": proxy caching with ESI; {$this->mLastModified} **\n", false );
# start with a shorter timeout for initial testing
# header( 'Surrogate-Control: max-age=2678400+2678400, content="ESI/1.0"');
$response->header( 'Surrogate-Control: max-age=' . $wgSquidMaxage . '+' . $this->mSquidMaxage . ', content="ESI/1.0"' );
$response->header( 'Cache-Control: s-maxage=0, must-revalidate, max-age=0' );
} else {
# We'll purge the proxy cache for anons explicitly, but require end user agents
# to revalidate against the proxy on each visit.
# IMPORTANT! The Squid needs to replace the Cache-Control header with
# Cache-Control: s-maxage=0, must-revalidate, max-age=0
wfDebug( __METHOD__ . ": local proxy caching; {$this->mLastModified} **\n", false );
# start with a shorter timeout for initial testing
# header( "Cache-Control: s-maxage=2678400, must-revalidate, max-age=0" );
$response->header( 'Cache-Control: s-maxage=' . $this->mSquidMaxage . ', must-revalidate, max-age=0' );
}
} else {
# We do want clients to cache if they can, but they *must* check for updates
# on revisiting the page.
wfDebug( __METHOD__ . ": private caching; {$this->mLastModified} **\n", false );
$response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
$response->header( "Cache-Control: private, must-revalidate, max-age=0" );
}
if ( $this->mLastModified ) {
$response->header( "Last-Modified: {$this->mLastModified}" );
}
} else {
wfDebug( __METHOD__ . ": no caching **\n", false );
# In general, the absence of a last modified header should be enough to prevent
# the client from using its cache. We send a few other things just to make sure.
$response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
$response->header( 'Cache-Control: no-cache, no-store, max-age=0, must-revalidate' );
$response->header( 'Pragma: no-cache' );
}
}
/**
* Get the message associated with the HTTP response code $code
*
* @param $code Integer: status code
* @return String or null: message or null if $code is not in the list of
* messages
*
* @deprecated since 1.18 Use HttpStatus::getMessage() instead.
*/
public static function getStatusMessage( $code ) {
wfDeprecated( __METHOD__, '1.18' );
return HttpStatus::getMessage( $code );
}
/**
* Finally, all the text has been munged and accumulated into
* the object, let's actually output it:
*/
public function output() {
global $wgLanguageCode, $wgDebugRedirects, $wgMimeType, $wgVaryOnXFP,
$wgUseAjax, $wgResponsiveImages;
if ( $this->mDoNothing ) {
return;
}
wfProfileIn( __METHOD__ );
$response = $this->getRequest()->response();
if ( $this->mRedirect != '' ) {
# Standards require redirect URLs to be absolute
$this->mRedirect = wfExpandUrl( $this->mRedirect, PROTO_CURRENT );
$redirect = $this->mRedirect;
$code = $this->mRedirectCode;
if ( wfRunHooks( "BeforePageRedirect", array( $this, &$redirect, &$code ) ) ) {
if ( $code == '301' || $code == '303' ) {
if ( !$wgDebugRedirects ) {
$message = HttpStatus::getMessage( $code );
$response->header( "HTTP/1.1 $code $message" );
}
$this->mLastModified = wfTimestamp( TS_RFC2822 );
}
if ( $wgVaryOnXFP ) {
$this->addVaryHeader( 'X-Forwarded-Proto' );
}
$this->sendCacheControl();
$response->header( "Content-Type: text/html; charset=utf-8" );
if ( $wgDebugRedirects ) {
$url = htmlspecialchars( $redirect );
print "\n
\n";
print "\n\n";
} else {
$response->header( 'Location: ' . $redirect );
}
}
wfProfileOut( __METHOD__ );
return;
} elseif ( $this->mStatusCode ) {
$message = HttpStatus::getMessage( $this->mStatusCode );
if ( $message ) {
$response->header( 'HTTP/1.1 ' . $this->mStatusCode . ' ' . $message );
}
}
# Buffer output; final headers may depend on later processing
ob_start();
$response->header( "Content-type: $wgMimeType; charset=UTF-8" );
$response->header( 'Content-language: ' . $wgLanguageCode );
// Prevent framing, if requested
$frameOptions = $this->getFrameOptions();
if ( $frameOptions ) {
$response->header( "X-Frame-Options: $frameOptions" );
}
if ( $this->mArticleBodyOnly ) {
echo $this->mBodytext;
} else {
$sk = $this->getSkin();
// add skin specific modules
$modules = $sk->getDefaultModules();
// enforce various default modules for all skins
$coreModules = array(
// keep this list as small as possible
'mediawiki.page.startup',
'mediawiki.user',
);
// Support for high-density display images if enabled
if ( $wgResponsiveImages ) {
$coreModules[] = 'mediawiki.hidpi';
}
$this->addModules( $coreModules );
foreach ( $modules as $group ) {
$this->addModules( $group );
}
MWDebug::addModules( $this );
if ( $wgUseAjax ) {
// FIXME: deprecate? - not clear why this is useful
wfRunHooks( 'AjaxAddScript', array( &$this ) );
}
// Hook that allows last minute changes to the output page, e.g.
// adding of CSS or Javascript by extensions.
wfRunHooks( 'BeforePageDisplay', array( &$this, &$sk ) );
wfProfileIn( 'Output-skin' );
$sk->outputPage();
wfProfileOut( 'Output-skin' );
}
// This hook allows last minute changes to final overall output by modifying output buffer
wfRunHooks( 'AfterFinalPageOutput', array( $this ) );
$this->sendCacheControl();
ob_end_flush();
wfProfileOut( __METHOD__ );
}
/**
* Actually output something with print.
*
* @param string $ins the string to output
* @deprecated since 1.22 Use echo yourself.
*/
public function out( $ins ) {
wfDeprecated( __METHOD__, '1.22' );
print $ins;
}
/**
* Produce a "user is blocked" page.
* @deprecated since 1.18
*/
function blockedPage() {
throw new UserBlockedError( $this->getUser()->mBlock );
}
/**
* Prepare this object to display an error page; disable caching and
* indexing, clear the current text and redirect, set the page's title
* and optionally an custom HTML title (content of the "" tag).
*
* @param string|Message $pageTitle will be passed directly to setPageTitle()
* @param string|Message $htmlTitle will be passed directly to setHTMLTitle();
* optional, if not passed the "" attribute will be
* based on $pageTitle
*/
public function prepareErrorPage( $pageTitle, $htmlTitle = false ) {
$this->setPageTitle( $pageTitle );
if ( $htmlTitle !== false ) {
$this->setHTMLTitle( $htmlTitle );
}
$this->setRobotPolicy( 'noindex,nofollow' );
$this->setArticleRelated( false );
$this->enableClientCache( false );
$this->mRedirect = '';
$this->clearSubtitle();
$this->clearHTML();
}
/**
* Output a standard error page
*
* showErrorPage( 'titlemsg', 'pagetextmsg', array( 'param1', 'param2' ) );
* showErrorPage( 'titlemsg', $messageObject );
* showErrorPage( $titleMessageObj, $messageObject );
*
* @param $title Mixed: message key (string) for page title, or a Message object
* @param $msg Mixed: message key (string) for page text, or a Message object
* @param array $params message parameters; ignored if $msg is a Message object
*/
public function showErrorPage( $title, $msg, $params = array() ) {
if ( !$title instanceof Message ) {
$title = $this->msg( $title );
}
$this->prepareErrorPage( $title );
if ( $msg instanceof Message ) {
$this->addHTML( $msg->parseAsBlock() );
} else {
$this->addWikiMsgArray( $msg, $params );
}
$this->returnToMain();
}
/**
* Output a standard permission error page
*
* @param array $errors error message keys
* @param string $action action that was denied or null if unknown
*/
public function showPermissionsErrorPage( $errors, $action = null ) {
// For some action (read, edit, create and upload), display a "login to do this action"
// error if all of the following conditions are met:
// 1. the user is not logged in
// 2. the only error is insufficient permissions (i.e. no block or something else)
// 3. the error can be avoided simply by logging in
if ( in_array( $action, array( 'read', 'edit', 'createpage', 'createtalk', 'upload' ) )
&& $this->getUser()->isAnon() && count( $errors ) == 1 && isset( $errors[0][0] )
&& ( $errors[0][0] == 'badaccess-groups' || $errors[0][0] == 'badaccess-group0' )
&& ( User::groupHasPermission( 'user', $action )
|| User::groupHasPermission( 'autoconfirmed', $action ) )
) {
$displayReturnto = null;
# Due to bug 32276, if a user does not have read permissions,
# $this->getTitle() will just give Special:Badtitle, which is
# not especially useful as a returnto parameter. Use the title
# from the request instead, if there was one.
$request = $this->getRequest();
$returnto = Title::newFromURL( $request->getVal( 'title', '' ) );
if ( $action == 'edit' ) {
$msg = 'whitelistedittext';
$displayReturnto = $returnto;
} elseif ( $action == 'createpage' || $action == 'createtalk' ) {
$msg = 'nocreatetext';
} elseif ( $action == 'upload' ) {
$msg = 'uploadnologintext';
} else { # Read
$msg = 'loginreqpagetext';
$displayReturnto = Title::newMainPage();
}
$query = array();
if ( $returnto ) {
$query['returnto'] = $returnto->getPrefixedText();
if ( !$request->wasPosted() ) {
$returntoquery = $request->getValues();
unset( $returntoquery['title'] );
unset( $returntoquery['returnto'] );
unset( $returntoquery['returntoquery'] );
$query['returntoquery'] = wfArrayToCgi( $returntoquery );
}
}
$loginLink = Linker::linkKnown(
SpecialPage::getTitleFor( 'Userlogin' ),
$this->msg( 'loginreqlink' )->escaped(),
array(),
$query
);
$this->prepareErrorPage( $this->msg( 'loginreqtitle' ) );
$this->addHTML( $this->msg( $msg )->rawParams( $loginLink )->parse() );
# Don't return to a page the user can't read otherwise
# we'll end up in a pointless loop
if ( $displayReturnto && $displayReturnto->userCan( 'read', $this->getUser() ) ) {
$this->returnToMain( null, $displayReturnto );
}
} else {
$this->prepareErrorPage( $this->msg( 'permissionserrors' ) );
$this->addWikiText( $this->formatPermissionsErrorMessage( $errors, $action ) );
}
}
/**
* Display an error page indicating that a given version of MediaWiki is
* required to use it
*
* @param $version Mixed: the version of MediaWiki needed to use the page
*/
public function versionRequired( $version ) {
$this->prepareErrorPage( $this->msg( 'versionrequired', $version ) );
$this->addWikiMsg( 'versionrequiredtext', $version );
$this->returnToMain();
}
/**
* Display an error page noting that a given permission bit is required.
* @deprecated since 1.18, just throw the exception directly
* @param string $permission key required
* @throws PermissionsError
*/
public function permissionRequired( $permission ) {
throw new PermissionsError( $permission );
}
/**
* Produce the stock "please login to use the wiki" page
*
* @deprecated in 1.19; throw the exception directly
*/
public function loginToUse() {
throw new PermissionsError( 'read' );
}
/**
* Format a list of error messages
*
* @param array $errors of arrays returned by Title::getUserPermissionsErrors
* @param string $action action that was denied or null if unknown
* @return String: the wikitext error-messages, formatted into a list.
*/
public function formatPermissionsErrorMessage( $errors, $action = null ) {
if ( $action == null ) {
$text = $this->msg( 'permissionserrorstext', count( $errors ) )->plain() . "\n\n";
} else {
$action_desc = $this->msg( "action-$action" )->plain();
$text = $this->msg(
'permissionserrorstext-withaction',
count( $errors ),
$action_desc
)->plain() . "\n\n";
}
if ( count( $errors ) > 1 ) {
$text .= '
";
}
return $text;
}
/**
* Display a page stating that the Wiki is in read-only mode,
* and optionally show the source of the page that the user
* was trying to edit. Should only be called (for this
* purpose) after wfReadOnly() has returned true.
*
* For historical reasons, this function is _also_ used to
* show the error message when a user tries to edit a page
* they are not allowed to edit. (Unless it's because they're
* blocked, then we show blockedPage() instead.) In this
* case, the second parameter should be set to true and a list
* of reasons supplied as the third parameter.
*
* @todo Needs to be split into multiple functions.
*
* @param $source String: source code to show (or null).
* @param $protected Boolean: is this a permissions error?
* @param $reasons Array: list of reasons for this error, as returned by Title::getUserPermissionsErrors().
* @param $action String: action that was denied or null if unknown
* @throws ReadOnlyError
*/
public function readOnlyPage( $source = null, $protected = false, $reasons = array(), $action = null ) {
$this->setRobotPolicy( 'noindex,nofollow' );
$this->setArticleRelated( false );
// If no reason is given, just supply a default "I can't let you do
// that, Dave" message. Should only occur if called by legacy code.
if ( $protected && empty( $reasons ) ) {
$reasons[] = array( 'badaccess-group0' );
}
if ( !empty( $reasons ) ) {
// Permissions error
if ( $source ) {
$this->setPageTitle( $this->msg( 'viewsource-title', $this->getTitle()->getPrefixedText() ) );
$this->addBacklinkSubtitle( $this->getTitle() );
} else {
$this->setPageTitle( $this->msg( 'badaccess' ) );
}
$this->addWikiText( $this->formatPermissionsErrorMessage( $reasons, $action ) );
} else {
// Wiki is read only
throw new ReadOnlyError;
}
// Show source, if supplied
if ( is_string( $source ) ) {
$this->addWikiMsg( 'viewsourcetext' );
$pageLang = $this->getTitle()->getPageLanguage();
$params = array(
'id' => 'wpTextbox1',
'name' => 'wpTextbox1',
'cols' => $this->getUser()->getOption( 'cols' ),
'rows' => $this->getUser()->getOption( 'rows' ),
'readonly' => 'readonly',
'lang' => $pageLang->getHtmlCode(),
'dir' => $pageLang->getDir(),
);
$this->addHTML( Html::element( 'textarea', $params, $source ) );
// Show templates used by this article
$templates = Linker::formatTemplates( $this->getTitle()->getTemplateLinksFrom() );
$this->addHTML( "
$templates
" );
}
# If the title doesn't exist, it's fairly pointless to print a return
# link to it. After all, you just tried editing it and couldn't, so
# what's there to do there?
if ( $this->getTitle()->exists() ) {
$this->returnToMain( null, $this->getTitle() );
}
}
/**
* Turn off regular page output and return an error response
* for when rate limiting has triggered.
*/
public function rateLimited() {
throw new ThrottledError;
}
/**
* Show a warning about slave lag
*
* If the lag is higher than $wgSlaveLagCritical seconds,
* then the warning is a bit more obvious. If the lag is
* lower than $wgSlaveLagWarning, then no warning is shown.
*
* @param $lag Integer: slave lag
*/
public function showLagWarning( $lag ) {
global $wgSlaveLagWarning, $wgSlaveLagCritical;
if ( $lag >= $wgSlaveLagWarning ) {
$message = $lag < $wgSlaveLagCritical
? 'lag-warn-normal'
: 'lag-warn-high';
$wrap = Html::rawElement( 'div', array( 'class' => "mw-{$message}" ), "\n$1\n" );
$this->wrapWikiMsg( "$wrap\n", array( $message, $this->getLanguage()->formatNum( $lag ) ) );
}
}
public function showFatalError( $message ) {
$this->prepareErrorPage( $this->msg( 'internalerror' ) );
$this->addHTML( $message );
}
public function showUnexpectedValueError( $name, $val ) {
$this->showFatalError( $this->msg( 'unexpected', $name, $val )->text() );
}
public function showFileCopyError( $old, $new ) {
$this->showFatalError( $this->msg( 'filecopyerror', $old, $new )->text() );
}
public function showFileRenameError( $old, $new ) {
$this->showFatalError( $this->msg( 'filerenameerror', $old, $new )->text() );
}
public function showFileDeleteError( $name ) {
$this->showFatalError( $this->msg( 'filedeleteerror', $name )->text() );
}
public function showFileNotFoundError( $name ) {
$this->showFatalError( $this->msg( 'filenotfound', $name )->text() );
}
/**
* Add a "return to" link pointing to a specified title
*
* @param $title Title to link
* @param array $query query string parameters
* @param string $text text of the link (input is not escaped)
* @param $options Options array to pass to Linker
*/
public function addReturnTo( $title, $query = array(), $text = null, $options = array() ) {
$link = $this->msg( 'returnto' )->rawParams(
Linker::link( $title, $text, array(), $query, $options ) )->escaped();
$this->addHTML( "
{$link}
\n" );
}
/**
* Add a "return to" link pointing to a specified title,
* or the title indicated in the request, or else the main page
*
* @param $unused
* @param $returnto Title or String to return to
* @param string $returntoquery query string for the return to link
*/
public function returnToMain( $unused = null, $returnto = null, $returntoquery = null ) {
if ( $returnto == null ) {
$returnto = $this->getRequest()->getText( 'returnto' );
}
if ( $returntoquery == null ) {
$returntoquery = $this->getRequest()->getText( 'returntoquery' );
}
if ( $returnto === '' ) {
$returnto = Title::newMainPage();
}
if ( is_object( $returnto ) ) {
$titleObj = $returnto;
} else {
$titleObj = Title::newFromText( $returnto );
}
if ( !is_object( $titleObj ) ) {
$titleObj = Title::newMainPage();
}
$this->addReturnTo( $titleObj, wfCgiToArray( $returntoquery ) );
}
/**
* @param $sk Skin The given Skin
* @param $includeStyle Boolean: unused
* @return String: The doctype, opening "", and head element.
*/
public function headElement( Skin $sk, $includeStyle = true ) {
global $wgContLang, $wgMimeType;
$userdir = $this->getLanguage()->getDir();
$sitedir = $wgContLang->getDir();
$ret = Html::htmlHeader( array( 'lang' => $this->getLanguage()->getHtmlCode(), 'dir' => $userdir, 'class' => 'client-nojs' ) );
if ( $this->getHTMLTitle() == '' ) {
$this->setHTMLTitle( $this->msg( 'pagetitle', $this->getPageTitle() ) );
}
$openHead = Html::openElement( 'head' );
if ( $openHead ) {
# Don't bother with the newline if $head == ''
$ret .= "$openHead\n";
}
if ( !Html::isXmlMimeType( $wgMimeType ) ) {
// Add
// This should be before since it defines the charset used by
// text including the text inside .
// The spec recommends defining XHTML5's charset using the XML declaration
// instead of meta.
// Our XML declaration is output by Html::htmlHeader.
// http://www.whatwg.org/html/semantics.html#attr-meta-http-equiv-content-type
// http://www.whatwg.org/html/semantics.html#charset
$ret .= Html::element( 'meta', array( 'charset' => 'UTF-8' ) );
}
$ret .= Html::element( 'title', null, $this->getHTMLTitle() ) . "\n";
$ret .= implode( "\n", array(
$this->getHeadLinks(),
$this->buildCssLinks(),
$this->getHeadScripts(),
$this->getHeadItems()
) );
$closeHead = Html::closeElement( 'head' );
if ( $closeHead ) {
$ret .= "$closeHead\n";
}
$bodyClasses = array();
$bodyClasses[] = 'mediawiki';
# Classes for LTR/RTL directionality support
$bodyClasses[] = $userdir;
$bodyClasses[] = "sitedir-$sitedir";
if ( $this->getLanguage()->capitalizeAllNouns() ) {
# A class is probably not the best way to do this . . .
$bodyClasses[] = 'capitalize-all-nouns';
}
$bodyClasses[] = $sk->getPageClasses( $this->getTitle() );
$bodyClasses[] = 'skin-' . Sanitizer::escapeClass( $sk->getSkinName() );
$bodyClasses[] = 'action-' . Sanitizer::escapeClass( Action::getActionName( $this->getContext() ) );
$bodyAttrs = array();
// While the implode() is not strictly needed, it's used for backwards compatibility
// (this used to be built as a string and hooks likely still expect that).
$bodyAttrs['class'] = implode( ' ', $bodyClasses );
// Allow skins and extensions to add body attributes they need
$sk->addToBodyAttributes( $this, $bodyAttrs );
wfRunHooks( 'OutputPageBodyAttributes', array( $this, $sk, &$bodyAttrs ) );
$ret .= Html::openElement( 'body', $bodyAttrs ) . "\n";
return $ret;
}
/**
* Get a ResourceLoader object associated with this OutputPage
*
* @return ResourceLoader
*/
public function getResourceLoader() {
if ( is_null( $this->mResourceLoader ) ) {
$this->mResourceLoader = new ResourceLoader();
}
return $this->mResourceLoader;
}
/**
* TODO: Document
* @param $modules Array/string with the module name(s)
* @param string $only ResourceLoaderModule TYPE_ class constant
* @param $useESI boolean
* @param array $extraQuery with extra query parameters to add to each request. array( param => value )
* @param $loadCall boolean If true, output an (asynchronous) mw.loader.load() call rather than a "