* This class is used to prepare the final rendering. A skin is then
* applied to the output parameters (links, javascript, html, categories ...).
*
- * Another class (fixme) handles sending the whole page to the client.
+ * @todo FIXME: Another class handles sending the whole page to the client.
*
* Some comments comes from a pairing session between Zak Greant and Ashar Voultoiz
* in November 2010.
*
* @todo document
*/
-class OutputPage {
+class OutputPage extends ContextSource {
/// Should be private. Used with addMeta() which adds <meta>
var $mMetatags = array();
var $mHTMLtitle = '';
/// Should be private. Is the displayed content related to the source of the corresponding wiki article.
- var $mIsarticle = true;
+ 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
* 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 HTTP1/1 protocols which
+ * 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;
/// Array of elements in <head>. Parser might add its own headers!
var $mHeadItems = array();
- // Next variables probably comes from the resource loader @todo FIXME
+ // @todo FIXME: Next variables probably comes from the resource loader
var $mModules = array(), $mModuleScripts = array(), $mModuleStyles = array(), $mModuleMessages = array();
var $mResourceLoader;
- /** @fixme is this still used ?*/
+ /** @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;
// Parser related.
var $mContainsOldMagic = 0, $mContainsNewMagic = 0;
- /**
- * Should be private. Has get/set methods properly documented.
- * Stores "article flag" toggle.
- */
- var $mIsArticleRelated = true;
-
/// lazy initialised, use parserOptions()
protected $mParserOptions = null;
/// should be private. To include the variable {{REVISIONID}}
var $mRevisionId = null;
- private $mContext;
+ var $mFileVersion = null;
/**
* An array of stylesheet filenames (relative from skins path), with options
* Instead a new RequestContext should be created and it will implicitly create
* a OutputPage tied to that context.
*/
- function __construct( RequestContext $context = null ) {
- if ( !isset($context) ) {
+ function __construct( IContextSource $context = null ) {
+ if ( $context === null ) {
# Extensions should use `new RequestContext` instead of `new OutputPage` now.
wfDeprecated( __METHOD__ );
+ } else {
+ $this->setContext( $context );
}
- $this->mContext = $context;
}
/**
*
* @return String
*/
- private function getMetadataAttribute() {
+ public function getMetadataAttribute() {
# note: buggy CC software only reads first "meta" link
static $haveMeta = false;
if ( $haveMeta ) {
* which are no longer registered (eg a page is cached before an extension is disabled)
* @param $modules Array
* @param $position String if not null, only return modules with this position
+ * @param $type string
* @return Array
*/
protected function filterModules( $modules, $position = null, $type = ResourceLoaderModule::TYPE_COMBINED ){
*
* @param $filter Bool whether to filter out insufficiently trustworthy modules
* @param $position String if not null, only return modules with this position
+ * @param $param string
* @return Array of module names
*/
public function getModules( $filter = false, $position = null, $param = 'mModules' ) {
/**
* Get the list of module JS to include on this page
+ *
+ * @param $filter
+ * @param $position
+ *
* @return array of module names
*/
public function getModuleScripts( $filter = false, $position = null ) {
/**
* Get the list of module CSS to include on this page
*
+ * @param $filter
+ * @param $position
+ *
* @return Array of module names
*/
public function getModuleStyles( $filter = false, $position = null ) {
/**
* Get the list of module messages to include on this page
*
+ * @param $filter
+ * @param $position
+ *
* @return Array of module names
*/
public function getModuleMessages( $filter = false, $position = null ) {
$this->mModuleMessages = array_merge( $this->mModuleMessages, (array)$modules );
}
+ /**
+ * Get an array of head items
+ *
+ * @return Array
+ */
+ function getHeadItemsArray() {
+ return $this->mHeadItems;
+ }
+
/**
* Get all header items in a string
*
*
* Side effect: sets mLastModified for Last-Modified header
*
+ * @param $timestamp string
+ *
* @return Boolean: true iff cache-ok headers was sent.
*/
public function checkLastModified( $timestamp ) {
/**
* "HTML title" means the contents of <title>.
* It is stored as plain, unescaped text and will be run through htmlspecialchars in the skin file.
+ *
+ * @param $name string
*/
public function setHTMLTitle( $name ) {
$this->mHTMLtitle = $name;
* 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.
+ *
+ * @param $name string
*/
public function setPageTitle( $name ) {
# change "<script>foo&bar</script>" to "<script>foo&bar</script>"
return $this->mPagetitle;
}
- /**
- * Get the RequestContext used in this instance
- *
- * @return RequestContext
- */
- private function getContext() {
- if ( !isset($this->mContext) ) {
- wfDebug( __METHOD__ . " called and \$mContext is null. Using RequestContext::getMain(); for sanity\n" );
- $this->mContext = RequestContext::getMain();
- }
- return $this->mContext;
- }
-
- /**
- * Get the WebRequest being used for this instance
- *
- * @return WebRequest
- * @since 1.18
- */
- public function getRequest() {
- return $this->getContext()->getRequest();
- }
-
/**
* Set the Title object to use
*
* @param $t Title object
*/
- public function setTitle( $t ) {
+ public function setTitle( Title $t ) {
$this->getContext()->setTitle( $t );
}
- /**
- * Get the Title object used in this instance
- *
- * @return Title
- */
- public function getTitle() {
- return $this->getContext()->getTitle();
- }
-
- /**
- * Get the User object used in this instance
- *
- * @return User
- * @since 1.18
- */
- public function getUser() {
- return $this->getContext()->getUser();
- }
-
- /**
- * Get the Skin object used to render this instance
- *
- * @return Skin
- * @since 1.18
- */
- public function getSkin() {
- return $this->getContext()->getSkin();
- }
/**
* Replace the subtile with $str
}
$text = $wgContLang->convertHtml( $title->getText() );
$this->mCategories[] = $title->getText();
- $this->mCategoryLinks[$type][] = $this->getSkin()->link( $title, $text );
+ $this->mCategoryLinks[$type][] = Linker::link( $title, $text );
}
}
}
public function parserOptions( $options = null ) {
if ( !$this->mParserOptions ) {
$this->mParserOptions = new ParserOptions;
+ $this->mParserOptions->setEditSection( false );
}
return wfSetVar( $this->mParserOptions, $options );
}
}
/**
- * Get the current revision ID
+ * Get the displayed revision ID
*
* @return Integer
*/
return $this->mRevisionId;
}
+ /**
+ * Set the displayed file version
+ *
+ * @param $file File|false
+ * @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 (dbKey => array('time' => MW timestamp or null, 'sha1' => sha1 or ''))
* @since 1.18
*/
- public function getImageTimeKeys() {
+ public function getFileSearchOptions() {
return $this->mImageTimeKeys;
}
*
* @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 ) {
+ public function addWikiText( $text, $linestart = true, $interface = true ) {
$title = $this->getTitle(); // Work arround E_STRICT
- $this->addWikiTextTitle( $text, $title, $linestart );
+ $this->addWikiTextTitle( $text, $title, $linestart, /*tidy*/false, $interface );
}
/**
* @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, $linestart, $tidy = false ) {
+ public function addWikiTextTitle( $text, &$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,
$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 ) {
}
}
// File versioning...
- foreach ( (array)$parserOutput->getImageTimeKeys() as $dbk => $data ) {
+ foreach ( (array)$parserOutput->getFileSearchOptions() as $dbk => $data ) {
$this->mImageTimeKeys[$dbk] = $data;
}
* @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
+ * words like GRAMMAR and PLURAL. This also disables
+ * LanguageConverter.
* @param $language Language object: target language object, will override
* $interface
* @return String: HTML
*/
public function parse( $text, $linestart = true, $interface = false, $language = null ) {
- // Check one for one common cause for parser state resetting
- $callers = wfGetAllCallers( 10 );
- if ( strpos( $callers, 'Parser::extensionSubstitution' ) !== false ) {
- throw new MWException( "wfMsg* function with parsing cannot be used " .
- "inside a tag hook. Should use parser->recursiveTagParse() instead" );
- }
-
global $wgParser;
if( is_null( $this->getTitle() ) ) {
/**
* Use enableClientCache(false) to force it to send nocache headers
*
- * @param $state ??
+ * @param $state bool
+ *
+ * @return bool
*/
public function enableClientCache( $state ) {
return wfSetVar( $this->mEnableClientCache, $state );
*
* @param $header String: header name
* @param $option Array|null
- * @fixme Document the $option parameter; it appears to be for
+ * @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 ) {
*
* 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;
* 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;
* @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 ) {
- 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;
+ wfDeprecated( __METHOD__ );
+ return HttpStatus::getMessage( $code );
}
/**
if ( $this->mRedirect != '' ) {
# Standards require redirect URLs to be absolute
- $this->mRedirect = wfExpandUrl( $this->mRedirect );
+ $this->mRedirect = wfExpandUrl( $this->mRedirect, PROTO_CURRENT );
if( $this->mRedirectCode == '301' || $this->mRedirectCode == '303' ) {
if( !$wgDebugRedirects ) {
- $message = self::getStatusMessage( $this->mRedirectCode );
+ $message = HttpStatus::getMessage( $this->mRedirectCode );
$response->header( "HTTP/1.1 {$this->mRedirectCode} $message" );
}
$this->mLastModified = wfTimestamp( TS_RFC2822 );
wfProfileOut( __METHOD__ );
return;
} elseif ( $this->mStatusCode ) {
- $message = self::getStatusMessage( $this->mStatusCode );
+ $message = HttpStatus::getMessage( $this->mStatusCode );
if ( $message ) {
$response->header( 'HTTP/1.1 ' . $this->mStatusCode . ' ' . $message );
}
} else {
$this->addDefaultModules();
- $sk = $this->getSkin( $this->getTitle() );
+ $sk = $this->getSkin();
// 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( $this );
+ $sk->outputPage();
wfProfileOut( 'Output-skin' );
}
}
/**
- * Actually output something with print(). Performs an iconv to the
- * output encoding, if needed.
+ * Actually output something with print().
*
* @param $ins String: the string to output
*/
public function out( $ins ) {
- global $wgContLang;
- if ( 0 == strcmp( 'UTF-8', 'UTF-8' ) ) {
- $outs = $ins;
- } else {
- $outs = $wgContLang->iconv( 'UTF-8', 'UTF-8', $ins );
- if ( false === $outs ) {
- $outs = $ins;
- }
- }
- print $outs;
+ print $ins;
}
/**
/**
* Output a standard error page
*
+ * showErrorPage( 'titlemsg', 'pagetextmsg', array( 'param1', 'param2' ) );
+ * showErrorPage( 'titlemsg', $messageObject );
+ *
* @param $title String: message key for page title
- * @param $msg String: message key for page text
- * @param $params Array: message parameters
+ * @param $msg Mixed: message key (string) for page text, or a Message object
+ * @param $params Array: message parameters; ignored if $msg is a Message object
*/
public function showErrorPage( $title, $msg, $params = array() ) {
if ( $this->getTitle() ) {
$this->mRedirect = '';
$this->mBodytext = '';
- $this->addWikiMsgArray( $msg, $params );
+ if ( $msg instanceof Message ){
+ $this->addHTML( $msg->parse() );
+ } else {
+ $this->addWikiMsgArray( $msg, $params );
+ }
$this->returnToMain();
}
$this->setArticleRelated( false );
$loginTitle = SpecialPage::getTitleFor( 'Userlogin' );
- $loginLink = $this->getSkin()->link(
+ $loginLink = Linker::linkKnown(
$loginTitle,
wfMsgHtml( 'loginreqlink' ),
array(),
- array( 'returnto' => $this->getTitle()->getPrefixedText() ),
- array( 'known', 'noclasses' )
+ array( 'returnto' => $this->getTitle()->getPrefixedText() )
);
- $this->addWikiMsgArray( 'loginreqpagetext', array( $loginLink ), array( 'replaceafter' ) );
- $this->addHTML( "\n<!--" . $this->getTitle()->getPrefixedUrl() . '-->' );
+ $this->addHTML( wfMessage( 'loginreqpagetext' )->rawParams( $loginLink )->parse() .
+ "\n<!--" . $this->getTitle()->getPrefixedUrl() . '-->' );
# Don't return to the main page if the user can't read it
# otherwise we'll end up in a pointless loop
* @param $action String: action that was denied or null if unknown
*/
public function readOnlyPage( $source = null, $protected = false, $reasons = array(), $action = null ) {
+ global $wgEnableInterwikiTranscluding, $wgEnableInterwikiTemplatesTracking;
+
$this->setRobotPolicy( 'noindex,nofollow' );
$this->setArticleRelated( false );
if( $source ) {
$this->setPageTitle( wfMsg( 'viewsource' ) );
$this->setSubtitle(
- wfMsg( 'viewsourcefor', $this->getSkin()->linkKnown( $this->getTitle() ) )
+ wfMsg( 'viewsourcefor', Linker::linkKnown( $this->getTitle() ) )
);
} else {
$this->setPageTitle( wfMsg( 'badaccess' ) );
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'
+ 'readonly' => 'readonly',
+ 'lang' => $pageLang->getCode(),
+ 'dir' => $pageLang->getDir(),
);
$this->addHTML( Html::element( 'textarea', $params, $source ) );
// Show templates used by this article
- $skin = $this->getSkin();
$article = new Article( $this->getTitle() );
+ $templates = Linker::formatTemplates( $article->getUsedTemplates() );
$this->addHTML( "<div class='templatesUsed'>
-{$skin->formatTemplates( $article->getUsedTemplates() )}
+$templates
+</div>
+" );
+ if ( $wgEnableInterwikiTranscluding && $wgEnableInterwikiTemplatesTracking ) {
+ $distantTemplates = Linker::formatDistantTemplates( $article->getUsedDistantTemplates() );
+ $this->addHTML( "<div class='distantTemplatesUsed'>
+$distantTemplates
</div>
" );
+ }
}
# If the title doesn't exist, it's fairly pointless to print a return
* Add a "return to" link pointing to a specified title
*
* @param $title Title to link
- * @param $query String: query string
+ * @param $query String query string
* @param $text String text of the link (input is not escaped)
*/
public function addReturnTo( $title, $query = array(), $text = null ) {
$this->addLink( array( 'rel' => 'next', 'href' => $title->getFullURL() ) );
$link = wfMsgHtml(
'returnto',
- $this->getSkin()->link( $title, $text, array(), $query )
+ Linker::link( $title, $text, array(), $query )
);
$this->addHTML( "<p id=\"mw-returnto\">{$link}</p>\n" );
}
* @return String: The doctype, opening <html>, and head element.
*/
public function headElement( Skin $sk, $includeStyle = true ) {
- global $wgUseTrackbacks;
+ global $wgContLang, $wgUseTrackbacks;
+ $userdir = $this->getLang()->getDir();
+ $sitedir = $wgContLang->getDir();
if ( $sk->commonPrintStylesheet() ) {
$this->addModuleStyles( 'mediawiki.legacy.wikiprintable' );
}
- $sk->setupUserCss( $this );
- $lang = wfUILang();
- $ret = Html::htmlHeader( array( 'lang' => $lang->getCode(), 'dir' => $lang->getDir() ) );
+ $ret = Html::htmlHeader( array( 'lang' => $this->getLang()->getCode(), 'dir' => $userdir, 'class' => 'client-nojs' ) );
if ( $this->getHTMLTitle() == '' ) {
$this->setHTMLTitle( wfMsg( 'pagetitle', $this->getPageTitle() ) );
$ret .= Html::element( 'title', null, $this->getHTMLTitle() ) . "\n";
$ret .= implode( "\n", array(
- $this->getHeadLinks( $sk, true ),
- $this->buildCssLinks( $sk ),
- $this->getHeadScripts( $sk ),
+ $this->getHeadLinks( null, true ),
+ $this->buildCssLinks(),
+ $this->getHeadScripts(),
$this->getHeadItems()
) );
$bodyAttrs = array();
- # Crazy edit-on-double-click stuff
- $action = $this->getRequest()->getVal( 'action', 'view' );
-
- if (
- $this->getTitle()->getNamespace() != NS_SPECIAL &&
- in_array( $action, array( 'view', 'purge' ) ) &&
- $this->getUser()->getOption( 'editondblclick' )
- )
- {
- $editUrl = $this->getTitle()->getLocalUrl( $sk->editUrlOptions() );
- $bodyAttrs['ondblclick'] = "document.location = '" .
- Xml::escapeJsString( $editUrl ) . "'";
- }
-
- # Class bloat
- $dir = wfUILang()->getDir();
- $bodyAttrs['class'] = "mediawiki $dir";
+ # Classes for LTR/RTL directionality support
+ $bodyAttrs['class'] = "mediawiki $userdir sitedir-$sitedir";
if ( $this->getContext()->getLang()->capitalizeAllNouns() ) {
# A <body> class is probably not the best way to do this . . .
* Add the default ResourceLoader modules to this object
*/
private function addDefaultModules() {
- global $wgIncludeLegacyJavaScript,
- $wgUseAjax, $wgAjaxWatch, $wgEnableMWSuggest;
+ global $wgIncludeLegacyJavaScript, $wgUseAjax, $wgAjaxWatch, $wgEnableMWSuggest;
// Add base resources
- $this->addModules( 'mediawiki.util' );
- if( $wgIncludeLegacyJavaScript ){
+ $this->addModules( array(
+ 'mediawiki.user',
+ 'mediawiki.util',
+ 'mediawiki.page.startup',
+ 'mediawiki.page.ready',
+ ) );
+ if ( $wgIncludeLegacyJavaScript ){
$this->addModules( 'mediawiki.legacy.wikibits' );
}
}
}
- if( $this->getUser()->getBoolOption( 'editsectiononrightclick' ) ) {
+ if ( $this->getUser()->getBoolOption( 'editsectiononrightclick' ) ) {
$this->addModules( 'mediawiki.action.view.rightClickEdit' );
}
+
+ # Crazy edit-on-double-click stuff
+ if ( $this->isArticle() && $this->getUser()->getOption( 'editondblclick' ) ) {
+ $this->addModules( 'mediawiki.action.view.dblClickEdit' );
+ }
}
/**
/**
* TODO: Document
- * @param $skin Skin
- * @param $modules Array/string with the module name
+ * @param $modules Array/string with the module name(s)
* @param $only String ResourceLoaderModule TYPE_ class constant
* @param $useESI boolean
+ * @param $extraQuery Array with extra query parameters to add to each request. array( param => value )
* @return string html <script> and <style> tags
*/
- protected function makeResourceLoaderLink( Skin $skin, $modules, $only, $useESI = false ) {
+ protected function makeResourceLoaderLink( $modules, $only, $useESI = false, array $extraQuery = array() ) {
global $wgLoadScript, $wgResourceLoaderUseESI,
$wgResourceLoaderInlinePrivateModules;
- // Lazy-load ResourceLoader
- // TODO: Should this be a static function of ResourceLoader instead?
- $baseQuery = array(
- 'lang' => $this->getContext()->getLang()->getCode(),
- 'debug' => ResourceLoader::inDebugMode() ? 'true' : 'false',
- 'skin' => $skin->getSkinName(),
- 'only' => $only,
- );
- // Propagate printable and handheld parameters if present
- if ( $this->isPrintable() ) {
- $baseQuery['printable'] = 1;
- }
- if ( $this->getRequest()->getBool( 'handheld' ) ) {
- $baseQuery['handheld'] = 1;
- }
if ( !count( $modules ) ) {
return '';
// Recursively call us for every item
$links = '';
foreach ( $modules as $name ) {
- $links .= $this->makeResourceLoaderLink( $skin, $name, $only, $useESI );
+ $links .= $this->makeResourceLoaderLink( $name, $only, $useESI );
}
return $links;
}
$links = '';
foreach ( $groups as $group => $modules ) {
- $query = $baseQuery;
// Special handling for user-specific groups
+ $user = null;
if ( ( $group === 'user' || $group === 'private' ) && $this->getUser()->isLoggedIn() ) {
- $query['user'] = $this->getUser()->getName();
+ $user = $this->getUser()->getName();
}
// Create a fake request based on the one we are about to make so modules return
// correct timestamp and emptiness data
+ $query = ResourceLoader::makeLoaderQuery(
+ array(), // modules; not determined yet
+ $this->getContext()->getLang()->getCode(),
+ $this->getSkin()->getSkinName(),
+ $user,
+ null, // version; not determined yet
+ ResourceLoader::inDebugMode(),
+ $only === ResourceLoaderModule::TYPE_COMBINED ? null : $only,
+ $this->isPrintable(),
+ $this->getRequest()->getBool( 'handheld' ),
+ $extraQuery
+ );
$context = new ResourceLoaderContext( $resourceLoader, new FauxRequest( $query ) );
// Drop modules that know they're empty
foreach ( $modules as $key => $module ) {
continue;
}
- $query['modules'] = ResourceLoader::makePackedModulesString( array_keys( $modules ) );
-
// Support inlining of private modules if configured as such
if ( $group === 'private' && $wgResourceLoaderInlinePrivateModules ) {
if ( $only == ResourceLoaderModule::TYPE_STYLES ) {
)
);
}
+ $links .= "\n";
continue;
}
// Special handling for the user group; because users might change their stuff
// timestamp of these user-changable modules so we can ensure cache misses on change
// This should NOT be done for the site group (bug 27564) because anons get that too
// and we shouldn't be putting timestamps in Squid-cached HTML
+ $version = null;
if ( $group === 'user' ) {
// Get the maximum timestamp
$timestamp = 1;
$timestamp = max( $timestamp, $module->getModifiedTime( $context ) );
}
// Add a version parameter so cache will break when things change
- $query['version'] = wfTimestamp( TS_ISO_8601_BASIC, $timestamp );
+ $version = wfTimestamp( TS_ISO_8601_BASIC, $timestamp );
}
- // Make queries uniform in order
- ksort( $query );
-
- $url = wfAppendQuery( $wgLoadScript, $query );
+
+ $url = ResourceLoader::makeLoaderURL(
+ array_keys( $modules ),
+ $this->getContext()->getLang()->getCode(),
+ $this->getSkin()->getSkinName(),
+ $user,
+ $version,
+ ResourceLoader::inDebugMode(),
+ $only === ResourceLoaderModule::TYPE_COMBINED ? null : $only,
+ $this->isPrintable(),
+ $this->getRequest()->getBool( 'handheld' ),
+ $extraQuery
+ );
if ( $useESI && $wgResourceLoaderUseESI ) {
$esi = Xml::element( 'esi:include', array( 'src' => $url ) );
if ( $only == ResourceLoaderModule::TYPE_STYLES ) {
} else {
// Automatically select style/script elements
if ( $only === ResourceLoaderModule::TYPE_STYLES ) {
- $link = Html::linkedStyle( wfAppendQuery( $wgLoadScript, $query ) );
+ $link = Html::linkedStyle( $url );
} else {
- $link = Html::linkedScript( wfAppendQuery( $wgLoadScript, $query ) );
+ $link = Html::linkedScript( $url );
}
}
* JS stuff to put in the <head>. This is the startup module, config
* vars and modules marked with position 'top'
*
- * @param $sk Skin object to use
* @return String: HTML fragment
*/
- function getHeadScripts( Skin $sk ) {
+ function getHeadScripts() {
// Startup - this will immediately load jquery and mediawiki modules
- $scripts = $this->makeResourceLoaderLink( $sk, 'startup', ResourceLoaderModule::TYPE_SCRIPTS, true );
+ $scripts = $this->makeResourceLoaderLink( 'startup', ResourceLoaderModule::TYPE_SCRIPTS, true );
// Load config before anything else
$scripts .= Html::inlineScript(
// Script and Messages "only" requests marked for top inclusion
// Messages should go first
- $scripts .= $this->makeResourceLoaderLink( $sk, $this->getModuleMessages( true, 'top' ), ResourceLoaderModule::TYPE_MESSAGES );
- $scripts .= $this->makeResourceLoaderLink( $sk, $this->getModuleScripts( true, 'top' ), ResourceLoaderModule::TYPE_SCRIPTS );
+ $scripts .= $this->makeResourceLoaderLink( $this->getModuleMessages( true, 'top' ), ResourceLoaderModule::TYPE_MESSAGES );
+ $scripts .= $this->makeResourceLoaderLink( $this->getModuleScripts( true, 'top' ), ResourceLoaderModule::TYPE_SCRIPTS );
// Modules requests - let the client calculate dependencies and batch requests as it likes
// Only load modules that have marked themselves for loading at the top
if ( $modules ) {
$scripts .= Html::inlineScript(
ResourceLoader::makeLoaderConditionalScript(
- Xml::encodeJsCall( 'mw.loader.load', array( $modules ) ) .
- Xml::encodeJsCall( 'mw.loader.go', array() )
+ Xml::encodeJsCall( 'mw.loader.load', array( $modules ) )
)
);
}
/**
* JS stuff to put at the bottom of the <body>: modules marked with position 'bottom',
* legacy scripts ($this->mScripts), user preferences, site JS and user JS
+ *
+ * @return string
*/
- function getBottomScripts( Skin $sk ) {
+ function getBottomScripts() {
global $wgUseSiteJs, $wgAllowUserJs;
// Script and Messages "only" requests marked for bottom inclusion
// Messages should go first
- $scripts = $this->makeResourceLoaderLink( $sk, $this->getModuleMessages( true, 'bottom' ), ResourceLoaderModule::TYPE_MESSAGES );
- $scripts .= $this->makeResourceLoaderLink( $sk, $this->getModuleScripts( true, 'bottom' ), ResourceLoaderModule::TYPE_SCRIPTS );
+ $scripts = $this->makeResourceLoaderLink( $this->getModuleMessages( true, 'bottom' ), ResourceLoaderModule::TYPE_MESSAGES );
+ $scripts .= $this->makeResourceLoaderLink( $this->getModuleScripts( true, 'bottom' ), ResourceLoaderModule::TYPE_SCRIPTS );
// Modules requests - let the client calculate dependencies and batch requests as it likes
// Only load modules that have marked themselves for loading at the bottom
if ( $modules ) {
$scripts .= Html::inlineScript(
ResourceLoader::makeLoaderConditionalScript(
- Xml::encodeJsCall( 'mw.loader.load', array( $modules ) ) .
- // the go() call is unnecessary if we inserted top modules, but we don't know for sure that we did
- Xml::encodeJsCall( 'mw.loader.go', array() )
+ Xml::encodeJsCall( 'mw.loader.load', array( $modules ) )
)
);
}
// Legacy Scripts
$scripts .= "\n" . $this->mScripts;
- $userScripts = array( 'user.options' );
+ $userScripts = array( 'user.options', 'user.tokens' );
// Add site JS if enabled
if ( $wgUseSiteJs ) {
- $scripts .= $this->makeResourceLoaderLink( $sk, 'site', ResourceLoaderModule::TYPE_SCRIPTS );
+ $scripts .= $this->makeResourceLoaderLink( 'site', ResourceLoaderModule::TYPE_SCRIPTS );
if( $this->getUser()->isLoggedIn() ){
$userScripts[] = 'user.groups';
}
// Add user JS if enabled
if ( $wgAllowUserJs && $this->getUser()->isLoggedIn() ) {
- $action = $this->getRequest()->getVal( 'action', 'view' );
- if( $this->getTitle() && $this->getTitle()->isJsSubpage() && $sk->userCanPreview( $action ) ) {
+ if( $this->getTitle() && $this->getTitle()->isJsSubpage() && $this->userCanPreview() ) {
# XXX: additional security check/prompt?
+ // We're on a preview of a JS subpage
+ // Exclude this page from the user module in case it's in there (bug 26283)
+ $scripts .= $this->makeResourceLoaderLink( 'user', ResourceLoaderModule::TYPE_SCRIPTS, false,
+ array( 'excludepage' => $this->getTitle()->getPrefixedDBkey() )
+ );
+ // Load the previewed JS
$scripts .= Html::inlineScript( "\n" . $this->getRequest()->getText( 'wpTextbox1' ) . "\n" ) . "\n";
} else {
- # FIXME: this means that User:Me/Common.js doesn't load when previewing
- # User:Me/Vector.js, and vice versa (bug26283)
- $userScripts[] = 'user';
+ // Include the user module normally
+ // We can't do $userScripts[] = 'user'; because the user module would end up
+ // being wrapped in a closure, so load it raw like 'site'
+ $scripts .= $this->makeResourceLoaderLink( 'user', ResourceLoaderModule::TYPE_SCRIPTS );
}
}
- $scripts .= $this->makeResourceLoaderLink( $sk, $userScripts, ResourceLoaderModule::TYPE_SCRIPTS );
+ $scripts .= $this->makeResourceLoaderLink( $userScripts, ResourceLoaderModule::TYPE_COMBINED );
return $scripts;
}
'wgUserGroups' => $this->getUser()->getEffectiveGroups(),
'wgCategories' => $this->getCategories(),
'wgBreakFrames' => $this->getFrameOptions() == 'DENY',
- 'wgIsMainPage' => $title->isMainPage(),
);
if ( $wgContLang->hasVariants() ) {
$vars['wgUserVariant'] = $wgContLang->getPreferredVariant();
if ( $wgUseAjax && $wgEnableMWSuggest && !$this->getUser()->getOption( 'disablesuggest', false ) ) {
$vars['wgSearchNamespaces'] = SearchEngine::userNamespaces( $this->getUser() );
}
+ if ( $title->isMainPage() ) {
+ $vars['wgIsMainPage'] = true;
+ }
// Allow extensions to add their custom variables to the global JS variables
- wfRunHooks( 'MakeGlobalVariablesScript', array( &$vars ) );
+ wfRunHooks( 'MakeGlobalVariablesScript', array( &$vars, &$this ) );
return $vars;
}
/**
+ * To make it harder for someone to slip a user a fake
+ * user-JavaScript or user-CSS preview, a random token
+ * is associated with the login session. If it's not
+ * passed back with the preview request, we won't render
+ * the code.
+ *
+ * @return bool
+ */
+ public function userCanPreview() {
+ if ( $this->getRequest()->getVal( 'action' ) != 'submit'
+ || !$this->getRequest()->wasPosted()
+ || !$this->getUser()->matchEditToken(
+ $this->getRequest()->getVal( 'wpEditToken' ) )
+ ) {
+ return false;
+ }
+ if ( !$this->getTitle()->isJsSubpage() && !$this->getTitle()->isCssSubpage() ) {
+ return false;
+ }
+
+ return !count( $this->getTitle()->getUserPermissionsErrors( 'edit', $this->getUser() ) );
+ }
+
+ /**
+ * @param $unused Unused
+ * @param $addContentType bool
+ *
* @return string HTML tag links to be put in the header.
*/
- public function getHeadLinks( Skin $sk, $addContentType = false ) {
+ public function getHeadLinks( $unused = null, $addContentType = false ) {
global $wgUniversalEditButton, $wgFavicon, $wgAppleTouchIcon, $wgEnableAPI,
$wgSitename, $wgVersion, $wgHtml5, $wgMimeType,
$wgFeed, $wgOverrideSiteFeed, $wgAdvertisedFeedTypes,
- $wgEnableDublinCoreRdf, $wgEnableCreativeCommonsRdf,
$wgDisableLangConversion, $wgCanonicalLanguageLinks, $wgContLang,
$wgRightsPage, $wgRightsUrl;
$tags[] = Html::element( 'link', array(
'rel' => 'EditURI',
'type' => 'application/rsd+xml',
- 'href' => wfExpandUrl( wfAppendQuery( wfScript( 'api' ), array( 'action' => 'rsd' ) ) ),
+ // Output a protocol-relative URL here if $wgServer is protocol-relative
+ // Whether RSD accepts relative or protocol-relative URLs is completely undocumented, though
+ 'href' => wfExpandUrl( wfAppendQuery( wfScript( 'api' ), array( 'action' => 'rsd' ) ), PROTO_RELATIVE ),
) );
}
- # Metadata links
- # - Creative Commons
- # See http://wiki.creativecommons.org/Extend_Metadata.
- # - Dublin Core
- # Use hreflang to specify canonical and alternate links
- # See http://www.google.com/support/webmasters/bin/answer.py?answer=189077
- if ( $this->isArticleRelated() ) {
- # note: buggy CC software only reads first "meta" link
- if ( $wgEnableCreativeCommonsRdf ) {
- $tags[] = Html::element( 'link', array(
- 'rel' => $this->getMetadataAttribute(),
- 'title' => 'Creative Commons',
- 'type' => 'application/rdf+xml',
- 'href' => $this->getTitle()->getLocalURL( 'action=creativecommons' ) )
- );
- }
-
- if ( $wgEnableDublinCoreRdf ) {
- $tags[] = Html::element( 'link', array(
- 'rel' => $this->getMetadataAttribute(),
- 'title' => 'Dublin Core',
- 'type' => 'application/rdf+xml',
- 'href' => $this->getTitle()->getLocalURL( 'action=dublincore' ) )
- );
- }
- }
-
# Language variants
if ( !$wgDisableLangConversion && $wgCanonicalLanguageLinks
&& $wgContLang->hasVariants() ) {
} else {
$tags[] = Html::element( 'link', array(
'rel' => 'canonical',
- 'href' => $this->getTitle()->getFullURL() )
- );
+ 'href' => $this->getTitle()->getCanonicalUrl()
+ ) );
}
}
# Feeds
if ( $wgFeed ) {
foreach( $this->getSyndicationLinks() as $format => $link ) {
- # Use the page name for the title (accessed through $wgTitle since
- # there's no other way). In principle, this could lead to issues
- # with having the same name for different feeds corresponding to
- # the same page, but we can't avoid that at this low a level.
+ # Use the page name for the title. In principle, this could
+ # lead to issues with having the same name for different feeds
+ # corresponding to the same page, but we can't avoid that at
+ # this low a level.
$tags[] = $this->feedLink(
$format,
if ( $wgOverrideSiteFeed ) {
foreach ( $wgOverrideSiteFeed as $type => $feedUrl ) {
+ // Note, this->feedLink escapes the url.
$tags[] = $this->feedLink(
$type,
- htmlspecialchars( $feedUrl ),
+ $feedUrl,
wfMsg( "site-{$type}-feed", $wgSitename )
);
}
/**
* Adds inline CSS styles
* @param $style_css Mixed: inline CSS
+ * @param $flip String: Set to 'flip' to flip the CSS if needed
*/
- public function addInlineStyle( $style_css ){
+ public function addInlineStyle( $style_css, $flip = 'noflip' ) {
+ if( $flip === 'flip' && $this->getLang()->isRTL() ) {
+ # If wanted, and the interface is right-to-left, flip the CSS
+ $style_css = CSSJanus::transform( $style_css, true, false );
+ }
$this->mInlineStyles .= Html::inlineStyle( $style_css );
}
/**
* Build a set of <link>s for the stylesheets specified in the $this->styles array.
* These will be applied to various media & IE conditionals.
- * @param $sk Skin object
+ *
+ * @return string
*/
- public function buildCssLinks( $sk ) {
- $ret = '';
+ public function buildCssLinks() {
+ global $wgUseSiteCss, $wgAllowUserCss, $wgAllowUserCssPrefs;
+
+ $this->getSkin()->setupSkinUserCss( $this );
+
// Add ResourceLoader styles
// Split the styles into four groups
$styles = array( 'other' => array(), 'user' => array(), 'site' => array(), 'private' => array(), 'noscript' => array() );
+ $otherTags = ''; // Tags to append after the normal <link> tags
$resourceLoader = $this->getResourceLoader();
- foreach ( $this->getModuleStyles() as $name ) {
+
+ $moduleStyles = $this->getModuleStyles();
+
+ // Per-site custom styles
+ if ( $wgUseSiteCss ) {
+ $moduleStyles[] = 'site';
+ $moduleStyles[] = 'noscript';
+ if( $this->getUser()->isLoggedIn() ){
+ $moduleStyles[] = 'user.groups';
+ }
+ }
+
+ // Per-user custom styles
+ if ( $wgAllowUserCss ) {
+ if ( $this->getTitle()->isCssSubpage() && $this->userCanPreview() ) {
+ // We're on a preview of a CSS subpage
+ // Exclude this page from the user module in case it's in there (bug 26283)
+ $otherTags .= $this->makeResourceLoaderLink( 'user', ResourceLoaderModule::TYPE_STYLES, false,
+ array( 'excludepage' => $this->getTitle()->getPrefixedDBkey() )
+ );
+ // Load the previewed CSS
+ $otherTags .= Html::inlineStyle( $this->getRequest()->getText( 'wpTextbox1' ) );
+ } else {
+ // Load the user styles normally
+ $moduleStyles[] = 'user';
+ }
+ }
+
+ // Per-user preference styles
+ if ( $wgAllowUserCssPrefs ) {
+ $moduleStyles[] = 'user.options';
+ }
+
+ foreach ( $moduleStyles as $name ) {
$group = $resourceLoader->getModule( $name )->getGroup();
// Modules in groups named "other" or anything different than "user", "site" or "private"
// will be placed in the "other" group
// dynamically added styles to override statically added styles from other modules. So the order
// has to be other, dynamic, site, private, user
// Add statically added styles for other modules
- $ret .= $this->makeResourceLoaderLink( $sk, $styles['other'], ResourceLoaderModule::TYPE_STYLES );
+ $ret = $this->makeResourceLoaderLink( $styles['other'], ResourceLoaderModule::TYPE_STYLES );
// Add normal styles added through addStyle()/addInlineStyle() here
$ret .= implode( "\n", $this->buildCssLinksArray() ) . $this->mInlineStyles;
// Add marker tag to mark the place where the client-side loader should inject dynamic styles
// 'private' at present only contains user.options, so put that before 'user'
// Any future private modules will likely have a similar user-specific character
foreach ( array( 'site', 'noscript', 'private', 'user' ) as $group ) {
- $ret .= $this->makeResourceLoaderLink( $sk, $styles[$group],
+ $ret .= $this->makeResourceLoaderLink( $styles[$group],
ResourceLoaderModule::TYPE_STYLES
);
}
+
+ // Add stuff in $otherTags (previewed user CSS if applicable)
+ $ret .= $otherTags;
return $ret;
}
+ /**
+ * @return Array
+ */
public function buildCssLinksArray() {
$links = array();
+
+ // Add any extension CSS
+ foreach ( $this->mExtStyles as $url ) {
+ $this->addStyle( $url );
+ }
+ $this->mExtStyles = array();
+
foreach( $this->styles as $file => $options ) {
$link = $this->styleLink( $file, $options );
if( $link ) {
*/
protected function styleLink( $style, $options ) {
if( isset( $options['dir'] ) ) {
- $siteDir = wfUILang()->getDir();
- if( $siteDir != $options['dir'] ) {
+ if( $this->getLang()->getDir() != $options['dir'] ) {
return '';
}
}
* instead of a variable argument list.
*
* $options is passed through to wfMsgExt(), see that function for details.
+ *
+ * @param $name string
+ * @param $args array
+ * @param $options array
*/
public function addWikiMsgArray( $name, $args, $options = array() ) {
$options[] = 'parse';
* $wgOut->addWikiText( "<div class='error'>\n" . wfMsgNoTrans( 'some-error' ) . "\n</div>" );
*
* The newline after opening div is needed in some wikitext. See bug 19226.
+ *
+ * @param $wrap string
*/
public function wrapWikiMsg( $wrap /*, ...*/ ) {
$msgSpecs = func_get_args();