X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/mediawiki.git/blobdiff_plain/dc9cc5d707f5a612938cc9371614cc41c328fda2..ed929caf35b91662df31b9ee922286ddea5659cb:/includes/OutputPage.php
diff --git a/includes/OutputPage.php b/includes/OutputPage.php
index ed9a43d3..207af21d 100644
--- a/includes/OutputPage.php
+++ b/includes/OutputPage.php
@@ -1,6 +1,7 @@
array( 'list-contains=gzip' ),
+ 'Cookie' => null
+ );
/**
* Constructor
@@ -55,12 +80,23 @@ class OutputPage {
$this->mAllowUserJs = $wgAllowUserJs;
}
+ /**
+ * Redirect to $url rather than displaying the normal page
+ *
+ * @param $url String: URL
+ * @param $responsecode String: 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;
}
@@ -68,10 +104,12 @@ class OutputPage {
/**
* Set the HTTP status code to send with the output.
*
- * @param int $statusCode
+ * @param $statusCode Integer
* @return nothing
*/
- function setStatusCode( $statusCode ) { $this->mStatusCode = $statusCode; }
+ public function setStatusCode( $statusCode ) {
+ $this->mStatusCode = $statusCode;
+ }
/**
* Add a new tag
@@ -84,41 +122,195 @@ class OutputPage {
array_push( $this->mMetatags, array( $name, $val ) );
}
- function addKeyword( $text ) { array_push( $this->mKeywords, $text ); }
- function addScript( $script ) { $this->mScripts .= "\t\t".$script; }
-
- function addExtensionStyle( $url ) {
- $linkarr = array( 'rel' => 'stylesheet', 'href' => $url, 'type' => 'text/css' );
- array_push( $this->mExtStyles, $linkarr );
+ /**
+ * Add a keyword or a list of keywords in the page header
+ *
+ * @param $text String or array of strings
+ */
+ function addKeyword( $text ) {
+ if( is_array( $text ) ) {
+ $this->mKeywords = array_merge( $this->mKeywords, $text );
+ } else {
+ array_push( $this->mKeywords, $text );
+ }
+ }
+
+ /**
+ * Add a new \ tag to the page header
+ *
+ * @param $linkarr Array: associative array of attributes.
+ */
+ function addLink( $linkarr ) {
+ array_push( $this->mLinktags, $linkarr );
+ }
+
+ /**
+ * Add a new \ with "rel" attribute set to "meta"
+ *
+ * @param $linkarr Array: 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 ) {
+ # note: buggy CC software only reads first "meta" link
+ static $haveMeta = false;
+ $linkarr['rel'] = $haveMeta ? 'alternate meta' : 'meta';
+ $this->addLink( $linkarr );
+ $haveMeta = true;
+ }
+
+ /**
+ * Add raw HTML to the list of scripts (including \ tag, etc.)
+ *
+ * @param $script String: raw HTML
+ */
+ function addScript( $script ) {
+ $this->mScripts .= $script . "\n";
+ }
+
+ /**
+ * Register and add a stylesheet from an extension directory.
+ *
+ * @param $url String path to sheet. Provide either a full url (beginning
+ * with 'http', etc) or a relative path from the document root
+ * (beginning with '/'). Otherwise it behaves identically to
+ * addStyle() and draws from the /skins folder.
+ */
+ public function addExtensionStyle( $url ) {
+ array_push( $this->mExtStyles, $url );
+ }
+
+ /**
+ * Get all links added by extensions
+ *
+ * @return Array
+ */
+ function getExtStyle() {
+ return $this->mExtStyles;
}
/**
* Add a JavaScript file out of skins/common, or a given relative path.
- * @param string $file filename in skins/common or complete on-server path (/foo/bar.js)
+ *
+ * @param $file String: filename in skins/common or complete on-server path
+ * (/foo/bar.js)
+ * @param $version String: style version of the file. Defaults to $wgStyleVersion
*/
- function addScriptFile( $file ) {
- global $wgStylePath, $wgStyleVersion, $wgJsMimeType;
- if( substr( $file, 0, 1 ) == '/' ) {
+ public function addScriptFile( $file, $version = null ) {
+ global $wgStylePath, $wgStyleVersion;
+ // See if $file parameter is an absolute URL or begins with a slash
+ if( substr( $file, 0, 1 ) == '/' || preg_match( '#^[a-z]*://#i', $file ) ) {
$path = $file;
} else {
- $path = "{$wgStylePath}/common/{$file}";
+ $path = "{$wgStylePath}/common/{$file}";
}
- $this->addScript( "\n" );
+ if ( is_null( $version ) )
+ $version = $wgStyleVersion;
+ $this->addScript( Html::linkedScript( wfAppendQuery( $path, $version ) ) );
}
-
+
/**
* Add a self-contained script tag with the given contents
- * @param string $script JavaScript text, no ";
+ public function addInlineScript( $script ) {
+ $this->mScripts .= Html::inlineScript( "\n$script\n" ) . "\n";
}
+ /**
+ * Get all registered JS and CSS tags for the header.
+ *
+ * @return String
+ */
function getScript() {
return $this->mScripts . $this->getHeadItems();
}
+ /**
+ * Get the list of modules to include on this page
+ *
+ * @return Array of module names
+ */
+ public function getModules() {
+ return array_values( array_unique( $this->mModules ) );
+ }
+
+ /**
+ * Add one or more modules recognized by the resource loader. Modules added
+ * through this function will be loaded by the resource loader when the
+ * page loads.
+ *
+ * @param $modules Mixed: module name (string) or array of module names
+ */
+ public function addModules( $modules ) {
+ $this->mModules = array_merge( $this->mModules, (array)$modules );
+ }
+
+ /**
+ * Get the list of module JS to include on this page
+ * @return array of module names
+ */
+ public function getModuleScripts() {
+ return array_values( array_unique( $this->mModuleScripts ) );
+ }
+
+ /**
+ * Add only JS of one or more modules recognized by the resource loader. Module
+ * scripts added through this function will be loaded by the resource loader when
+ * the page loads.
+ *
+ * @param $modules Mixed: module name (string) or array of module names
+ */
+ public function addModuleScripts( $modules ) {
+ $this->mModuleScripts = array_merge( $this->mModuleScripts, (array)$modules );
+ }
+
+ /**
+ * Get the list of module CSS to include on this page
+ *
+ * @return Array of module names
+ */
+ public function getModuleStyles() {
+ return array_values( array_unique( $this->mModuleStyles ) );
+ }
+
+ /**
+ * Add only CSS of one or more modules recognized by the resource loader. Module
+ * styles added through this function will be loaded by the resource loader when
+ * the page loads.
+ *
+ * @param $modules Mixed: module name (string) or array of module names
+ */
+ public function addModuleStyles( $modules ) {
+ $this->mModuleStyles = array_merge( $this->mModuleStyles, (array)$modules );
+ }
+
+ /**
+ * Get the list of module messages to include on this page
+ *
+ * @return Array of module names
+ */
+ public function getModuleMessages() {
+ return array_values( array_unique( $this->mModuleMessages ) );
+ }
+
+ /**
+ * Add only messages of one or more modules recognized by the resource loader.
+ * Module messages added through this function will be loaded by the resource
+ * loader when the page loads.
+ *
+ * @param $modules Mixed: module name (string) or array of module names
+ */
+ public function addModuleMessages( $modules ) {
+ $this->mModuleMessages = array_merge( $this->mModuleMessages, (array)$modules );
+ }
+
+ /**
+ * Get all header items in a string
+ *
+ * @return String
+ */
function getHeadItems() {
$s = '';
foreach ( $this->mHeadItems as $item ) {
@@ -127,34 +319,53 @@ class OutputPage {
return $s;
}
- function addHeadItem( $name, $value ) {
+ /**
+ * Add or replace an header item to the output
+ *
+ * @param $name String: item name
+ * @param $value String: raw HTML
+ */
+ public function addHeadItem( $name, $value ) {
$this->mHeadItems[$name] = $value;
}
- function hasHeadItem( $name ) {
+ /**
+ * Check if the header item $name is already set
+ *
+ * @param $name String: item name
+ * @return Boolean
+ */
+ public function hasHeadItem( $name ) {
return isset( $this->mHeadItems[$name] );
}
- function setETag($tag) { $this->mETag = $tag; }
- function setArticleBodyOnly($only) { $this->mArticleBodyOnly = $only; }
- function getArticleBodyOnly($only) { return $this->mArticleBodyOnly; }
-
- function addLink( $linkarr ) {
- # $linkarr should be an associative array of attributes. We'll escape on output.
- array_push( $this->mLinktags, $linkarr );
+ /**
+ * Set the value of the ETag HTTP header, only used if $wgUseETag is true
+ *
+ * @param $tag String: value of "ETag" header
+ */
+ function setETag( $tag ) {
+ $this->mETag = $tag;
}
-
- # Get all links added by extensions
- function getExtStyle() {
- return $this->mExtStyles;
+
+ /**
+ * Set whether the output should only contain the body of the article,
+ * without any skin, sidebar, etc.
+ * Used e.g. when calling with "action=render".
+ *
+ * @param $only Boolean: whether to output only the body of the article
+ */
+ public function setArticleBodyOnly( $only ) {
+ $this->mArticleBodyOnly = $only;
}
- function addMetadataLink( $linkarr ) {
- # note: buggy CC software only reads first "meta" link
- static $haveMeta = false;
- $linkarr['rel'] = ($haveMeta) ? 'alternate meta' : 'meta';
- $this->addLink( $linkarr );
- $haveMeta = true;
+ /**
+ * Return whether the output will contain only the body of the article
+ *
+ * @return Boolean
+ */
+ public function getArticleBodyOnly() {
+ return $this->mArticleBodyOnly;
}
/**
@@ -164,11 +375,11 @@ class OutputPage {
*
* Side effect: sets mLastModified for Last-Modified header
*
- * @return bool True iff cache-ok headers was sent.
+ * @return Boolean: true iff cache-ok headers was sent.
*/
- function checkLastModified( $timestamp ) {
+ public function checkLastModified( $timestamp ) {
global $wgCachePages, $wgCacheEpoch, $wgUser, $wgRequest;
-
+
if ( !$timestamp || $timestamp == '19700101000000' ) {
wfDebug( __METHOD__ . ": CACHE DISABLED, NO TIMESTAMP\n" );
return false;
@@ -221,9 +432,9 @@ class OutputPage {
}
$clientHeaderTime = wfTimestamp( TS_MW, $clientHeaderTime );
- wfDebug( __METHOD__ . ": client sent If-Modified-Since: " .
+ wfDebug( __METHOD__ . ": client sent If-Modified-Since: " .
wfTimestamp( TS_ISO_8601, $clientHeaderTime ) . "\n", false );
- wfDebug( __METHOD__ . ": effective Last-Modified: " .
+ wfDebug( __METHOD__ . ": effective Last-Modified: " .
wfTimestamp( TS_ISO_8601, $maxModified ) . "\n", false );
if( $clientHeaderTime < $maxModified ) {
wfDebug( __METHOD__ . ": STALE, $info\n", false );
@@ -231,9 +442,9 @@ class OutputPage {
}
# Not modified
- # Give a 304 response code and disable body output
+ # Give a 304 response code and disable body output
wfDebug( __METHOD__ . ": NOT MODIFIED, $info\n", false );
- ini_set('zlib.output_compression', 0);
+ ini_set( 'zlib.output_compression', 0 );
$wgRequest->response()->header( "HTTP/1.1 304 Not Modified" );
$this->sendCacheControl();
$this->disable();
@@ -246,131 +457,385 @@ class OutputPage {
return true;
}
- function setPageTitleActionText( $text ) {
+ /**
+ * Override the last modified timestamp
+ *
+ * @param $timestamp String: new timestamp, in a format readable by
+ * wfTimestamp()
+ */
+ public function setLastModified( $timestamp ) {
+ $this->mLastModified = wfTimestamp( TS_RFC2822, $timestamp );
+ }
+
+ /**
+ * Set the robot policy for the page:
+ *
+ * @param $policy String: the literal string to output as the contents of
+ * the meta tag. Will be parsed according to the spec and output in
+ * standardized form.
+ * @return null
+ */
+ public function setRobotPolicy( $policy ) {
+ $policy = Article::formatRobotPolicy( $policy );
+
+ if( isset( $policy['index'] ) ) {
+ $this->setIndexPolicy( $policy['index'] );
+ }
+ if( isset( $policy['follow'] ) ) {
+ $this->setFollowPolicy( $policy['follow'] );
+ }
+ }
+
+ /**
+ * Set the index policy for the page, but leave the follow policy un-
+ * touched.
+ *
+ * @param $policy string Either 'index' or 'noindex'.
+ * @return null
+ */
+ public function setIndexPolicy( $policy ) {
+ $policy = trim( $policy );
+ if( in_array( $policy, array( 'index', 'noindex' ) ) ) {
+ $this->mIndexPolicy = $policy;
+ }
+ }
+
+ /**
+ * Set the follow policy for the page, but leave the index policy un-
+ * touched.
+ *
+ * @param $policy String: either 'follow' or 'nofollow'.
+ * @return null
+ */
+ public function setFollowPolicy( $policy ) {
+ $policy = trim( $policy );
+ if( in_array( $policy, array( 'follow', 'nofollow' ) ) ) {
+ $this->mFollowPolicy = $policy;
+ }
+ }
+
+ /**
+ * Set the new value of the "action text", this will be added to the
+ * "HTML title", separated from it with " - ".
+ *
+ * @param $text String: new value of the "action text"
+ */
+ public function setPageTitleActionText( $text ) {
$this->mPageTitleActionText = $text;
}
- function getPageTitleActionText () {
+ /**
+ * Get the value of the "action text"
+ *
+ * @return String
+ */
+ public function getPageTitleActionText() {
if ( isset( $this->mPageTitleActionText ) ) {
return $this->mPageTitleActionText;
}
}
/**
- * Set the robot policy for the page:
+ * "HTML title" means the contents of .
+ * It is stored as plain, unescaped text and will be run through htmlspecialchars in the skin file.
+ */
+ public function setHTMLTitle( $name ) {
+ $this->mHTMLtitle = $name;
+ }
+
+ /**
+ * Return the "HTML title", i.e. the content of the <title> tag.
*
- * @param $policy string The literal string to output as the contents of
- * the meta tag. Will be parsed according to the spec and output in
- * standardized form.
- * @return null
+ * @return String
*/
- public function setRobotPolicy( $policy ) {
- $policy = explode( ',', $policy );
- $policy = array_map( 'trim', $policy );
+ public function getHTMLTitle() {
+ return $this->mHTMLtitle;
+ }
+
+ /**
+ * "Page title" means the contents of \<h1\>. It is stored as a valid HTML fragment.
+ * This function allows good tags like \<sup\> in the \<h1\> tag, but not bad tags like \<script\>.
+ * This function automatically sets \<title\> to the same content as \<h1\> but with all tags removed.
+ * Bad tags that were escaped in \<h1\> will still be escaped in \<title\>, and good tags like \<i\> will be dropped entirely.
+ */
+ public function setPageTitle( $name ) {
+ # change "<script>foo&bar</script>" to "<script>foo&bar</script>"
+ # but leave "<i>foobar</i>" alone
+ $nameWithTags = Sanitizer::normalizeCharReferences( Sanitizer::removeHTMLtags( $name ) );
+ $this->mPagetitle = $nameWithTags;
+
+ # change "<i>foo&bar</i>" to "foo&bar"
+ $this->setHTMLTitle( wfMsg( 'pagetitle', Sanitizer::stripAllTags( $nameWithTags ) ) );
+ }
+
+ /**
+ * Return the "page title", i.e. the content of the \<h1\> tag.
+ *
+ * @return String
+ */
+ public function getPageTitle() {
+ return $this->mPagetitle;
+ }
+
+ /**
+ * Set the Title object to use
+ *
+ * @param $t Title object
+ */
+ public function setTitle( $t ) {
+ $this->mTitle = $t;
+ }
- # The default policy is follow, so if nothing is said explicitly, we
- # do that.
- if( in_array( 'nofollow', $policy ) ) {
- $this->mFollowPolicy = 'nofollow';
+ /**
+ * Get the Title object used in this instance
+ *
+ * @return Title
+ */
+ public function getTitle() {
+ if ( $this->mTitle instanceof Title ) {
+ return $this->mTitle;
} else {
- $this->mFollowPolicy = 'follow';
+ wfDebug( __METHOD__ . " called and \$mTitle is null. Return \$wgTitle for sanity\n" );
+ global $wgTitle;
+ return $wgTitle;
}
+ }
+
+ /**
+ * Replace the subtile with $str
+ *
+ * @param $str String: new value of the subtitle
+ */
+ public function setSubtitle( $str ) {
+ $this->mSubtitle = /*$this->parse(*/ $str /*)*/; // @bug 2514
+ }
- if( in_array( 'noindex', $policy ) ) {
- $this->mIndexPolicy = 'noindex';
+ /**
+ * Add $str to the subtitle
+ *
+ * @param $str String to add to the subtitle
+ */
+ public function appendSubtitle( $str ) {
+ $this->mSubtitle .= /*$this->parse(*/ $str /*)*/; // @bug 2514
+ }
+
+ /**
+ * Get the subtitle
+ *
+ * @return String
+ */
+ public function getSubtitle() {
+ return $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->mIndexPolicy = 'index';
+ $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 $val String: 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 $format String: feed type, should be a key of $wgFeedClasses
+ * @param $href String: 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;
}
}
/**
- * Set the index policy for the page, but leave the follow policy un-
- * touched.
+ * Return whether the content displayed page is related to the source of
+ * the corresponding article on the wiki
*
- * @param $policy string Either 'index' or 'noindex'.
- * @return null
+ * @return Boolean
*/
- public function setIndexPolicy( $policy ) {
- $policy = trim( $policy );
- if( in_array( $policy, array( 'index', 'noindex' ) ) ) {
- $this->mIndexPolicy = $policy;
- }
+ public function isArticle() {
+ return $this->mIsarticle;
}
/**
- * Set the follow policy for the page, but leave the index policy un-
- * touched.
+ * Set whether this page is related an article on the wiki
+ * Setting false will cause the change of "article flag" toggle to false
*
- * @param $policy string Either 'follow' or 'nofollow'.
- * @return null
+ * @param $v Boolean
*/
- public function setFollowPolicy( $policy ) {
- $policy = trim( $policy );
- if( in_array( $policy, array( 'follow', 'nofollow' ) ) ) {
- $this->mFollowPolicy = $policy;
- }
- }
-
- public function setHTMLTitle( $name ) { $this->mHTMLtitle = $name; }
- public function setPageTitle( $name ) {
- global $wgContLang;
- $name = $wgContLang->convert( $name, true );
- $this->mPagetitle = $name;
-
- $taction = $this->getPageTitleActionText();
- if( !empty( $taction ) ) {
- $name .= ' - '.$taction;
- }
-
- $this->setHTMLTitle( wfMsg( 'pagetitle', $name ) );
- }
-
- public function getHTMLTitle() { return $this->mHTMLtitle; }
- public function getPageTitle() { return $this->mPagetitle; }
- public function setSubtitle( $str ) { $this->mSubtitle = /*$this->parse(*/$str/*)*/; } // @bug 2514
- public function appendSubtitle( $str ) { $this->mSubtitle .= /*$this->parse(*/$str/*)*/; } // @bug 2514
- public function getSubtitle() { return $this->mSubtitle; }
- public function isArticle() { return $this->mIsarticle; }
- public function setPrintable() { $this->mPrintable = true; }
- public function isPrintable() { return $this->mPrintable; }
- public function setSyndicated( $show = true ) { $this->mShowFeedLinks = $show; }
- public function isSyndicated() { return $this->mShowFeedLinks; }
- public function setFeedAppendQuery( $val ) { $this->mFeedLinksAppendQuery = $val; }
- public function getFeedAppendQuery() { return $this->mFeedLinksAppendQuery; }
- public function setOnloadHandler( $js ) { $this->mOnloadHandler = $js; }
- public function getOnloadHandler() { return $this->mOnloadHandler; }
- public function disable() { $this->mDoNothing = true; }
- public function isDisabled() { return $this->mDoNothing; }
-
public function setArticleRelated( $v ) {
$this->mIsArticleRelated = $v;
if ( !$v ) {
$this->mIsarticle = false;
}
}
- public function setArticleFlag( $v ) {
- $this->mIsarticle = $v;
- if ( $v ) {
- $this->mIsArticleRelated = $v;
- }
- }
- public function isArticleRelated() { return $this->mIsArticleRelated; }
+ /**
+ * Return whether this page is related an article on the wiki
+ *
+ * @return Boolean
+ */
+ public function isArticleRelated() {
+ return $this->mIsArticleRelated;
+ }
- public function getLanguageLinks() { return $this->mLanguageLinks; }
- public function addLanguageLinks($newLinkArray) {
+ /**
+ * Add new language links
+ *
+ * @param $newLinkArray Associative array mapping language code to the page
+ * name
+ */
+ public function addLanguageLinks( $newLinkArray ) {
$this->mLanguageLinks += $newLinkArray;
}
- public function setLanguageLinks($newLinkArray) {
+
+ /**
+ * Reset the language links and add new language links
+ *
+ * @param $newLinkArray Associative array mapping language code to the page
+ * name
+ */
+ public function setLanguageLinks( $newLinkArray ) {
$this->mLanguageLinks = $newLinkArray;
}
- public function getCategoryLinks() {
- return $this->mCategoryLinks;
+ /**
+ * Get the list of language links
+ *
+ * @return Associative array mapping language code to the page name
+ */
+ public function getLanguageLinks() {
+ return $this->mLanguageLinks;
}
/**
* Add an array of categories, with names in the keys
+ *
+ * @param $categories Associative array mapping category name to its sort key
*/
public function addCategoryLinks( $categories ) {
global $wgUser, $wgContLang;
@@ -389,7 +854,7 @@ class OutputPage {
$pageTable = $dbr->tableName( 'page' );
$where = $lb->constructSet( 'page', $dbr );
$propsTable = $dbr->tableName( 'page_props' );
- $sql = "SELECT page_id, page_namespace, page_title, page_len, page_is_redirect, pp_value
+ $sql = "SELECT page_id, page_namespace, page_title, page_len, page_is_redirect, page_latest, pp_value
FROM $pageTable LEFT JOIN $propsTable ON pp_propname='hiddencat' AND pp_page=page_id WHERE $where";
$res = $dbr->query( $sql, __METHOD__ );
@@ -397,8 +862,10 @@ class OutputPage {
$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' ) );
+ $categories = array_combine(
+ array_keys( $categories ),
+ array_fill( 0, count( $categories ), 'normal' )
+ );
# Mark hidden categories
foreach ( $res as $row ) {
@@ -414,38 +881,140 @@ class OutputPage {
$origcategory = $category;
$title = Title::makeTitleSafe( NS_CATEGORY, $category );
$wgContLang->findVariantLink( $category, $title, true );
- if ( $category != $origcategory )
- if ( array_key_exists( $category, $categories ) )
+ if ( $category != $origcategory ) {
+ if ( array_key_exists( $category, $categories ) ) {
continue;
+ }
+ }
$text = $wgContLang->convertHtml( $title->getText() );
- $this->mCategoryLinks[$type][] = $sk->makeLinkObj( $title, $text );
+ $this->mCategories[] = $title->getText();
+ $this->mCategoryLinks[$type][] = $sk->link( $title, $text );
}
}
}
- public function setCategoryLinks($categories) {
+ /**
+ * Reset the category links (but not the category list) and add $categories
+ *
+ * @param $categories Associative array mapping category name to its sort key
+ */
+ public function setCategoryLinks( $categories ) {
$this->mCategoryLinks = array();
- $this->addCategoryLinks($categories);
+ $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;
+ }
+
+ /**
+ * Suppress the quickbar from the output, only for skin supporting
+ * the quickbar
+ */
+ public function suppressQuickbar() {
+ $this->mSuppressQuickbar = true;
+ }
+
+ /**
+ * Return whether the quickbar should be suppressed from the output
+ *
+ * @return Boolean
+ */
+ public function isQuickbarSuppressed() {
+ return $this->mSuppressQuickbar;
+ }
+
+ /**
+ * Remove user JavaScript from scripts to load
+ */
+ public function disallowUserJs() {
+ $this->mAllowUserJs = false;
+ }
+
+ /**
+ * Return whether user JavaScript is allowed for this page
+ *
+ * @return Boolean
+ */
+ public function isUserJsAllowed() {
+ return $this->mAllowUserJs;
+ }
+
+ /**
+ * Prepend $text to the body HTML
+ *
+ * @param $text String: HTML
+ */
+ public function prependHTML( $text ) {
+ $this->mBodytext = $text . $this->mBodytext;
+ }
+
+ /**
+ * Append $text to the body HTML
+ *
+ * @param $text String: HTML
+ */
+ public function addHTML( $text ) {
+ $this->mBodytext .= $text;
}
- public function suppressQuickbar() { $this->mSuppressQuickbar = true; }
- public function isQuickbarSuppressed() { return $this->mSuppressQuickbar; }
+ /**
+ * Clear the body HTML
+ */
+ public function clearHTML() {
+ $this->mBodytext = '';
+ }
- public function disallowUserJs() { $this->mAllowUserJs = false; }
- public function isUserJsAllowed() { return $this->mAllowUserJs; }
+ /**
+ * Get the body HTML
+ *
+ * @return String: HTML
+ */
+ public function getHTML() {
+ return $this->mBodytext;
+ }
- public function prependHTML( $text ) { $this->mBodytext = $text . $this->mBodytext; }
- public function addHTML( $text ) { $this->mBodytext .= $text; }
- public function clearHTML() { $this->mBodytext = ''; }
- public function getHTML() { return $this->mBodytext; }
- public function debug( $text ) { $this->mDebugtext .= $text; }
+ /**
+ * Add $text to the debug output
+ *
+ * @param $text String: debug text
+ */
+ public function debug( $text ) {
+ $this->mDebugtext .= $text;
+ }
- /* @deprecated */
+ /**
+ * @deprecated use parserOptions() instead
+ */
public function setParserOptions( $options ) {
wfDeprecated( __METHOD__ );
return $this->parserOptions( $options );
}
+ /**
+ * Get/set the ParserOptions object to use for wikitext parsing
+ *
+ * @param $options either the ParserOption to use or null to only get the
+ * current ParserOption object
+ * @return current ParserOption object
+ */
public function parserOptions( $options = null ) {
if ( !$this->mParserOptions ) {
$this->mParserOptions = new ParserOptions;
@@ -456,40 +1025,78 @@ class OutputPage {
/**
* Set the revision ID which will be seen by the wiki text parser
* for things such as embedded {{REVISIONID}} variable use.
- * @param mixed $revid an integer, or NULL
- * @return mixed previous value
+ *
+ * @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 current revision ID
+ *
+ * @return Integer
+ */
public function getRevisionId() {
return $this->mRevisionId;
}
/**
* Convert wikitext to HTML and add it to the buffer
- * Default assumes that the current page title will
- * be used.
+ * Default assumes that the current page title will be used.
*
- * @param string $text
- * @param bool $linestart
+ * @param $text String
+ * @param $linestart Boolean: is this the start of a line?
*/
public function addWikiText( $text, $linestart = true ) {
- global $wgTitle;
- $this->addWikiTextTitle($text, $wgTitle, $linestart);
+ $title = $this->getTitle(); // Work arround E_STRICT
+ $this->addWikiTextTitle( $text, $title, $linestart );
}
- public function addWikiTextWithTitle($text, &$title, $linestart = true) {
- $this->addWikiTextTitle($text, $title, $linestart);
+ /**
+ * Add wikitext with a custom Title object
+ *
+ * @param $text String: 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 );
}
- function addWikiTextTitleTidy($text, &$title, $linestart = true) {
+ /**
+ * Add wikitext with a custom Title object and
+ *
+ * @param $text String: 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 );
}
- public function addWikiTextTitle($text, &$title, $linestart, $tidy = false) {
+ /**
+ * Add wikitext with tidy enabled
+ *
+ * @param $text String: 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 $text String: wikitext
+ * @param $title Title object
+ * @param $linestart Boolean: is this the start of a line?
+ * @param $tidy Boolean: whether to use tidy
+ */
+ public function addWikiTextTitle( $text, &$title, $linestart, $tidy = false ) {
global $wgParser;
wfProfileIn( __METHOD__ );
@@ -499,8 +1106,10 @@ class OutputPage {
$popts = $this->parserOptions();
$oldTidy = $popts->setTidy( $tidy );
- $parserOutput = $wgParser->parse( $text, $title, $popts,
- $linestart, true, $this->mRevisionId );
+ $parserOutput = $wgParser->parse(
+ $text, $title, $popts,
+ $linestart, true, $this->mRevisionId
+ );
$popts->setTidy( $oldTidy );
@@ -510,35 +1119,60 @@ class OutputPage {
}
/**
- * @todo document
- * @param ParserOutput object &$parserOutput
+ * Add wikitext to the buffer, assuming that this is the primary text for a page view
+ * Saves the text into the parser cache if possible.
+ *
+ * @param $text String: wikitext
+ * @param $article Article object
+ * @param $cache Boolean
+ * @deprecated Use Article::outputWikitext
*/
- public function addParserOutputNoText( &$parserOutput ) {
- global $wgTitle, $wgExemptFromUserRobotsControl, $wgContentNamespaces;
+ public function addPrimaryWikiText( $text, $article, $cache = true ) {
+ global $wgParser;
+
+ wfDeprecated( __METHOD__ );
+
+ $popts = $this->parserOptions();
+ $popts->setTidy( true );
+ $parserOutput = $wgParser->parse(
+ $text, $article->mTitle,
+ $popts, true, true, $this->mRevisionId
+ );
+ $popts->setTidy( false );
+ if ( $cache && $article && $parserOutput->isCacheable() ) {
+ $parserCache = ParserCache::singleton();
+ $parserCache->save( $parserOutput, $article, $popts );
+ }
+
+ $this->addParserOutput( $parserOutput );
+ }
+
+ /**
+ * @deprecated use addWikiTextTidy()
+ */
+ public function addSecondaryWikiText( $text, $linestart = true ) {
+ wfDeprecated( __METHOD__ );
+ $this->addWikiTextTitleTidy( $text, $this->getTitle(), $linestart );
+ }
+ /**
+ * 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();
- if( is_null( $wgExemptFromUserRobotsControl ) ) {
- $bannedNamespaces = $wgContentNamespaces;
- } else {
- $bannedNamespaces = $wgExemptFromUserRobotsControl;
- }
- if( !in_array( $wgTitle->getNamespace(), $bannedNamespaces ) ) {
- # FIXME (bug 14900): This overrides $wgArticleRobotPolicies, and it
- # shouldn't
- $this->setIndexPolicy( $parserOutput->getIndexPolicy() );
- }
-
- $this->addKeywords( $parserOutput );
$this->mParseWarnings = $parserOutput->getWarnings();
- if ( $parserOutput->getCacheTime() == -1 ) {
+ if ( !$parserOutput->isCacheable() ) {
$this->enableClientCache( false );
}
$this->mNoGallery = $parserOutput->getNoGallery();
- $this->mHeadItems = array_merge( $this->mHeadItems, (array)$parserOutput->mHeadItems );
+ $this->mHeadItems = array_merge( $this->mHeadItems, $parserOutput->getHeadItems() );
+ $this->addModules( $parserOutput->getModules() );
// Versioning...
foreach ( (array)$parserOutput->mTemplateIds as $ns => $dbks ) {
if ( isset( $this->mTemplateIds[$ns] ) ) {
@@ -547,11 +1181,6 @@ class OutputPage {
$this->mTemplateIds[$ns] = $dbks;
}
}
- // Page title
- if( ( $dt = $parserOutput->getDisplayTitle() ) !== false )
- $this->setPageTitle( $dt );
- else if ( ( $title = $parserOutput->getTitleText() ) != '' )
- $this->setPageTitle( $title );
// Hooks registered in the object
global $wgParserOutputHooks;
@@ -566,65 +1195,22 @@ class OutputPage {
}
/**
- * @todo document
- * @param ParserOutput &$parserOutput
+ * Add a ParserOutput object
+ *
+ * @param $parserOutput ParserOutput
*/
function addParserOutput( &$parserOutput ) {
$this->addParserOutputNoText( $parserOutput );
- $text = $parserOutput->getText();
- wfRunHooks( 'OutputPageBeforeHTML',array( &$this, &$text ) );
+ $text = $parserOutput->getText();
+ wfRunHooks( 'OutputPageBeforeHTML', array( &$this, &$text ) );
$this->addHTML( $text );
}
- /**
- * Add wikitext to the buffer, assuming that this is the primary text for a page view
- * Saves the text into the parser cache if possible.
- *
- * @param string $text
- * @param Article $article
- * @param bool $cache
- * @deprecated Use Article::outputWikitext
- */
- public function addPrimaryWikiText( $text, $article, $cache = true ) {
- global $wgParser, $wgUser;
-
- wfDeprecated( __METHOD__ );
-
- $popts = $this->parserOptions();
- $popts->setTidy(true);
- $parserOutput = $wgParser->parse( $text, $article->mTitle,
- $popts, true, true, $this->mRevisionId );
- $popts->setTidy(false);
- if ( $cache && $article && $parserOutput->getCacheTime() != -1 ) {
- $parserCache = ParserCache::singleton();
- $parserCache->save( $parserOutput, $article, $popts);
- }
-
- $this->addParserOutput( $parserOutput );
- }
-
- /**
- * @deprecated use addWikiTextTidy()
- */
- public function addSecondaryWikiText( $text, $linestart = true ) {
- global $wgTitle;
- wfDeprecated( __METHOD__ );
- $this->addWikiTextTitleTidy($text, $wgTitle, $linestart);
- }
-
- /**
- * Add wikitext with tidy enabled
- */
- public function addWikiTextTidy( $text, $linestart = true ) {
- global $wgTitle;
- $this->addWikiTextTitleTidy($text, $wgTitle, $linestart);
- }
-
/**
* Add the output of a QuickTemplate to the output buffer
*
- * @param QuickTemplate $template
+ * @param $template QuickTemplate
*/
public function addTemplate( &$template ) {
ob_start();
@@ -636,24 +1222,42 @@ class OutputPage {
/**
* Parse wikitext and return the HTML.
*
- * @param string $text
- * @param bool $linestart Is this the start of a line?
- * @param bool $interface ??
+ * @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 parse( $text, $linestart = true, $interface = false ) {
- global $wgParser, $wgTitle;
- if( is_null( $wgTitle ) ) {
- throw new MWException( 'Empty $wgTitle in ' . __METHOD__ );
+ global $wgParser;
+ if( is_null( $this->getTitle() ) ) {
+ throw new MWException( 'Empty $mTitle in ' . __METHOD__ );
}
$popts = $this->parserOptions();
- if ( $interface) { $popts->setInterfaceMessage(true); }
- $parserOutput = $wgParser->parse( $text, $wgTitle, $popts,
- $linestart, true, $this->mRevisionId );
- if ( $interface) { $popts->setInterfaceMessage(false); }
+ if ( $interface ) {
+ $popts->setInterfaceMessage( true );
+ }
+ $parserOutput = $wgParser->parse(
+ $text, $this->getTitle(), $popts,
+ $linestart, true, $this->mRevisionId
+ );
+ if ( $interface ) {
+ $popts->setInterfaceMessage( false );
+ }
return $parserOutput->getText();
}
- /** Parse wikitext, strip paragraphs, and return the HTML. */
+ /**
+ * 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 );
@@ -666,14 +1270,15 @@ class OutputPage {
}
/**
- * @param Article $article
- * @param User $user
+ * @deprecated
*
- * @return bool True if successful, else false.
+ * @param $article Article
+ * @return Boolean: true if successful, else false.
*/
public function tryParserCache( &$article ) {
- $parserCache = ParserCache::singleton();
- $parserOutput = $parserCache->get( $article, $this->parserOptions() );
+ wfDeprecated( __METHOD__ );
+ $parserOutput = ParserCache::singleton()->get( $article, $article->getParserOptions() );
+
if ( $parserOutput !== false ) {
$this->addParserOutput( $parserOutput );
return true;
@@ -683,7 +1288,9 @@ class OutputPage {
}
/**
- * @param int $maxage Maximum cache time on the Squid, in seconds.
+ * 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;
@@ -691,12 +1298,18 @@ class OutputPage {
/**
* Use enableClientCache(false) to force it to send nocache headers
+ *
* @param $state ??
*/
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;
@@ -709,20 +1322,28 @@ class OutputPage {
),
$wgCacheVaryCookies
);
- wfRunHooks('GetCacheVaryCookies', array( $this, &$cookies ) );
+ wfRunHooks( 'GetCacheVaryCookies', array( $this, &$cookies ) );
}
return $cookies;
}
+ /**
+ * Return whether this page is not cacheable because "useskin" or "uselang"
+ * URL parameters were passed.
+ *
+ * @return Boolean
+ */
function uncacheableBecauseRequestVars() {
global $wgRequest;
- return $wgRequest->getText('useskin', false) === false
- && $wgRequest->getText('uselang', false) === false;
+ return $wgRequest->getText( 'useskin', false ) === false
+ && $wgRequest->getText( 'uselang', false ) === false;
}
/**
* 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() {
global $wgRequest;
@@ -733,48 +1354,159 @@ class OutputPage {
$cvCookies = $this->getCacheVaryCookies();
foreach ( $cvCookies as $cookieName ) {
# Check for a simple string match, like the way squid does it
- if ( strpos( $cookieHeader, $cookieName ) ) {
- wfDebug( __METHOD__.": found $cookieName\n" );
+ if ( strpos( $cookieHeader, $cookieName ) !== false ) {
+ wfDebug( __METHOD__ . ": found $cookieName\n" );
return true;
}
}
- wfDebug( __METHOD__.": no cache-varying cookies found\n" );
+ wfDebug( __METHOD__ . ": no cache-varying cookies found\n" );
return false;
}
- /** Get a complete X-Vary-Options header */
+ /**
+ * Add an HTTP header that will influence on the cache
+ *
+ * @param $header String: header name
+ * @param $option either an Array or null
+ * @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( $this->mVaryHeader[$header] );
+ }
+
+ /**
+ * Get a complete X-Vary-Options header
+ *
+ * @return String
+ */
public function getXVO() {
$cvCookies = $this->getCacheVaryCookies();
- $xvo = 'X-Vary-Options: Accept-Encoding;list-contains=gzip,Cookie;';
- $first = true;
+
+ $cookiesOption = array();
foreach ( $cvCookies as $cookieName ) {
- if ( $first ) {
- $first = false;
- } else {
- $xvo .= ';';
+ $cookiesOption[] = 'string-contains=' . $cookieName;
+ }
+ $this->addVaryHeader( 'Cookie', $cookiesOption );
+
+ $headers = array();
+ foreach( $this->mVaryHeader as $header => $option ) {
+ $newheader = $header;
+ if( is_array( $option ) ) {
+ $newheader .= ';' . implode( ';', $option );
}
- $xvo .= 'string-contains=' . $cookieName;
+ $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() {
+ global $wgRequest, $wgContLang;
+ if( !$wgRequest->getCheck( 'variant' ) && $wgContLang->hasVariants() ) {
+ $variants = $wgContLang->getVariants();
+ $aloption = array();
+ foreach ( $variants as $variant ) {
+ if( $variant === $wgContLang->getCode() ) {
+ continue;
+ } else {
+ $aloption[] = 'string-contains=' . $variant;
+
+ // IE and some other browsers use another form of language code
+ // in their Accept-Language header, like "zh-CN" or "zh-TW".
+ // We should handle these too.
+ $ievariant = explode( '-', $variant );
+ if ( count( $ievariant ) == 2 ) {
+ $ievariant[1] = strtoupper( $ievariant[1] );
+ $ievariant = implode( '-', $ievariant );
+ $aloption[] = 'string-contains=' . $ievariant;
+ }
+ }
+ }
+ $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.
+ */
+ 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.
+ */
+ public function getFrameOptions() {
+ global $wgBreakFrames, $wgEditPageFrameOptions;
+ if ( $wgBreakFrames ) {
+ return 'DENY';
+ } elseif ( $this->mPreventClickjacking && $wgEditPageFrameOptions ) {
+ return $wgEditPageFrameOptions;
+ }
+ }
+
+ /**
+ * Send cache control HTTP headers
+ */
public function sendCacheControl() {
- global $wgUseSquid, $wgUseESI, $wgUseETag, $wgSquidMaxage, $wgRequest;
+ global $wgUseSquid, $wgUseESI, $wgUseETag, $wgSquidMaxage, $wgRequest, $wgUseXVO;
+
+ $response = $wgRequest->response();
+ if ( $wgUseETag && $this->mETag ) {
+ $response->header( "ETag: $this->mETag" );
+ }
- $response = $wgRequest->response();
- if ($wgUseETag && $this->mETag)
- $response->header("ETag: $this->mETag");
+ $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( 'Vary: Accept-Encoding, Cookie' );
+ $response->header( 'Vary: ' . join( ', ', array_keys( $this->mVaryHeader ) ) );
- # Add an X-Vary-Options header for Squid with Wikimedia patches
- $response->header( $this->getXVO() );
+ if ( $wgUseXVO ) {
+ # Add an X-Vary-Options header for Squid with Wikimedia patches
+ $response->header( $this->getXVO() );
+ }
if( !$this->uncacheableBecauseRequestVars() && $this->mEnableClientCache ) {
- if( $wgUseSquid && session_id() == '' &&
- ! $this->isPrintable() && $this->mSquidMaxage != 0 && !$this->haveCacheVaryCookies() )
+ 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
@@ -816,149 +1548,173 @@ class OutputPage {
}
}
+ /**
+ * Get the message associed 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
+ */
+ public static function getStatusMessage( $code ) {
+ static $statusMessage = array(
+ 100 => 'Continue',
+ 101 => 'Switching Protocols',
+ 102 => 'Processing',
+ 200 => 'OK',
+ 201 => 'Created',
+ 202 => 'Accepted',
+ 203 => 'Non-Authoritative Information',
+ 204 => 'No Content',
+ 205 => 'Reset Content',
+ 206 => 'Partial Content',
+ 207 => 'Multi-Status',
+ 300 => 'Multiple Choices',
+ 301 => 'Moved Permanently',
+ 302 => 'Found',
+ 303 => 'See Other',
+ 304 => 'Not Modified',
+ 305 => 'Use Proxy',
+ 307 => 'Temporary Redirect',
+ 400 => 'Bad Request',
+ 401 => 'Unauthorized',
+ 402 => 'Payment Required',
+ 403 => 'Forbidden',
+ 404 => 'Not Found',
+ 405 => 'Method Not Allowed',
+ 406 => 'Not Acceptable',
+ 407 => 'Proxy Authentication Required',
+ 408 => 'Request Timeout',
+ 409 => 'Conflict',
+ 410 => 'Gone',
+ 411 => 'Length Required',
+ 412 => 'Precondition Failed',
+ 413 => 'Request Entity Too Large',
+ 414 => 'Request-URI Too Large',
+ 415 => 'Unsupported Media Type',
+ 416 => 'Request Range Not Satisfiable',
+ 417 => 'Expectation Failed',
+ 422 => 'Unprocessable Entity',
+ 423 => 'Locked',
+ 424 => 'Failed Dependency',
+ 500 => 'Internal Server Error',
+ 501 => 'Not Implemented',
+ 502 => 'Bad Gateway',
+ 503 => 'Service Unavailable',
+ 504 => 'Gateway Timeout',
+ 505 => 'HTTP Version Not Supported',
+ 507 => 'Insufficient Storage'
+ );
+ return isset( $statusMessage[$code] ) ? $statusMessage[$code] : null;
+ }
+
/**
* Finally, all the text has been munged and accumulated into
* the object, let's actually output it:
*/
public function output() {
global $wgUser, $wgOutputEncoding, $wgRequest;
- global $wgContLanguageCode, $wgDebugRedirects, $wgMimeType;
- global $wgJsMimeType, $wgUseAjax, $wgAjaxWatch;
+ global $wgLanguageCode, $wgDebugRedirects, $wgMimeType;
+ global $wgUseAjax, $wgAjaxWatch;
global $wgEnableMWSuggest, $wgUniversalEditButton;
- global $wgArticle, $wgTitle;
+ global $wgArticle;
- if( $this->mDoNothing ){
+ if( $this->mDoNothing ) {
return;
}
-
wfProfileIn( __METHOD__ );
-
- if ( '' != $this->mRedirect ) {
+ if ( $this->mRedirect != '' ) {
# Standards require redirect URLs to be absolute
$this->mRedirect = wfExpandUrl( $this->mRedirect );
- if( $this->mRedirectCode == '301') {
+ if( $this->mRedirectCode == '301' || $this->mRedirectCode == '303' ) {
if( !$wgDebugRedirects ) {
- $wgRequest->response()->header("HTTP/1.1 {$this->mRedirectCode} Moved Permanently");
+ $message = self::getStatusMessage( $this->mRedirectCode );
+ $wgRequest->response()->header( "HTTP/1.1 {$this->mRedirectCode} $message" );
}
$this->mLastModified = wfTimestamp( TS_RFC2822 );
}
-
$this->sendCacheControl();
- $wgRequest->response()->header("Content-Type: text/html; charset=utf-8");
+ $wgRequest->response()->header( "Content-Type: text/html; charset=utf-8" );
if( $wgDebugRedirects ) {
$url = htmlspecialchars( $this->mRedirect );
print "<html>\n<head>\n<title>Redirect\n\n\n";
print "Location: $url
\n";
print "\n