2004-02-18 02:15:00 +00:00
|
|
|
<?php
|
2012-05-11 08:34:29 +00:00
|
|
|
/**
|
|
|
|
|
* Preparation for the final page rendering.
|
|
|
|
|
*
|
|
|
|
|
* This program is free software; you can redistribute it and/or modify
|
|
|
|
|
* it under the terms of the GNU General Public License as published by
|
|
|
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
|
|
|
* (at your option) any later version.
|
|
|
|
|
*
|
|
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
|
* GNU General Public License for more details.
|
|
|
|
|
*
|
|
|
|
|
* You should have received a copy of the GNU General Public License along
|
|
|
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
|
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
|
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
|
|
|
*
|
|
|
|
|
* @file
|
|
|
|
|
*/
|
|
|
|
|
|
2015-06-04 03:52:45 +00:00
|
|
|
use MediaWiki\Logger\LoggerFactory;
|
2016-11-30 21:28:55 +00:00
|
|
|
use MediaWiki\MediaWikiServices;
|
2016-02-01 20:44:03 +00:00
|
|
|
use MediaWiki\Session\SessionManager;
|
2015-07-31 00:13:04 +00:00
|
|
|
use WrappedString\WrappedString;
|
2016-07-07 19:26:36 +00:00
|
|
|
use WrappedString\WrappedStringList;
|
2015-06-04 03:52:45 +00:00
|
|
|
|
2004-09-02 23:28:24 +00:00
|
|
|
/**
|
2011-01-13 21:08:59 +00:00
|
|
|
* This class should be covered by a general architecture document which does
|
2011-03-26 15:18:16 +00:00
|
|
|
* not exist as of January 2011. This is one of the Core classes and should
|
2011-01-13 21:08:59 +00:00
|
|
|
* be read at least once by any new developers.
|
|
|
|
|
*
|
|
|
|
|
* This class is used to prepare the final rendering. A skin is then
|
|
|
|
|
* applied to the output parameters (links, javascript, html, categories ...).
|
2011-04-23 19:28:35 +00:00
|
|
|
*
|
2011-05-17 22:03:20 +00:00
|
|
|
* @todo FIXME: Another class handles sending the whole page to the client.
|
2011-04-23 19:28:35 +00:00
|
|
|
*
|
2011-10-24 09:08:13 +00:00
|
|
|
* Some comments comes from a pairing session between Zak Greant and Antoine Musso
|
2011-03-26 15:18:16 +00:00
|
|
|
* in November 2010.
|
2011-01-13 21:08:59 +00:00
|
|
|
*
|
2004-09-02 23:28:24 +00:00
|
|
|
* @todo document
|
|
|
|
|
*/
|
2011-07-30 19:37:19 +00:00
|
|
|
class OutputPage extends ContextSource {
|
2014-05-11 01:54:15 +00:00
|
|
|
/** @var array Should be private. Used with addMeta() which adds "<meta>" */
|
2016-02-17 09:09:32 +00:00
|
|
|
protected $mMetatags = [];
|
2011-01-13 21:08:59 +00:00
|
|
|
|
2014-05-11 01:54:15 +00:00
|
|
|
/** @var array */
|
2016-02-17 09:09:32 +00:00
|
|
|
protected $mLinktags = [];
|
2011-01-13 21:08:59 +00:00
|
|
|
|
2014-05-11 01:54:15 +00:00
|
|
|
/** @var bool */
|
|
|
|
|
protected $mCanonicalUrl = false;
|
2011-01-13 22:08:13 +00:00
|
|
|
|
2014-05-11 01:54:15 +00:00
|
|
|
/**
|
|
|
|
|
* @var array Additional stylesheets. Looks like this is for extensions.
|
2015-10-28 03:24:40 +00:00
|
|
|
* Might be replaced by ResourceLoader.
|
2014-05-11 01:54:15 +00:00
|
|
|
*/
|
2016-02-17 09:09:32 +00:00
|
|
|
protected $mExtStyles = [];
|
2014-05-11 01:54:15 +00:00
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @var string Should be private - has getter and setter. Contains
|
|
|
|
|
* the HTML title */
|
|
|
|
|
public $mPagetitle = '';
|
2011-01-13 21:08:59 +00:00
|
|
|
|
2014-05-11 01:54:15 +00:00
|
|
|
/**
|
|
|
|
|
* @var string Contains all of the "<body>" content. Should be private we
|
|
|
|
|
* got set/get accessors and the append() method.
|
|
|
|
|
*/
|
|
|
|
|
public $mBodytext = '';
|
2010-07-08 08:12:19 +00:00
|
|
|
|
2014-05-11 01:54:15 +00:00
|
|
|
/** @var string Stores contents of "<title>" tag */
|
|
|
|
|
private $mHTMLtitle = '';
|
2011-07-27 13:14:28 +00:00
|
|
|
|
|
|
|
|
/**
|
2014-05-11 01:54:15 +00:00
|
|
|
* @var bool Is the displayed content related to the source of the
|
|
|
|
|
* corresponding wiki article.
|
2011-07-27 13:14:28 +00:00
|
|
|
*/
|
2014-05-11 01:54:15 +00:00
|
|
|
private $mIsarticle = false;
|
|
|
|
|
|
|
|
|
|
/** @var bool Stores "article flag" toggle. */
|
|
|
|
|
private $mIsArticleRelated = true;
|
2011-01-13 21:08:59 +00:00
|
|
|
|
2011-01-14 07:54:28 +00:00
|
|
|
/**
|
2014-05-11 01:54:15 +00:00
|
|
|
* @var bool We have to set isPrintable(). Some pages should
|
2011-01-14 07:54:28 +00:00
|
|
|
* never be printed (ex: redirections).
|
2011-01-13 21:08:59 +00:00
|
|
|
*/
|
2014-05-11 01:54:15 +00:00
|
|
|
private $mPrintable = false;
|
2011-01-13 21:08:59 +00:00
|
|
|
|
2011-01-14 07:54:28 +00:00
|
|
|
/**
|
2014-05-11 01:54:15 +00:00
|
|
|
* @var array Contains the page subtitle. Special pages usually have some
|
|
|
|
|
* links here. Don't confuse with site subtitle added by skins.
|
2011-01-13 22:20:04 +00:00
|
|
|
*/
|
2016-02-17 09:09:32 +00:00
|
|
|
private $mSubtitle = [];
|
2011-01-13 21:08:59 +00:00
|
|
|
|
2014-05-11 01:54:15 +00:00
|
|
|
/** @var string */
|
|
|
|
|
public $mRedirect = '';
|
|
|
|
|
|
|
|
|
|
/** @var int */
|
|
|
|
|
protected $mStatusCode;
|
2011-01-13 21:08:59 +00:00
|
|
|
|
2011-01-14 07:54:28 +00:00
|
|
|
/**
|
2016-06-27 11:21:14 +00:00
|
|
|
* @var string Used for sending cache control.
|
2014-05-11 01:54:15 +00:00
|
|
|
* The whole caching system should probably be moved into its own class.
|
2011-01-14 07:54:28 +00:00
|
|
|
*/
|
2014-05-11 01:54:15 +00:00
|
|
|
protected $mLastModified = '';
|
2011-01-13 22:08:13 +00:00
|
|
|
|
2014-05-11 01:54:15 +00:00
|
|
|
/** @var array */
|
2016-02-17 09:09:32 +00:00
|
|
|
protected $mCategoryLinks = [];
|
2011-01-13 21:08:59 +00:00
|
|
|
|
2014-05-11 01:54:15 +00:00
|
|
|
/** @var array */
|
2016-07-08 19:11:53 +00:00
|
|
|
protected $mCategories = [
|
|
|
|
|
'hidden' => [],
|
|
|
|
|
'normal' => [],
|
|
|
|
|
];
|
2011-01-13 21:08:59 +00:00
|
|
|
|
Implement page status indicators
Page status indicators are icons (or short text snippets) usually
displayed in the top-right corner of the page, outside of the main
content. Basically, <indicator name="foo">[[File:Foo.svg|20px]]</indicator>
may be used on a page to place the icon in the indicator area. They
are also known as top icons, page icons, heading icons or title icons.
I found the discussion on bug 23796 highly illuminating. I suggest
that everyone read it before suggesting different design choices.
I spent some time with a thesaurus pondering the name. "Emblems" and
"badges" were also considered, but the former has a much more limited
meaning and the latter is already taken by Wikidata, with a similar
but subtly different feature set. I am not aware of any naming
conflicts ;) besides new talk page message "indicator" (used by core
and Echo in some documents) and OOjs UI indicators (tiny icons like
the arrow on a dropdown form element), which shouldn't be confusing.
Potential use cases include:
* "Lock" indicators for page protection levels
* Featured/good article indicators
* Redirect shortcuts display ("WP:VPT")
* Links to help/manual for special pages
* Coordinates?… or globe icon for inline pop-up maps
Design features:
* Skin-customizable. Skins can fully control where and how indicators
are shown, or may just do <?php echo $this->getIndicators(); ?> to
output the default structure. By default they are not shown at all.
* Extension-customizable. Extensions can call ParserOutput::addIndicator()
to insert an indicator from one of the numerous parser hooks.
* Wiki-customizable. In addition to just using the parser functions,
on-wiki styles and scripts can use the provided classes and ids
(.mw-indicator, #mw-indicator-<name>) to customize their display.
Design limitations:
* Every indicator must have a unique identifier (name). It's not
possible to create arrays, or to have several indicators with the
same name. In case of duplicates, the latest occurrence of the
parser function wins.
* Indicators are displayed ordered by their names (and not occurrence
order). This ensures consistency across pages and provides a simple
means of ordering or grouping them.
* Indicators are not stored, tracked or accessible outside of
ParserOutput (in particular they're not in the page_props table).
They are intended to merely reflect the content or metadata that is
already present on the page, and not be data themselves. If you ever
think you need to list pages with a given status indicator, instead
figure out what it means and use the appropriate tracking category,
special page report, already existing page_prop, or other means.
Corresponding patch in Vector: I90a8ae15ac8275d084ea5f47b6b2684d5e6c7412.
I'll implement support in the other three skins included in the tarball
and document it on mediawiki.org after this is merged.
Bug: 23796
Change-Id: I2389ff9a5332a2b1d033eb75f0946e5241cfaaf4
2014-09-24 10:44:16 +00:00
|
|
|
/** @var array */
|
2016-02-17 09:09:32 +00:00
|
|
|
protected $mIndicators = [];
|
Implement page status indicators
Page status indicators are icons (or short text snippets) usually
displayed in the top-right corner of the page, outside of the main
content. Basically, <indicator name="foo">[[File:Foo.svg|20px]]</indicator>
may be used on a page to place the icon in the indicator area. They
are also known as top icons, page icons, heading icons or title icons.
I found the discussion on bug 23796 highly illuminating. I suggest
that everyone read it before suggesting different design choices.
I spent some time with a thesaurus pondering the name. "Emblems" and
"badges" were also considered, but the former has a much more limited
meaning and the latter is already taken by Wikidata, with a similar
but subtly different feature set. I am not aware of any naming
conflicts ;) besides new talk page message "indicator" (used by core
and Echo in some documents) and OOjs UI indicators (tiny icons like
the arrow on a dropdown form element), which shouldn't be confusing.
Potential use cases include:
* "Lock" indicators for page protection levels
* Featured/good article indicators
* Redirect shortcuts display ("WP:VPT")
* Links to help/manual for special pages
* Coordinates?… or globe icon for inline pop-up maps
Design features:
* Skin-customizable. Skins can fully control where and how indicators
are shown, or may just do <?php echo $this->getIndicators(); ?> to
output the default structure. By default they are not shown at all.
* Extension-customizable. Extensions can call ParserOutput::addIndicator()
to insert an indicator from one of the numerous parser hooks.
* Wiki-customizable. In addition to just using the parser functions,
on-wiki styles and scripts can use the provided classes and ids
(.mw-indicator, #mw-indicator-<name>) to customize their display.
Design limitations:
* Every indicator must have a unique identifier (name). It's not
possible to create arrays, or to have several indicators with the
same name. In case of duplicates, the latest occurrence of the
parser function wins.
* Indicators are displayed ordered by their names (and not occurrence
order). This ensures consistency across pages and provides a simple
means of ordering or grouping them.
* Indicators are not stored, tracked or accessible outside of
ParserOutput (in particular they're not in the page_props table).
They are intended to merely reflect the content or metadata that is
already present on the page, and not be data themselves. If you ever
think you need to list pages with a given status indicator, instead
figure out what it means and use the appropriate tracking category,
special page report, already existing page_prop, or other means.
Corresponding patch in Vector: I90a8ae15ac8275d084ea5f47b6b2684d5e6c7412.
I'll implement support in the other three skins included in the tarball
and document it on mediawiki.org after this is merged.
Bug: 23796
Change-Id: I2389ff9a5332a2b1d033eb75f0946e5241cfaaf4
2014-09-24 10:44:16 +00:00
|
|
|
|
2014-05-11 01:54:15 +00:00
|
|
|
/** @var array Array of Interwiki Prefixed (non DB key) Titles (e.g. 'fr:Test page') */
|
2016-02-17 09:09:32 +00:00
|
|
|
private $mLanguageLinks = [];
|
2011-01-13 21:08:59 +00:00
|
|
|
|
2011-01-14 07:54:28 +00:00
|
|
|
/**
|
2015-10-28 03:24:40 +00:00
|
|
|
* Used for JavaScript (predates ResourceLoader)
|
2014-05-11 01:54:15 +00:00
|
|
|
* @todo We should split JS / CSS.
|
2012-07-10 12:48:06 +00:00
|
|
|
* mScripts content is inserted as is in "<head>" by Skin. This might
|
2014-05-11 01:54:15 +00:00
|
|
|
* contain either a link to a stylesheet or inline CSS.
|
2011-01-13 21:08:59 +00:00
|
|
|
*/
|
2014-05-11 01:54:15 +00:00
|
|
|
private $mScripts = '';
|
2011-01-14 07:54:28 +00:00
|
|
|
|
2014-05-11 01:54:15 +00:00
|
|
|
/** @var string Inline CSS styles. Use addInlineStyle() sparingly */
|
|
|
|
|
protected $mInlineStyles = '';
|
2011-01-13 21:08:59 +00:00
|
|
|
|
|
|
|
|
/**
|
2014-05-11 01:54:15 +00:00
|
|
|
* @var string Used by skin template.
|
2011-01-13 21:08:59 +00:00
|
|
|
* Example: $tpl->set( 'displaytitle', $out->mPageLinkTitle );
|
|
|
|
|
*/
|
2014-05-11 01:54:15 +00:00
|
|
|
public $mPageLinkTitle = '';
|
|
|
|
|
|
|
|
|
|
/** @var array Array of elements in "<head>". Parser might add its own headers! */
|
2016-02-17 09:09:32 +00:00
|
|
|
protected $mHeadItems = [];
|
2014-05-11 01:54:15 +00:00
|
|
|
|
2017-09-11 07:12:03 +00:00
|
|
|
/** @var array Additional <body> classes; there are also <body> classes from other sources */
|
|
|
|
|
protected $mAdditionalBodyClasses = [];
|
|
|
|
|
|
2014-05-11 01:54:15 +00:00
|
|
|
/** @var array */
|
2016-02-17 09:09:32 +00:00
|
|
|
protected $mModules = [];
|
2014-05-11 01:54:15 +00:00
|
|
|
|
|
|
|
|
/** @var array */
|
2016-02-17 09:09:32 +00:00
|
|
|
protected $mModuleScripts = [];
|
2014-05-11 01:54:15 +00:00
|
|
|
|
|
|
|
|
/** @var array */
|
2016-02-17 09:09:32 +00:00
|
|
|
protected $mModuleStyles = [];
|
2010-07-08 08:12:19 +00:00
|
|
|
|
2014-05-11 01:54:15 +00:00
|
|
|
/** @var ResourceLoader */
|
|
|
|
|
protected $mResourceLoader;
|
2011-01-13 22:08:13 +00:00
|
|
|
|
resourceloader: Move queue formatting out of OutputPage
HTML formatting of the queue was distributed over several OutputPage methods.
Each method demanding a snippet of HTML by calling makeResourceLoaderLink()
with a limited amount of information. As such, makeResourceLoaderLink() was
unable to provide the client with the proper state information.
Centralising it also allows it to better reduce duplication in HTML output
and maintain a more accurate state.
Problems fixed by centralising:
1. The 'user' module is special (due to per-user 'version' and 'user' params).
It is manually requested via script-src. To avoid a separate (and wrong)
request from something that requires it, we set state=loading directly.
However, because the module is in the bottom, the old HTML formatter could
only put state=loading in the bottom also. This sometimes caused a wrong
request to be fired for modules=user if something in the top queue
triggered a requirement for it.
2. Since a464d1d4 (T87871) we track states of page-style modules, with purpose
of allowing dependencies on style modules without risking duplicate loading
on pages where the styles are loaded already. This didn't work, because the
state information about page-style modules is output near the stylesheet,
which is after the script tag with mw.loader.load(). That runs first, and
mw.loader would still make a duplicate request before it learns the state.
Changes:
* Document reasons for style/script tag order in getHeadHtml (per 09537e83).
* Pass $type from getModuleStyles() to getAllowedModules(). This wasn't needed
before since a duplicate check in makeResourceLoaderLink() verified the
origin a second time.
* Declare explicit position 'top' on 'user.options' and 'user.tokens' module.
Previously, OutputPage hardcoded them in the top. The new formatter doesn't.
* Remove getHeadScripts().
* Remove getInlineHeadScripts().
* Remove getExternalHeadScripts().
* Remove buildCssLinks().
* Remove getScriptsForBottomQueue().
* Change where Skin::setupSkinUserCss() is called. This methods lets the skin
add modules to the queue. Previously it was called from buildCssLinks(),
via headElement(), via prepareQuickTemplate(), via OutputPage::output().
It's now in OutputPage::output() directly (slightly earlier). This is needed
because prepareQuickTemplate() calls bottomScripts() before headElement().
And bottomScript() would lazy-initialise the queue and lock it before
setupSkinUserCss() is called from headElement().
This makes execution order more predictable instead of being dependent on
the arbitrary order of data extraction in prepareQuickTemplate (which varies
from one skin to another).
* Compute isUserModulePreview() and isKnownEmpty() for the 'user' module early
on so. This avoids wrongful loading and fixes problem 1.
Effective changes in output:
* mw.loader.state() is now before mw.loader.load(). This fixes problem 2.
* mw.loader.state() now sets 'user.options' and 'user.tokens' to "loading".
* mw.loader.state() now sets 'user' (as "loading" or "ready"). Fixes problem 1.
* The <script async src> tag for 'startup' changed position (slightly).
Previously it was after all inline scripts and stylesheets. It's still after
all inline scripts and after most stylesheets, but before any user styles.
Since the queue is now formatted outside OutputPage, it can't inject the
meta-ResourceLoaderDynamicStyles tag and user-stylesheet hack in the middle
of existing output. This shouldn't have any noticable impact.
Bug: T87871
Change-Id: I605b8cd1e1fc009b4662a0edbc54d09dd65ee1df
2016-07-15 14:13:09 +00:00
|
|
|
/** @var ResourceLoaderClientHtml */
|
|
|
|
|
private $rlClient;
|
|
|
|
|
|
|
|
|
|
/** @var ResourceLoaderContext */
|
|
|
|
|
private $rlClientContext;
|
|
|
|
|
|
|
|
|
|
/** @var string */
|
|
|
|
|
private $rlUserModuleState;
|
|
|
|
|
|
2016-08-19 02:04:21 +00:00
|
|
|
/** @var array */
|
|
|
|
|
private $rlExemptStyleModules;
|
|
|
|
|
|
2014-05-11 01:54:15 +00:00
|
|
|
/** @var array */
|
2016-02-17 09:09:32 +00:00
|
|
|
protected $mJsConfigVars = [];
|
2009-09-17 01:19:02 +00:00
|
|
|
|
2014-05-11 01:54:15 +00:00
|
|
|
/** @var array */
|
2016-02-17 09:09:32 +00:00
|
|
|
protected $mTemplateIds = [];
|
2006-05-11 22:40:38 +00:00
|
|
|
|
2014-05-11 01:54:15 +00:00
|
|
|
/** @var array */
|
2016-02-17 09:09:32 +00:00
|
|
|
protected $mImageTimeKeys = [];
|
2011-07-06 17:55:44 +00:00
|
|
|
|
2014-05-11 01:54:15 +00:00
|
|
|
/** @var string */
|
|
|
|
|
public $mRedirectCode = '';
|
2011-07-06 17:55:44 +00:00
|
|
|
|
2014-05-11 01:54:15 +00:00
|
|
|
protected $mFeedLinksAppendQuery = null;
|
|
|
|
|
|
2014-10-10 06:46:12 +00:00
|
|
|
/** @var array
|
|
|
|
|
* What level of 'untrustworthiness' is allowed in CSS/JS modules loaded on this page?
|
2014-05-11 01:54:15 +00:00
|
|
|
* @see ResourceLoaderModule::$origin
|
2014-10-10 06:46:12 +00:00
|
|
|
* ResourceLoaderModule::ORIGIN_ALL is assumed unless overridden;
|
2014-05-11 01:54:15 +00:00
|
|
|
*/
|
2016-02-17 09:09:32 +00:00
|
|
|
protected $mAllowedModules = [
|
2014-10-10 06:46:12 +00:00
|
|
|
ResourceLoaderModule::TYPE_COMBINED => ResourceLoaderModule::ORIGIN_ALL,
|
2016-02-17 09:09:32 +00:00
|
|
|
];
|
2011-01-13 21:08:59 +00:00
|
|
|
|
2014-05-11 01:54:15 +00:00
|
|
|
/** @var bool Whether output is disabled. If this is true, the 'output' method will do nothing. */
|
|
|
|
|
protected $mDoNothing = false;
|
|
|
|
|
|
|
|
|
|
// Parser related.
|
|
|
|
|
|
|
|
|
|
/** @var int */
|
|
|
|
|
protected $mContainsNewMagic = 0;
|
2011-01-13 21:08:59 +00:00
|
|
|
|
2011-10-26 03:44:47 +00:00
|
|
|
/**
|
|
|
|
|
* lazy initialised, use parserOptions()
|
|
|
|
|
* @var ParserOptions
|
|
|
|
|
*/
|
2011-01-13 21:08:59 +00:00
|
|
|
protected $mParserOptions = null;
|
|
|
|
|
|
2011-01-14 07:54:28 +00:00
|
|
|
/**
|
2014-05-11 01:54:15 +00:00
|
|
|
* Handles the Atom / RSS links.
|
|
|
|
|
* We probably only support Atom in 2011.
|
2011-01-14 07:54:28 +00:00
|
|
|
* @see $wgAdvertisedFeedTypes
|
2011-01-13 21:08:59 +00:00
|
|
|
*/
|
2016-02-17 09:09:32 +00:00
|
|
|
private $mFeedLinks = [];
|
2009-11-07 09:26:02 +00:00
|
|
|
|
2011-01-13 21:08:59 +00:00
|
|
|
// Gwicke work on squid caching? Roughly from 2003.
|
2014-05-11 01:54:15 +00:00
|
|
|
protected $mEnableClientCache = true;
|
2011-01-13 21:08:59 +00:00
|
|
|
|
2014-05-11 01:54:15 +00:00
|
|
|
/** @var bool Flag if output should only contain the body of the article. */
|
|
|
|
|
private $mArticleBodyOnly = false;
|
|
|
|
|
|
|
|
|
|
/** @var bool */
|
|
|
|
|
protected $mNewSectionLink = false;
|
2008-04-14 07:45:50 +00:00
|
|
|
|
2014-05-11 01:54:15 +00:00
|
|
|
/** @var bool */
|
|
|
|
|
protected $mHideNewSectionLink = false;
|
2011-01-13 21:08:59 +00:00
|
|
|
|
2011-01-14 07:54:28 +00:00
|
|
|
/**
|
2014-05-11 01:54:15 +00:00
|
|
|
* @var bool Comes from the parser. This was probably made to load CSS/JS
|
|
|
|
|
* only if we had "<gallery>". Used directly in CategoryPage.php.
|
2015-10-28 03:24:40 +00:00
|
|
|
* Looks like ResourceLoader can replace this.
|
2011-01-13 21:08:59 +00:00
|
|
|
*/
|
2014-05-11 01:54:15 +00:00
|
|
|
public $mNoGallery = false;
|
|
|
|
|
|
|
|
|
|
/** @var string */
|
|
|
|
|
private $mPageTitleActionText = '';
|
2011-01-13 21:08:59 +00:00
|
|
|
|
2014-05-11 01:54:15 +00:00
|
|
|
/** @var int Cache stuff. Looks like mEnableClientCache */
|
2015-12-10 01:07:05 +00:00
|
|
|
protected $mCdnMaxage = 0;
|
|
|
|
|
/** @var int Upper limit on mCdnMaxage */
|
2015-10-01 07:24:18 +00:00
|
|
|
protected $mCdnMaxageLimit = INF;
|
2011-01-13 21:08:59 +00:00
|
|
|
|
2014-05-11 01:54:15 +00:00
|
|
|
/**
|
2015-01-01 11:19:06 +00:00
|
|
|
* @var bool Controls if anti-clickjacking / frame-breaking headers will
|
|
|
|
|
* be sent. This should be done for pages where edit actions are possible.
|
|
|
|
|
* Setters: $this->preventClickjacking() and $this->allowClickjacking().
|
2014-05-11 01:54:15 +00:00
|
|
|
*/
|
|
|
|
|
protected $mPreventClickjacking = true;
|
|
|
|
|
|
|
|
|
|
/** @var int To include the variable {{REVISIONID}} */
|
|
|
|
|
private $mRevisionId = null;
|
2011-01-13 21:08:59 +00:00
|
|
|
|
2014-05-11 01:54:15 +00:00
|
|
|
/** @var string */
|
2011-12-10 16:30:40 +00:00
|
|
|
private $mRevisionTimestamp = null;
|
2011-01-13 21:08:59 +00:00
|
|
|
|
2014-05-11 01:54:15 +00:00
|
|
|
/** @var array */
|
|
|
|
|
protected $mFileVersion = null;
|
2011-07-05 05:23:26 +00:00
|
|
|
|
2008-08-21 14:09:57 +00:00
|
|
|
/**
|
2014-05-11 01:54:15 +00:00
|
|
|
* @var array An array of stylesheet filenames (relative from skins path),
|
|
|
|
|
* with options for CSS media, IE conditions, and RTL/LTR direction.
|
2008-08-21 14:09:57 +00:00
|
|
|
* For internal use; add settings in the skin via $this->addStyle()
|
2011-01-13 21:08:59 +00:00
|
|
|
*
|
|
|
|
|
* Style again! This seems like a code duplication since we already have
|
2014-05-11 01:54:15 +00:00
|
|
|
* mStyles. This is what makes Open Source amazing.
|
2008-08-21 14:09:57 +00:00
|
|
|
*/
|
2016-02-17 09:09:32 +00:00
|
|
|
protected $styles = [];
|
2008-08-21 14:09:57 +00:00
|
|
|
|
2008-07-23 19:05:43 +00:00
|
|
|
private $mIndexPolicy = 'index';
|
|
|
|
|
private $mFollowPolicy = 'follow';
|
2016-02-17 09:09:32 +00:00
|
|
|
private $mVaryHeader = [
|
|
|
|
|
'Accept-Encoding' => [ 'match=gzip' ],
|
|
|
|
|
];
|
2010-01-28 21:58:50 +00:00
|
|
|
|
2011-11-30 12:43:10 +00:00
|
|
|
/**
|
|
|
|
|
* If the current page was reached through a redirect, $mRedirectedFrom contains the Title
|
|
|
|
|
* of the redirect.
|
|
|
|
|
*
|
|
|
|
|
* @var Title
|
|
|
|
|
*/
|
|
|
|
|
private $mRedirectedFrom = null;
|
|
|
|
|
|
2013-02-08 22:58:38 +00:00
|
|
|
/**
|
|
|
|
|
* Additional key => value data
|
|
|
|
|
*/
|
2016-02-17 09:09:32 +00:00
|
|
|
private $mProperties = [];
|
2013-02-08 22:58:38 +00:00
|
|
|
|
2013-02-14 17:05:22 +00:00
|
|
|
/**
|
2014-04-08 15:29:17 +00:00
|
|
|
* @var string|null ResourceLoader target for load.php links. If null, will be omitted
|
2013-02-14 17:05:22 +00:00
|
|
|
*/
|
|
|
|
|
private $mTarget = null;
|
|
|
|
|
|
2013-08-22 22:22:03 +00:00
|
|
|
/**
|
2017-05-20 13:39:40 +00:00
|
|
|
* @var bool Whether parser output contains a table of contents
|
2013-08-22 22:22:03 +00:00
|
|
|
*/
|
2017-05-20 13:39:40 +00:00
|
|
|
private $mEnableTOC = false;
|
2013-08-22 22:22:03 +00:00
|
|
|
|
2014-03-11 20:00:02 +00:00
|
|
|
/**
|
2014-04-08 15:29:17 +00:00
|
|
|
* @var bool Whether parser output should contain section edit links
|
2014-03-11 20:00:02 +00:00
|
|
|
*/
|
|
|
|
|
private $mEnableSectionEditLinks = true;
|
|
|
|
|
|
2015-06-08 13:39:06 +00:00
|
|
|
/**
|
2017-06-07 12:11:08 +00:00
|
|
|
* @var string|null The URL to send in a <link> element with rel=license
|
2015-06-08 13:39:06 +00:00
|
|
|
*/
|
|
|
|
|
private $copyrightUrl;
|
|
|
|
|
|
2016-11-10 20:29:27 +00:00
|
|
|
/** @var array Profiling data */
|
|
|
|
|
private $limitReportJSData = [];
|
|
|
|
|
|
2015-06-01 16:58:42 +00:00
|
|
|
/**
|
|
|
|
|
* Link: header contents
|
|
|
|
|
*/
|
|
|
|
|
private $mLinkHeader = [];
|
|
|
|
|
|
2011-04-04 00:37:42 +00:00
|
|
|
/**
|
|
|
|
|
* 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.
|
2014-08-14 18:22:52 +00:00
|
|
|
* @param IContextSource|null $context
|
2011-04-04 00:37:42 +00:00
|
|
|
*/
|
2011-09-15 15:19:49 +00:00
|
|
|
function __construct( IContextSource $context = null ) {
|
2011-07-30 19:37:19 +00:00
|
|
|
if ( $context === null ) {
|
2011-04-04 00:37:42 +00:00
|
|
|
# Extensions should use `new RequestContext` instead of `new OutputPage` now.
|
2012-10-05 18:26:00 +00:00
|
|
|
wfDeprecated( __METHOD__, '1.18' );
|
2011-07-30 19:37:19 +00:00
|
|
|
} else {
|
|
|
|
|
$this->setContext( $context );
|
2011-04-04 00:37:42 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2010-01-28 21:58:50 +00:00
|
|
|
/**
|
|
|
|
|
* Redirect to $url rather than displaying the normal page
|
|
|
|
|
*
|
2013-03-11 17:15:01 +00:00
|
|
|
* @param string $url URL
|
|
|
|
|
* @param string $responsecode HTTP status code
|
2010-01-28 21:58:50 +00:00
|
|
|
*/
|
2006-11-07 05:37:31 +00:00
|
|
|
public function redirect( $url, $responsecode = '302' ) {
|
2006-06-23 03:56:03 +00:00
|
|
|
# Strip newlines as a paranoia check for header injection in PHP<5.1.2
|
|
|
|
|
$this->mRedirect = str_replace( "\n", '', $url );
|
|
|
|
|
$this->mRedirectCode = $responsecode;
|
|
|
|
|
}
|
2008-04-14 07:45:50 +00:00
|
|
|
|
2010-01-28 21:58:50 +00:00
|
|
|
/**
|
|
|
|
|
* Get the URL to redirect to, or an empty string if not redirect URL set
|
|
|
|
|
*
|
2014-04-10 18:50:10 +00:00
|
|
|
* @return string
|
2010-01-28 21:58:50 +00:00
|
|
|
*/
|
2007-11-06 01:16:25 +00:00
|
|
|
public function getRedirect() {
|
|
|
|
|
return $this->mRedirect;
|
|
|
|
|
}
|
2003-04-14 23:10:40 +00:00
|
|
|
|
2015-06-08 13:39:06 +00:00
|
|
|
/**
|
|
|
|
|
* Set the copyright URL to send with the output.
|
|
|
|
|
* Empty string to omit, null to reset.
|
|
|
|
|
*
|
|
|
|
|
* @since 1.26
|
|
|
|
|
*
|
|
|
|
|
* @param string|null $url
|
|
|
|
|
*/
|
|
|
|
|
public function setCopyrightUrl( $url ) {
|
|
|
|
|
$this->copyrightUrl = $url;
|
|
|
|
|
}
|
|
|
|
|
|
2006-11-07 05:37:31 +00:00
|
|
|
/**
|
|
|
|
|
* Set the HTTP status code to send with the output.
|
|
|
|
|
*
|
2014-04-10 18:50:10 +00:00
|
|
|
* @param int $statusCode
|
2006-11-07 05:37:31 +00:00
|
|
|
*/
|
2010-01-28 21:58:50 +00:00
|
|
|
public function setStatusCode( $statusCode ) {
|
|
|
|
|
$this->mStatusCode = $statusCode;
|
|
|
|
|
}
|
|
|
|
|
|
2008-08-21 14:09:57 +00:00
|
|
|
/**
|
2012-07-10 12:48:06 +00:00
|
|
|
* Add a new "<meta>" tag
|
2008-08-21 14:09:57 +00:00
|
|
|
* To add an http-equiv meta tag, precede the name with "http:"
|
|
|
|
|
*
|
2014-07-24 17:42:24 +00:00
|
|
|
* @param string $name Tag name
|
|
|
|
|
* @param string $val Tag value
|
2008-08-21 14:09:57 +00:00
|
|
|
*/
|
|
|
|
|
function addMeta( $name, $val ) {
|
2016-02-17 09:09:32 +00:00
|
|
|
array_push( $this->mMetatags, [ $name, $val ] );
|
2008-08-21 14:09:57 +00:00
|
|
|
}
|
|
|
|
|
|
2014-12-03 17:40:15 +00:00
|
|
|
/**
|
|
|
|
|
* Returns the current <meta> tags
|
|
|
|
|
*
|
|
|
|
|
* @since 1.25
|
|
|
|
|
* @return array
|
|
|
|
|
*/
|
|
|
|
|
public function getMetaTags() {
|
|
|
|
|
return $this->mMetatags;
|
|
|
|
|
}
|
|
|
|
|
|
2010-01-28 21:58:50 +00:00
|
|
|
/**
|
2012-12-31 01:11:43 +00:00
|
|
|
* Add a new \<link\> tag to the page header.
|
|
|
|
|
*
|
|
|
|
|
* Note: use setCanonicalUrl() for rel=canonical.
|
2010-01-28 21:58:50 +00:00
|
|
|
*
|
2014-07-24 17:42:24 +00:00
|
|
|
* @param array $linkarr Associative array of attributes.
|
2010-01-28 21:58:50 +00:00
|
|
|
*/
|
2014-07-23 02:49:30 +00:00
|
|
|
function addLink( array $linkarr ) {
|
2010-01-28 21:58:50 +00:00
|
|
|
array_push( $this->mLinktags, $linkarr );
|
|
|
|
|
}
|
|
|
|
|
|
2014-12-03 17:40:15 +00:00
|
|
|
/**
|
|
|
|
|
* Returns the current <link> tags
|
|
|
|
|
*
|
|
|
|
|
* @since 1.25
|
|
|
|
|
* @return array
|
|
|
|
|
*/
|
|
|
|
|
public function getLinkTags() {
|
|
|
|
|
return $this->mLinktags;
|
|
|
|
|
}
|
|
|
|
|
|
2010-01-28 21:58:50 +00:00
|
|
|
/**
|
|
|
|
|
* Add a new \<link\> with "rel" attribute set to "meta"
|
|
|
|
|
*
|
2014-07-24 17:42:24 +00:00
|
|
|
* @param array $linkarr Associative array mapping attribute names to their
|
2010-01-28 21:58:50 +00:00
|
|
|
* values, both keys and values will be escaped, and the
|
|
|
|
|
* "rel" attribute will be automatically added
|
|
|
|
|
*/
|
2014-07-23 02:49:30 +00:00
|
|
|
function addMetadataLink( array $linkarr ) {
|
2011-04-02 18:38:42 +00:00
|
|
|
$linkarr['rel'] = $this->getMetadataAttribute();
|
|
|
|
|
$this->addLink( $linkarr );
|
|
|
|
|
}
|
|
|
|
|
|
2012-12-31 01:11:43 +00:00
|
|
|
/**
|
|
|
|
|
* Set the URL to be used for the <link rel=canonical>. This should be used
|
|
|
|
|
* in preference to addLink(), to avoid duplicate link tags.
|
2014-08-14 18:22:52 +00:00
|
|
|
* @param string $url
|
2012-12-31 01:11:43 +00:00
|
|
|
*/
|
|
|
|
|
function setCanonicalUrl( $url ) {
|
|
|
|
|
$this->mCanonicalUrl = $url;
|
|
|
|
|
}
|
|
|
|
|
|
2014-12-03 17:40:15 +00:00
|
|
|
/**
|
|
|
|
|
* Returns the URL to be used for the <link rel=canonical> if
|
|
|
|
|
* one is set.
|
|
|
|
|
*
|
|
|
|
|
* @since 1.25
|
|
|
|
|
* @return bool|string
|
|
|
|
|
*/
|
|
|
|
|
public function getCanonicalUrl() {
|
|
|
|
|
return $this->mCanonicalUrl;
|
|
|
|
|
}
|
|
|
|
|
|
2011-04-02 18:38:42 +00:00
|
|
|
/**
|
|
|
|
|
* Get the value of the "rel" attribute for metadata links
|
|
|
|
|
*
|
2014-04-10 18:50:10 +00:00
|
|
|
* @return string
|
2011-04-02 18:38:42 +00:00
|
|
|
*/
|
2011-05-26 00:57:54 +00:00
|
|
|
public function getMetadataAttribute() {
|
2010-01-28 21:58:50 +00:00
|
|
|
# note: buggy CC software only reads first "meta" link
|
|
|
|
|
static $haveMeta = false;
|
2011-04-02 18:38:42 +00:00
|
|
|
if ( $haveMeta ) {
|
|
|
|
|
return 'alternate meta';
|
|
|
|
|
} else {
|
|
|
|
|
$haveMeta = true;
|
|
|
|
|
return 'meta';
|
|
|
|
|
}
|
2010-01-28 21:58:50 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Add raw HTML to the list of scripts (including \<script\> tag, etc.)
|
2015-10-31 15:16:58 +00:00
|
|
|
* Internal use only. Use OutputPage::addModules() or OutputPage::addJsConfigVars()
|
|
|
|
|
* if possible.
|
2010-01-28 21:58:50 +00:00
|
|
|
*
|
2014-07-24 17:42:24 +00:00
|
|
|
* @param string $script Raw HTML
|
2010-01-28 21:58:50 +00:00
|
|
|
*/
|
2009-08-07 00:16:54 +00:00
|
|
|
function addScript( $script ) {
|
2016-02-18 16:33:15 +00:00
|
|
|
$this->mScripts .= $script;
|
2009-08-07 00:16:54 +00:00
|
|
|
}
|
here it is ... the upload-api, script-server, js2 (javascript phase2) branch merge 1st attempt.
Here is a short overview of changes and associated default configuration variables (most everything is off by default) also see ~soon to be updated~: http://www.mediawiki.org/wiki/Media_Projects_Overview
= Upload Improvements =
==Upload API ==
* Based on the early work of Bryan Tong and others it adds the upload option to the api.
* We rewrite Special:Upload page to include use the new refactoring
* Added in token checks in both the SpecialUpload.php page so avoids DOS / xss copy-by-url JavaScript based cross site POST file submissions
== Copy by URL==
$wgAllowCopyUploads = false;
* http class rewrite includes a new http background download see: includes/HttpFunctions.php
* spins off a php process that calls: maintenance/http_session_download.php
* pushes updates to the session and gives the user a progress bar on http copy uploads from other server progress (using js2 upload interface) (if not using the js2 upload interface it does the request in-place but the download is limited to the php ini timeout time)
== Firefogg ==
* Firefogg enables resumable upload by chunks
* progress indicators and conditional invokation (js2 system)
* and of-course client side transcoding.
= Script Server =
$wgEnableScriptLoader = false;
* off by default if $wgEnableScriptLoader is turned on script files are grouped, gziped, cached etc.
for more info see: http://www.mediawiki.org/wiki/Extension:ScriptLoader
* Includes some early skin js include fixes (skin/script system still lots of love)
* Includes a "javascript class autoloader" this is packaged into mwEmbed so that the mwEmbed library can work in stand alone mode (while retaining localization and script serving) (one such application is the make page for firefogg.org : http://www.firefogg.org/make/index.html )
* The file that contains the autojavascript loading classes is: js2/php/jsAutoloadLocalClasses.php
* One can use this auto class loading dependency system with extensions and add-ons but I need to better document that.
= js2 system / mwEmbed=
$wgEnableJS2system = false
* includes initial rewrite towards more jquery based javascript code
* especially for the Special:Upload page.
* Also the edit page include support for the "add-media-wizard"
* includes dependency loader for javascript that optionally takes advantage of the script-loader
* remote embedding of javascript interfaces (like embedding video, or commons media searching)
* $wgDebugJavaScript = false; .. .this variable lets you always get "always fresh javascript". When used with the script-loader it does not minify the script-loader output.
= mwEmbed =
* Will commit a separate patch to oggHandler that conditionally outputs <video tag> to use the new javascript video player.
** mv_embed player includes: play-head, volume control, remote embedding, oggz-chop support across plugins.
* add-media-wizard adds easy inserts of media to pages (with import)
== jQuery==
* we include a base install of jQuery, jQuery ui and some plugins.
* all the javascript classes are in the scriptloader so its easy to load any set of jquery ui components that you may need using the script-server. You get a callback so you can then execute js with dependencies loaded.
== other stuff ==
there is a bit more code in js2 that pertains to sequence editing, timed text display and basic image editing. We include a base import of pixastic-lib & pixastic-editor... will work with the pixastic developer to try and ensure upstream compatibility on our usage of the library for in-browser photo and sequence manipulation.
2009-07-14 23:52:14 +00:00
|
|
|
|
2009-07-26 16:57:45 +00:00
|
|
|
/**
|
2009-08-07 00:16:54 +00:00
|
|
|
* Register and add a stylesheet from an extension directory.
|
2010-01-28 21:58:50 +00:00
|
|
|
*
|
2015-10-31 15:16:58 +00:00
|
|
|
* @deprecated since 1.27 use addModuleStyles() or addStyle() instead
|
2014-07-24 17:42:24 +00:00
|
|
|
* @param string $url Path to sheet. Provide either a full url (beginning
|
2009-07-26 16:57:45 +00:00
|
|
|
* 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 ) {
|
2015-10-31 15:16:58 +00:00
|
|
|
wfDeprecated( __METHOD__, '1.27' );
|
2009-08-11 00:09:24 +00:00
|
|
|
array_push( $this->mExtStyles, $url );
|
2008-08-10 07:14:08 +00:00
|
|
|
}
|
2006-12-08 06:09:15 +00:00
|
|
|
|
2010-01-28 21:58:50 +00:00
|
|
|
/**
|
2011-01-14 07:54:28 +00:00
|
|
|
* Get all styles added by extensions
|
2010-01-28 21:58:50 +00:00
|
|
|
*
|
2015-10-31 15:16:58 +00:00
|
|
|
* @deprecated since 1.27
|
2014-04-10 18:50:10 +00:00
|
|
|
* @return array
|
2010-01-28 21:58:50 +00:00
|
|
|
*/
|
|
|
|
|
function getExtStyle() {
|
2015-10-31 15:16:58 +00:00
|
|
|
wfDeprecated( __METHOD__, '1.27' );
|
2010-01-28 21:58:50 +00:00
|
|
|
return $this->mExtStyles;
|
|
|
|
|
}
|
|
|
|
|
|
2008-05-09 20:18:35 +00:00
|
|
|
/**
|
|
|
|
|
* Add a JavaScript file out of skins/common, or a given relative path.
|
2015-10-31 15:16:58 +00:00
|
|
|
* Internal use only. Use OutputPage::addModules() if possible.
|
2010-01-28 21:58:50 +00:00
|
|
|
*
|
2014-07-24 17:42:24 +00:00
|
|
|
* @param string $file Filename in skins/common or complete on-server path
|
2010-01-28 21:58:50 +00:00
|
|
|
* (/foo/bar.js)
|
2014-07-24 17:42:24 +00:00
|
|
|
* @param string $version Style version of the file. Defaults to $wgStyleVersion
|
2008-05-09 20:18:35 +00:00
|
|
|
*/
|
2010-06-04 19:13:16 +00:00
|
|
|
public function addScriptFile( $file, $version = null ) {
|
2010-08-20 01:47:52 +00:00
|
|
|
// See if $file parameter is an absolute URL or begins with a slash
|
2013-04-17 14:52:47 +00:00
|
|
|
if ( substr( $file, 0, 1 ) == '/' || preg_match( '#^[a-z]*://#i', $file ) ) {
|
2008-05-09 20:18:35 +00:00
|
|
|
$path = $file;
|
|
|
|
|
} else {
|
2014-08-23 08:52:41 +00:00
|
|
|
$path = $this->getConfig()->get( 'StylePath' ) . "/common/{$file}";
|
here it is ... the upload-api, script-server, js2 (javascript phase2) branch merge 1st attempt.
Here is a short overview of changes and associated default configuration variables (most everything is off by default) also see ~soon to be updated~: http://www.mediawiki.org/wiki/Media_Projects_Overview
= Upload Improvements =
==Upload API ==
* Based on the early work of Bryan Tong and others it adds the upload option to the api.
* We rewrite Special:Upload page to include use the new refactoring
* Added in token checks in both the SpecialUpload.php page so avoids DOS / xss copy-by-url JavaScript based cross site POST file submissions
== Copy by URL==
$wgAllowCopyUploads = false;
* http class rewrite includes a new http background download see: includes/HttpFunctions.php
* spins off a php process that calls: maintenance/http_session_download.php
* pushes updates to the session and gives the user a progress bar on http copy uploads from other server progress (using js2 upload interface) (if not using the js2 upload interface it does the request in-place but the download is limited to the php ini timeout time)
== Firefogg ==
* Firefogg enables resumable upload by chunks
* progress indicators and conditional invokation (js2 system)
* and of-course client side transcoding.
= Script Server =
$wgEnableScriptLoader = false;
* off by default if $wgEnableScriptLoader is turned on script files are grouped, gziped, cached etc.
for more info see: http://www.mediawiki.org/wiki/Extension:ScriptLoader
* Includes some early skin js include fixes (skin/script system still lots of love)
* Includes a "javascript class autoloader" this is packaged into mwEmbed so that the mwEmbed library can work in stand alone mode (while retaining localization and script serving) (one such application is the make page for firefogg.org : http://www.firefogg.org/make/index.html )
* The file that contains the autojavascript loading classes is: js2/php/jsAutoloadLocalClasses.php
* One can use this auto class loading dependency system with extensions and add-ons but I need to better document that.
= js2 system / mwEmbed=
$wgEnableJS2system = false
* includes initial rewrite towards more jquery based javascript code
* especially for the Special:Upload page.
* Also the edit page include support for the "add-media-wizard"
* includes dependency loader for javascript that optionally takes advantage of the script-loader
* remote embedding of javascript interfaces (like embedding video, or commons media searching)
* $wgDebugJavaScript = false; .. .this variable lets you always get "always fresh javascript". When used with the script-loader it does not minify the script-loader output.
= mwEmbed =
* Will commit a separate patch to oggHandler that conditionally outputs <video tag> to use the new javascript video player.
** mv_embed player includes: play-head, volume control, remote embedding, oggz-chop support across plugins.
* add-media-wizard adds easy inserts of media to pages (with import)
== jQuery==
* we include a base install of jQuery, jQuery ui and some plugins.
* all the javascript classes are in the scriptloader so its easy to load any set of jquery ui components that you may need using the script-server. You get a callback so you can then execute js with dependencies loaded.
== other stuff ==
there is a bit more code in js2 that pertains to sequence editing, timed text display and basic image editing. We include a base import of pixastic-lib & pixastic-editor... will work with the pixastic developer to try and ensure upstream compatibility on our usage of the library for in-browser photo and sequence manipulation.
2009-07-14 23:52:14 +00:00
|
|
|
}
|
2013-04-17 14:52:47 +00:00
|
|
|
if ( is_null( $version ) ) {
|
2014-08-23 08:52:41 +00:00
|
|
|
$version = $this->getConfig()->get( 'StyleVersion' );
|
2013-04-17 14:52:47 +00:00
|
|
|
}
|
2010-06-04 19:13:16 +00:00
|
|
|
$this->addScript( Html::linkedScript( wfAppendQuery( $path, $version ) ) );
|
2008-05-09 20:18:35 +00:00
|
|
|
}
|
2009-07-15 00:55:58 +00:00
|
|
|
|
2006-12-08 06:09:15 +00:00
|
|
|
/**
|
|
|
|
|
* Add a self-contained script tag with the given contents
|
2015-10-31 15:16:58 +00:00
|
|
|
* Internal use only. Use OutputPage::addModules() if possible.
|
2010-01-28 21:58:50 +00:00
|
|
|
*
|
resourceloader: Move queue formatting out of OutputPage
HTML formatting of the queue was distributed over several OutputPage methods.
Each method demanding a snippet of HTML by calling makeResourceLoaderLink()
with a limited amount of information. As such, makeResourceLoaderLink() was
unable to provide the client with the proper state information.
Centralising it also allows it to better reduce duplication in HTML output
and maintain a more accurate state.
Problems fixed by centralising:
1. The 'user' module is special (due to per-user 'version' and 'user' params).
It is manually requested via script-src. To avoid a separate (and wrong)
request from something that requires it, we set state=loading directly.
However, because the module is in the bottom, the old HTML formatter could
only put state=loading in the bottom also. This sometimes caused a wrong
request to be fired for modules=user if something in the top queue
triggered a requirement for it.
2. Since a464d1d4 (T87871) we track states of page-style modules, with purpose
of allowing dependencies on style modules without risking duplicate loading
on pages where the styles are loaded already. This didn't work, because the
state information about page-style modules is output near the stylesheet,
which is after the script tag with mw.loader.load(). That runs first, and
mw.loader would still make a duplicate request before it learns the state.
Changes:
* Document reasons for style/script tag order in getHeadHtml (per 09537e83).
* Pass $type from getModuleStyles() to getAllowedModules(). This wasn't needed
before since a duplicate check in makeResourceLoaderLink() verified the
origin a second time.
* Declare explicit position 'top' on 'user.options' and 'user.tokens' module.
Previously, OutputPage hardcoded them in the top. The new formatter doesn't.
* Remove getHeadScripts().
* Remove getInlineHeadScripts().
* Remove getExternalHeadScripts().
* Remove buildCssLinks().
* Remove getScriptsForBottomQueue().
* Change where Skin::setupSkinUserCss() is called. This methods lets the skin
add modules to the queue. Previously it was called from buildCssLinks(),
via headElement(), via prepareQuickTemplate(), via OutputPage::output().
It's now in OutputPage::output() directly (slightly earlier). This is needed
because prepareQuickTemplate() calls bottomScripts() before headElement().
And bottomScript() would lazy-initialise the queue and lock it before
setupSkinUserCss() is called from headElement().
This makes execution order more predictable instead of being dependent on
the arbitrary order of data extraction in prepareQuickTemplate (which varies
from one skin to another).
* Compute isUserModulePreview() and isKnownEmpty() for the 'user' module early
on so. This avoids wrongful loading and fixes problem 1.
Effective changes in output:
* mw.loader.state() is now before mw.loader.load(). This fixes problem 2.
* mw.loader.state() now sets 'user.options' and 'user.tokens' to "loading".
* mw.loader.state() now sets 'user' (as "loading" or "ready"). Fixes problem 1.
* The <script async src> tag for 'startup' changed position (slightly).
Previously it was after all inline scripts and stylesheets. It's still after
all inline scripts and after most stylesheets, but before any user styles.
Since the queue is now formatted outside OutputPage, it can't inject the
meta-ResourceLoaderDynamicStyles tag and user-stylesheet hack in the middle
of existing output. This shouldn't have any noticable impact.
Bug: T87871
Change-Id: I605b8cd1e1fc009b4662a0edbc54d09dd65ee1df
2016-07-15 14:13:09 +00:00
|
|
|
* @param string $script JavaScript text, no script tags
|
2006-12-08 06:09:15 +00:00
|
|
|
*/
|
2010-01-28 21:58:50 +00:00
|
|
|
public function addInlineScript( $script ) {
|
2016-02-18 16:33:15 +00:00
|
|
|
$this->mScripts .= Html::inlineScript( $script );
|
2006-12-08 06:09:15 +00:00
|
|
|
}
|
|
|
|
|
|
2011-02-04 16:39:17 +00:00
|
|
|
/**
|
2011-03-19 21:19:50 +00:00
|
|
|
* Filter an array of modules to remove insufficiently trustworthy members, and modules
|
|
|
|
|
* which are no longer registered (eg a page is cached before an extension is disabled)
|
2014-04-10 18:50:10 +00:00
|
|
|
* @param array $modules
|
2014-07-24 17:42:24 +00:00
|
|
|
* @param string|null $position If not null, only return modules with this position
|
2014-04-10 18:50:10 +00:00
|
|
|
* @param string $type
|
|
|
|
|
* @return array
|
2011-02-04 16:39:17 +00:00
|
|
|
*/
|
2014-07-23 02:49:30 +00:00
|
|
|
protected function filterModules( array $modules, $position = null,
|
2014-05-11 01:54:15 +00:00
|
|
|
$type = ResourceLoaderModule::TYPE_COMBINED
|
|
|
|
|
) {
|
2011-02-04 16:39:17 +00:00
|
|
|
$resourceLoader = $this->getResourceLoader();
|
2016-02-17 09:09:32 +00:00
|
|
|
$filteredModules = [];
|
2013-04-17 14:52:47 +00:00
|
|
|
foreach ( $modules as $val ) {
|
2011-02-04 16:39:17 +00:00
|
|
|
$module = $resourceLoader->getModule( $val );
|
2013-04-17 14:52:47 +00:00
|
|
|
if ( $module instanceof ResourceLoaderModule
|
2011-04-07 12:07:25 +00:00
|
|
|
&& $module->getOrigin() <= $this->getAllowedModules( $type )
|
2013-02-14 17:05:22 +00:00
|
|
|
&& ( is_null( $position ) || $module->getPosition() == $position )
|
2013-12-01 20:39:00 +00:00
|
|
|
) {
|
2017-02-15 00:25:39 +00:00
|
|
|
if ( $this->mTarget && !in_array( $this->mTarget, $module->getTargets() ) ) {
|
|
|
|
|
$this->warnModuleTargetFilter( $module->getName() );
|
|
|
|
|
continue;
|
|
|
|
|
}
|
2011-02-04 16:39:17 +00:00
|
|
|
$filteredModules[] = $val;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
return $filteredModules;
|
|
|
|
|
}
|
|
|
|
|
|
2017-02-15 00:25:39 +00:00
|
|
|
private function warnModuleTargetFilter( $moduleName ) {
|
|
|
|
|
static $warnings = [];
|
|
|
|
|
if ( isset( $warnings[$this->mTarget][$moduleName] ) ) {
|
|
|
|
|
return;
|
|
|
|
|
}
|
|
|
|
|
$warnings[$this->mTarget][$moduleName] = true;
|
|
|
|
|
$this->getResourceLoader()->getLogger()->debug(
|
|
|
|
|
'Module "{module}" not loadable on target "{target}".',
|
|
|
|
|
[
|
|
|
|
|
'module' => $moduleName,
|
|
|
|
|
'target' => $this->mTarget,
|
|
|
|
|
]
|
|
|
|
|
);
|
|
|
|
|
}
|
|
|
|
|
|
2010-09-04 04:00:09 +00:00
|
|
|
/**
|
|
|
|
|
* Get the list of modules to include on this page
|
2010-09-07 21:05:09 +00:00
|
|
|
*
|
2014-04-10 18:50:10 +00:00
|
|
|
* @param bool $filter Whether to filter out insufficiently trustworthy modules
|
|
|
|
|
* @param string|null $position If not null, only return modules with this position
|
|
|
|
|
* @param string $param
|
2017-08-11 18:04:11 +00:00
|
|
|
* @param string $type
|
2014-04-10 18:50:10 +00:00
|
|
|
* @return array Array of module names
|
2010-09-04 04:00:09 +00:00
|
|
|
*/
|
resourceloader: Move queue formatting out of OutputPage
HTML formatting of the queue was distributed over several OutputPage methods.
Each method demanding a snippet of HTML by calling makeResourceLoaderLink()
with a limited amount of information. As such, makeResourceLoaderLink() was
unable to provide the client with the proper state information.
Centralising it also allows it to better reduce duplication in HTML output
and maintain a more accurate state.
Problems fixed by centralising:
1. The 'user' module is special (due to per-user 'version' and 'user' params).
It is manually requested via script-src. To avoid a separate (and wrong)
request from something that requires it, we set state=loading directly.
However, because the module is in the bottom, the old HTML formatter could
only put state=loading in the bottom also. This sometimes caused a wrong
request to be fired for modules=user if something in the top queue
triggered a requirement for it.
2. Since a464d1d4 (T87871) we track states of page-style modules, with purpose
of allowing dependencies on style modules without risking duplicate loading
on pages where the styles are loaded already. This didn't work, because the
state information about page-style modules is output near the stylesheet,
which is after the script tag with mw.loader.load(). That runs first, and
mw.loader would still make a duplicate request before it learns the state.
Changes:
* Document reasons for style/script tag order in getHeadHtml (per 09537e83).
* Pass $type from getModuleStyles() to getAllowedModules(). This wasn't needed
before since a duplicate check in makeResourceLoaderLink() verified the
origin a second time.
* Declare explicit position 'top' on 'user.options' and 'user.tokens' module.
Previously, OutputPage hardcoded them in the top. The new formatter doesn't.
* Remove getHeadScripts().
* Remove getInlineHeadScripts().
* Remove getExternalHeadScripts().
* Remove buildCssLinks().
* Remove getScriptsForBottomQueue().
* Change where Skin::setupSkinUserCss() is called. This methods lets the skin
add modules to the queue. Previously it was called from buildCssLinks(),
via headElement(), via prepareQuickTemplate(), via OutputPage::output().
It's now in OutputPage::output() directly (slightly earlier). This is needed
because prepareQuickTemplate() calls bottomScripts() before headElement().
And bottomScript() would lazy-initialise the queue and lock it before
setupSkinUserCss() is called from headElement().
This makes execution order more predictable instead of being dependent on
the arbitrary order of data extraction in prepareQuickTemplate (which varies
from one skin to another).
* Compute isUserModulePreview() and isKnownEmpty() for the 'user' module early
on so. This avoids wrongful loading and fixes problem 1.
Effective changes in output:
* mw.loader.state() is now before mw.loader.load(). This fixes problem 2.
* mw.loader.state() now sets 'user.options' and 'user.tokens' to "loading".
* mw.loader.state() now sets 'user' (as "loading" or "ready"). Fixes problem 1.
* The <script async src> tag for 'startup' changed position (slightly).
Previously it was after all inline scripts and stylesheets. It's still after
all inline scripts and after most stylesheets, but before any user styles.
Since the queue is now formatted outside OutputPage, it can't inject the
meta-ResourceLoaderDynamicStyles tag and user-stylesheet hack in the middle
of existing output. This shouldn't have any noticable impact.
Bug: T87871
Change-Id: I605b8cd1e1fc009b4662a0edbc54d09dd65ee1df
2016-07-15 14:13:09 +00:00
|
|
|
public function getModules( $filter = false, $position = null, $param = 'mModules',
|
|
|
|
|
$type = ResourceLoaderModule::TYPE_COMBINED
|
|
|
|
|
) {
|
2011-02-04 16:39:17 +00:00
|
|
|
$modules = array_values( array_unique( $this->$param ) );
|
|
|
|
|
return $filter
|
resourceloader: Move queue formatting out of OutputPage
HTML formatting of the queue was distributed over several OutputPage methods.
Each method demanding a snippet of HTML by calling makeResourceLoaderLink()
with a limited amount of information. As such, makeResourceLoaderLink() was
unable to provide the client with the proper state information.
Centralising it also allows it to better reduce duplication in HTML output
and maintain a more accurate state.
Problems fixed by centralising:
1. The 'user' module is special (due to per-user 'version' and 'user' params).
It is manually requested via script-src. To avoid a separate (and wrong)
request from something that requires it, we set state=loading directly.
However, because the module is in the bottom, the old HTML formatter could
only put state=loading in the bottom also. This sometimes caused a wrong
request to be fired for modules=user if something in the top queue
triggered a requirement for it.
2. Since a464d1d4 (T87871) we track states of page-style modules, with purpose
of allowing dependencies on style modules without risking duplicate loading
on pages where the styles are loaded already. This didn't work, because the
state information about page-style modules is output near the stylesheet,
which is after the script tag with mw.loader.load(). That runs first, and
mw.loader would still make a duplicate request before it learns the state.
Changes:
* Document reasons for style/script tag order in getHeadHtml (per 09537e83).
* Pass $type from getModuleStyles() to getAllowedModules(). This wasn't needed
before since a duplicate check in makeResourceLoaderLink() verified the
origin a second time.
* Declare explicit position 'top' on 'user.options' and 'user.tokens' module.
Previously, OutputPage hardcoded them in the top. The new formatter doesn't.
* Remove getHeadScripts().
* Remove getInlineHeadScripts().
* Remove getExternalHeadScripts().
* Remove buildCssLinks().
* Remove getScriptsForBottomQueue().
* Change where Skin::setupSkinUserCss() is called. This methods lets the skin
add modules to the queue. Previously it was called from buildCssLinks(),
via headElement(), via prepareQuickTemplate(), via OutputPage::output().
It's now in OutputPage::output() directly (slightly earlier). This is needed
because prepareQuickTemplate() calls bottomScripts() before headElement().
And bottomScript() would lazy-initialise the queue and lock it before
setupSkinUserCss() is called from headElement().
This makes execution order more predictable instead of being dependent on
the arbitrary order of data extraction in prepareQuickTemplate (which varies
from one skin to another).
* Compute isUserModulePreview() and isKnownEmpty() for the 'user' module early
on so. This avoids wrongful loading and fixes problem 1.
Effective changes in output:
* mw.loader.state() is now before mw.loader.load(). This fixes problem 2.
* mw.loader.state() now sets 'user.options' and 'user.tokens' to "loading".
* mw.loader.state() now sets 'user' (as "loading" or "ready"). Fixes problem 1.
* The <script async src> tag for 'startup' changed position (slightly).
Previously it was after all inline scripts and stylesheets. It's still after
all inline scripts and after most stylesheets, but before any user styles.
Since the queue is now formatted outside OutputPage, it can't inject the
meta-ResourceLoaderDynamicStyles tag and user-stylesheet hack in the middle
of existing output. This shouldn't have any noticable impact.
Bug: T87871
Change-Id: I605b8cd1e1fc009b4662a0edbc54d09dd65ee1df
2016-07-15 14:13:09 +00:00
|
|
|
? $this->filterModules( $modules, $position, $type )
|
2011-02-04 16:39:17 +00:00
|
|
|
: $modules;
|
2010-09-04 04:00:09 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
2015-10-28 03:24:40 +00:00
|
|
|
* Add one or more modules recognized by ResourceLoader. Modules added
|
|
|
|
|
* through this function will be loaded by ResourceLoader when the
|
2010-09-04 04:00:09 +00:00
|
|
|
* page loads.
|
2010-09-07 21:05:09 +00:00
|
|
|
*
|
2014-04-08 15:29:17 +00:00
|
|
|
* @param string|array $modules Module name (string) or array of module names
|
2010-09-04 04:00:09 +00:00
|
|
|
*/
|
|
|
|
|
public function addModules( $modules ) {
|
|
|
|
|
$this->mModules = array_merge( $this->mModules, (array)$modules );
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Get the list of module JS to include on this page
|
2011-05-21 19:07:24 +00:00
|
|
|
*
|
2014-04-10 18:50:10 +00:00
|
|
|
* @param bool $filter
|
|
|
|
|
* @param string|null $position
|
|
|
|
|
* @return array Array of module names
|
2010-09-04 04:00:09 +00:00
|
|
|
*/
|
2011-04-07 12:07:25 +00:00
|
|
|
public function getModuleScripts( $filter = false, $position = null ) {
|
resourceloader: Move queue formatting out of OutputPage
HTML formatting of the queue was distributed over several OutputPage methods.
Each method demanding a snippet of HTML by calling makeResourceLoaderLink()
with a limited amount of information. As such, makeResourceLoaderLink() was
unable to provide the client with the proper state information.
Centralising it also allows it to better reduce duplication in HTML output
and maintain a more accurate state.
Problems fixed by centralising:
1. The 'user' module is special (due to per-user 'version' and 'user' params).
It is manually requested via script-src. To avoid a separate (and wrong)
request from something that requires it, we set state=loading directly.
However, because the module is in the bottom, the old HTML formatter could
only put state=loading in the bottom also. This sometimes caused a wrong
request to be fired for modules=user if something in the top queue
triggered a requirement for it.
2. Since a464d1d4 (T87871) we track states of page-style modules, with purpose
of allowing dependencies on style modules without risking duplicate loading
on pages where the styles are loaded already. This didn't work, because the
state information about page-style modules is output near the stylesheet,
which is after the script tag with mw.loader.load(). That runs first, and
mw.loader would still make a duplicate request before it learns the state.
Changes:
* Document reasons for style/script tag order in getHeadHtml (per 09537e83).
* Pass $type from getModuleStyles() to getAllowedModules(). This wasn't needed
before since a duplicate check in makeResourceLoaderLink() verified the
origin a second time.
* Declare explicit position 'top' on 'user.options' and 'user.tokens' module.
Previously, OutputPage hardcoded them in the top. The new formatter doesn't.
* Remove getHeadScripts().
* Remove getInlineHeadScripts().
* Remove getExternalHeadScripts().
* Remove buildCssLinks().
* Remove getScriptsForBottomQueue().
* Change where Skin::setupSkinUserCss() is called. This methods lets the skin
add modules to the queue. Previously it was called from buildCssLinks(),
via headElement(), via prepareQuickTemplate(), via OutputPage::output().
It's now in OutputPage::output() directly (slightly earlier). This is needed
because prepareQuickTemplate() calls bottomScripts() before headElement().
And bottomScript() would lazy-initialise the queue and lock it before
setupSkinUserCss() is called from headElement().
This makes execution order more predictable instead of being dependent on
the arbitrary order of data extraction in prepareQuickTemplate (which varies
from one skin to another).
* Compute isUserModulePreview() and isKnownEmpty() for the 'user' module early
on so. This avoids wrongful loading and fixes problem 1.
Effective changes in output:
* mw.loader.state() is now before mw.loader.load(). This fixes problem 2.
* mw.loader.state() now sets 'user.options' and 'user.tokens' to "loading".
* mw.loader.state() now sets 'user' (as "loading" or "ready"). Fixes problem 1.
* The <script async src> tag for 'startup' changed position (slightly).
Previously it was after all inline scripts and stylesheets. It's still after
all inline scripts and after most stylesheets, but before any user styles.
Since the queue is now formatted outside OutputPage, it can't inject the
meta-ResourceLoaderDynamicStyles tag and user-stylesheet hack in the middle
of existing output. This shouldn't have any noticable impact.
Bug: T87871
Change-Id: I605b8cd1e1fc009b4662a0edbc54d09dd65ee1df
2016-07-15 14:13:09 +00:00
|
|
|
return $this->getModules( $filter, $position, 'mModuleScripts',
|
|
|
|
|
ResourceLoaderModule::TYPE_SCRIPTS
|
|
|
|
|
);
|
2010-09-04 04:00:09 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
2015-10-28 03:24:40 +00:00
|
|
|
* Add only JS of one or more modules recognized by ResourceLoader. Module
|
|
|
|
|
* scripts added through this function will be loaded by ResourceLoader when
|
2010-09-04 04:00:09 +00:00
|
|
|
* the page loads.
|
2010-09-07 21:05:09 +00:00
|
|
|
*
|
2014-04-08 15:29:17 +00:00
|
|
|
* @param string|array $modules Module name (string) or array of module names
|
2010-09-04 04:00:09 +00:00
|
|
|
*/
|
|
|
|
|
public function addModuleScripts( $modules ) {
|
|
|
|
|
$this->mModuleScripts = array_merge( $this->mModuleScripts, (array)$modules );
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Get the list of module CSS to include on this page
|
2010-09-07 21:05:09 +00:00
|
|
|
*
|
2014-04-10 18:50:10 +00:00
|
|
|
* @param bool $filter
|
|
|
|
|
* @param string|null $position
|
|
|
|
|
* @return array Array of module names
|
2010-09-04 04:00:09 +00:00
|
|
|
*/
|
2011-04-07 12:07:25 +00:00
|
|
|
public function getModuleStyles( $filter = false, $position = null ) {
|
resourceloader: Move queue formatting out of OutputPage
HTML formatting of the queue was distributed over several OutputPage methods.
Each method demanding a snippet of HTML by calling makeResourceLoaderLink()
with a limited amount of information. As such, makeResourceLoaderLink() was
unable to provide the client with the proper state information.
Centralising it also allows it to better reduce duplication in HTML output
and maintain a more accurate state.
Problems fixed by centralising:
1. The 'user' module is special (due to per-user 'version' and 'user' params).
It is manually requested via script-src. To avoid a separate (and wrong)
request from something that requires it, we set state=loading directly.
However, because the module is in the bottom, the old HTML formatter could
only put state=loading in the bottom also. This sometimes caused a wrong
request to be fired for modules=user if something in the top queue
triggered a requirement for it.
2. Since a464d1d4 (T87871) we track states of page-style modules, with purpose
of allowing dependencies on style modules without risking duplicate loading
on pages where the styles are loaded already. This didn't work, because the
state information about page-style modules is output near the stylesheet,
which is after the script tag with mw.loader.load(). That runs first, and
mw.loader would still make a duplicate request before it learns the state.
Changes:
* Document reasons for style/script tag order in getHeadHtml (per 09537e83).
* Pass $type from getModuleStyles() to getAllowedModules(). This wasn't needed
before since a duplicate check in makeResourceLoaderLink() verified the
origin a second time.
* Declare explicit position 'top' on 'user.options' and 'user.tokens' module.
Previously, OutputPage hardcoded them in the top. The new formatter doesn't.
* Remove getHeadScripts().
* Remove getInlineHeadScripts().
* Remove getExternalHeadScripts().
* Remove buildCssLinks().
* Remove getScriptsForBottomQueue().
* Change where Skin::setupSkinUserCss() is called. This methods lets the skin
add modules to the queue. Previously it was called from buildCssLinks(),
via headElement(), via prepareQuickTemplate(), via OutputPage::output().
It's now in OutputPage::output() directly (slightly earlier). This is needed
because prepareQuickTemplate() calls bottomScripts() before headElement().
And bottomScript() would lazy-initialise the queue and lock it before
setupSkinUserCss() is called from headElement().
This makes execution order more predictable instead of being dependent on
the arbitrary order of data extraction in prepareQuickTemplate (which varies
from one skin to another).
* Compute isUserModulePreview() and isKnownEmpty() for the 'user' module early
on so. This avoids wrongful loading and fixes problem 1.
Effective changes in output:
* mw.loader.state() is now before mw.loader.load(). This fixes problem 2.
* mw.loader.state() now sets 'user.options' and 'user.tokens' to "loading".
* mw.loader.state() now sets 'user' (as "loading" or "ready"). Fixes problem 1.
* The <script async src> tag for 'startup' changed position (slightly).
Previously it was after all inline scripts and stylesheets. It's still after
all inline scripts and after most stylesheets, but before any user styles.
Since the queue is now formatted outside OutputPage, it can't inject the
meta-ResourceLoaderDynamicStyles tag and user-stylesheet hack in the middle
of existing output. This shouldn't have any noticable impact.
Bug: T87871
Change-Id: I605b8cd1e1fc009b4662a0edbc54d09dd65ee1df
2016-07-15 14:13:09 +00:00
|
|
|
return $this->getModules( $filter, $position, 'mModuleStyles',
|
|
|
|
|
ResourceLoaderModule::TYPE_STYLES
|
|
|
|
|
);
|
2010-09-04 04:00:09 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
2015-10-28 03:24:40 +00:00
|
|
|
* Add only CSS of one or more modules recognized by ResourceLoader.
|
2013-02-27 06:09:26 +00:00
|
|
|
*
|
|
|
|
|
* Module styles added through this function will be added using standard link CSS
|
|
|
|
|
* tags, rather than as a combined Javascript and CSS package. Thus, they will
|
|
|
|
|
* load when JavaScript is disabled (unless CSS also happens to be disabled).
|
2010-09-07 21:05:09 +00:00
|
|
|
*
|
2014-04-08 15:29:17 +00:00
|
|
|
* @param string|array $modules Module name (string) or array of module names
|
2010-09-04 04:00:09 +00:00
|
|
|
*/
|
|
|
|
|
public function addModuleStyles( $modules ) {
|
|
|
|
|
$this->mModuleStyles = array_merge( $this->mModuleStyles, (array)$modules );
|
|
|
|
|
}
|
|
|
|
|
|
2013-02-14 17:05:22 +00:00
|
|
|
/**
|
2014-04-08 15:29:17 +00:00
|
|
|
* @return null|string ResourceLoader target
|
2013-02-14 17:05:22 +00:00
|
|
|
*/
|
|
|
|
|
public function getTarget() {
|
|
|
|
|
return $this->mTarget;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Sets ResourceLoader target for load.php links. If null, will be omitted
|
|
|
|
|
*
|
2014-04-10 18:50:10 +00:00
|
|
|
* @param string|null $target
|
2013-02-14 17:05:22 +00:00
|
|
|
*/
|
|
|
|
|
public function setTarget( $target ) {
|
|
|
|
|
$this->mTarget = $target;
|
|
|
|
|
}
|
|
|
|
|
|
2011-08-02 15:40:03 +00:00
|
|
|
/**
|
|
|
|
|
* Get an array of head items
|
|
|
|
|
*
|
2014-04-10 18:50:10 +00:00
|
|
|
* @return array
|
2011-08-02 15:40:03 +00:00
|
|
|
*/
|
|
|
|
|
function getHeadItemsArray() {
|
|
|
|
|
return $this->mHeadItems;
|
|
|
|
|
}
|
|
|
|
|
|
2010-01-28 21:58:50 +00:00
|
|
|
/**
|
2016-07-25 23:54:13 +00:00
|
|
|
* Add or replace a head item to the output
|
2010-01-28 21:58:50 +00:00
|
|
|
*
|
2015-10-31 15:16:58 +00:00
|
|
|
* Whenever possible, use more specific options like ResourceLoader modules,
|
|
|
|
|
* OutputPage::addLink(), OutputPage::addMetaLink() and OutputPage::addFeedLink()
|
|
|
|
|
* Fallback options for those are: OutputPage::addStyle, OutputPage::addScript(),
|
|
|
|
|
* OutputPage::addInlineScript() and OutputPage::addInlineStyle()
|
|
|
|
|
* This would be your very LAST fallback.
|
|
|
|
|
*
|
2014-07-24 17:42:24 +00:00
|
|
|
* @param string $name Item name
|
|
|
|
|
* @param string $value Raw HTML
|
2010-01-28 21:58:50 +00:00
|
|
|
*/
|
|
|
|
|
public function addHeadItem( $name, $value ) {
|
2007-04-29 10:15:05 +00:00
|
|
|
$this->mHeadItems[$name] = $value;
|
|
|
|
|
}
|
2004-07-08 14:53:54 +00:00
|
|
|
|
2016-07-25 23:54:13 +00:00
|
|
|
/**
|
|
|
|
|
* Add one or more head items to the output
|
|
|
|
|
*
|
|
|
|
|
* @since 1.28
|
2017-08-11 16:09:41 +00:00
|
|
|
* @param string|string[] $values Raw HTML
|
2016-07-25 23:54:13 +00:00
|
|
|
*/
|
|
|
|
|
public function addHeadItems( $values ) {
|
|
|
|
|
$this->mHeadItems = array_merge( $this->mHeadItems, (array)$values );
|
|
|
|
|
}
|
|
|
|
|
|
2010-01-28 21:58:50 +00:00
|
|
|
/**
|
|
|
|
|
* Check if the header item $name is already set
|
|
|
|
|
*
|
2014-04-10 18:50:10 +00:00
|
|
|
* @param string $name Item name
|
|
|
|
|
* @return bool
|
2010-01-28 21:58:50 +00:00
|
|
|
*/
|
|
|
|
|
public function hasHeadItem( $name ) {
|
Basic integrated audio/video support, with Ogg implementation.
* JavaScript video player based loosely on Greg Maxwell's player
* Image page text snippet customisation
* Abstraction of transform parameters in the parser. Introduced Linker::makeImageLink2().
* Made canRender(), mustRender() depend on file, not just on handler. Moved width=0, height=0 checking to ImageHandler::canRender(), since audio streams have width=height=0 but should be rendered.
Also:
* Automatic upgrade for oldimage rows on image page view, allows media handler selection based on oi_*_mime
* oi_*_mime unconditionally referenced, REQUIRES SCHEMA UPGRADE
* Don't destroy file info for missing files on upgrade
* Simple, centralised extension message file handling
* Made MessageCache::loadAllMessages non-static, optimised for repeated-call case due to abuse in User.php
* Support for lightweight parser output hooks, with callback whitelist for security
* Moved Linker::formatSize() to Language, to join the new formatTimePeriod() and formatBitrate()
* Introduced MagicWordArray, regex capture trick requires that magic word IDs DO NOT CONTAIN HYPHENS.
2007-08-15 10:50:09 +00:00
|
|
|
return isset( $this->mHeadItems[$name] );
|
|
|
|
|
}
|
|
|
|
|
|
2017-09-11 07:12:03 +00:00
|
|
|
/**
|
|
|
|
|
* Add a class to the <body> element
|
|
|
|
|
*
|
|
|
|
|
* @since 1.30
|
|
|
|
|
* @param string|string[] $classes One or more classes to add
|
|
|
|
|
*/
|
|
|
|
|
public function addBodyClasses( $classes ) {
|
|
|
|
|
$this->mAdditionalBodyClasses = array_merge( $this->mAdditionalBodyClasses, (array)$classes );
|
|
|
|
|
}
|
|
|
|
|
|
2010-01-28 21:58:50 +00:00
|
|
|
/**
|
2016-06-27 11:21:14 +00:00
|
|
|
* @deprecated since 1.28 Obsolete - wgUseETag experiment was removed.
|
|
|
|
|
* @param string $tag
|
2010-01-28 21:58:50 +00:00
|
|
|
*/
|
2016-06-27 11:21:14 +00:00
|
|
|
public function setETag( $tag ) {
|
2004-04-10 11:19:33 +00:00
|
|
|
}
|
here it is ... the upload-api, script-server, js2 (javascript phase2) branch merge 1st attempt.
Here is a short overview of changes and associated default configuration variables (most everything is off by default) also see ~soon to be updated~: http://www.mediawiki.org/wiki/Media_Projects_Overview
= Upload Improvements =
==Upload API ==
* Based on the early work of Bryan Tong and others it adds the upload option to the api.
* We rewrite Special:Upload page to include use the new refactoring
* Added in token checks in both the SpecialUpload.php page so avoids DOS / xss copy-by-url JavaScript based cross site POST file submissions
== Copy by URL==
$wgAllowCopyUploads = false;
* http class rewrite includes a new http background download see: includes/HttpFunctions.php
* spins off a php process that calls: maintenance/http_session_download.php
* pushes updates to the session and gives the user a progress bar on http copy uploads from other server progress (using js2 upload interface) (if not using the js2 upload interface it does the request in-place but the download is limited to the php ini timeout time)
== Firefogg ==
* Firefogg enables resumable upload by chunks
* progress indicators and conditional invokation (js2 system)
* and of-course client side transcoding.
= Script Server =
$wgEnableScriptLoader = false;
* off by default if $wgEnableScriptLoader is turned on script files are grouped, gziped, cached etc.
for more info see: http://www.mediawiki.org/wiki/Extension:ScriptLoader
* Includes some early skin js include fixes (skin/script system still lots of love)
* Includes a "javascript class autoloader" this is packaged into mwEmbed so that the mwEmbed library can work in stand alone mode (while retaining localization and script serving) (one such application is the make page for firefogg.org : http://www.firefogg.org/make/index.html )
* The file that contains the autojavascript loading classes is: js2/php/jsAutoloadLocalClasses.php
* One can use this auto class loading dependency system with extensions and add-ons but I need to better document that.
= js2 system / mwEmbed=
$wgEnableJS2system = false
* includes initial rewrite towards more jquery based javascript code
* especially for the Special:Upload page.
* Also the edit page include support for the "add-media-wizard"
* includes dependency loader for javascript that optionally takes advantage of the script-loader
* remote embedding of javascript interfaces (like embedding video, or commons media searching)
* $wgDebugJavaScript = false; .. .this variable lets you always get "always fresh javascript". When used with the script-loader it does not minify the script-loader output.
= mwEmbed =
* Will commit a separate patch to oggHandler that conditionally outputs <video tag> to use the new javascript video player.
** mv_embed player includes: play-head, volume control, remote embedding, oggz-chop support across plugins.
* add-media-wizard adds easy inserts of media to pages (with import)
== jQuery==
* we include a base install of jQuery, jQuery ui and some plugins.
* all the javascript classes are in the scriptloader so its easy to load any set of jquery ui components that you may need using the script-server. You get a callback so you can then execute js with dependencies loaded.
== other stuff ==
there is a bit more code in js2 that pertains to sequence editing, timed text display and basic image editing. We include a base import of pixastic-lib & pixastic-editor... will work with the pixastic developer to try and ensure upstream compatibility on our usage of the library for in-browser photo and sequence manipulation.
2009-07-14 23:52:14 +00:00
|
|
|
|
2010-01-28 21:58:50 +00:00
|
|
|
/**
|
|
|
|
|
* Set whether the output should only contain the body of the article,
|
|
|
|
|
* without any skin, sidebar, etc.
|
2010-02-01 18:04:17 +00:00
|
|
|
* Used e.g. when calling with "action=render".
|
2010-01-28 21:58:50 +00:00
|
|
|
*
|
2014-04-08 15:29:17 +00:00
|
|
|
* @param bool $only Whether to output only the body of the article
|
2010-01-28 21:58:50 +00:00
|
|
|
*/
|
|
|
|
|
public function setArticleBodyOnly( $only ) {
|
|
|
|
|
$this->mArticleBodyOnly = $only;
|
2008-08-10 07:14:08 +00:00
|
|
|
}
|
2003-04-14 23:10:40 +00:00
|
|
|
|
2010-01-28 21:58:50 +00:00
|
|
|
/**
|
|
|
|
|
* Return whether the output will contain only the body of the article
|
|
|
|
|
*
|
2014-04-10 18:50:10 +00:00
|
|
|
* @return bool
|
2010-01-28 21:58:50 +00:00
|
|
|
*/
|
|
|
|
|
public function getArticleBodyOnly() {
|
|
|
|
|
return $this->mArticleBodyOnly;
|
2004-04-04 22:33:11 +00:00
|
|
|
}
|
2004-04-04 21:58:05 +00:00
|
|
|
|
2013-02-08 22:58:38 +00:00
|
|
|
/**
|
|
|
|
|
* Set an additional output property
|
|
|
|
|
* @since 1.21
|
|
|
|
|
*
|
|
|
|
|
* @param string $name
|
|
|
|
|
* @param mixed $value
|
|
|
|
|
*/
|
|
|
|
|
public function setProperty( $name, $value ) {
|
|
|
|
|
$this->mProperties[$name] = $value;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Get an additional output property
|
|
|
|
|
* @since 1.21
|
|
|
|
|
*
|
2014-04-08 15:29:17 +00:00
|
|
|
* @param string $name
|
|
|
|
|
* @return mixed Property value or null if not found
|
2013-02-08 22:58:38 +00:00
|
|
|
*/
|
|
|
|
|
public function getProperty( $name ) {
|
|
|
|
|
if ( isset( $this->mProperties[$name] ) ) {
|
|
|
|
|
return $this->mProperties[$name];
|
|
|
|
|
} else {
|
|
|
|
|
return null;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2004-09-02 23:28:24 +00:00
|
|
|
/**
|
|
|
|
|
* checkLastModified tells the client to use the client-cached page if
|
2012-12-01 16:02:15 +00:00
|
|
|
* possible. If successful, the OutputPage is disabled so that
|
2006-11-07 05:37:31 +00:00
|
|
|
* any future call to OutputPage->output() have no effect.
|
|
|
|
|
*
|
2008-08-29 08:40:13 +00:00
|
|
|
* Side effect: sets mLastModified for Last-Modified header
|
|
|
|
|
*
|
2014-04-08 15:29:17 +00:00
|
|
|
* @param string $timestamp
|
2011-05-21 19:07:24 +00:00
|
|
|
*
|
2014-04-08 15:29:17 +00:00
|
|
|
* @return bool True if cache-ok headers was sent.
|
2004-09-02 23:28:24 +00:00
|
|
|
*/
|
2010-01-28 21:58:50 +00:00
|
|
|
public function checkLastModified( $timestamp ) {
|
2005-03-20 03:59:06 +00:00
|
|
|
if ( !$timestamp || $timestamp == '19700101000000' ) {
|
2008-04-16 13:46:16 +00:00
|
|
|
wfDebug( __METHOD__ . ": CACHE DISABLED, NO TIMESTAMP\n" );
|
2008-08-29 08:40:13 +00:00
|
|
|
return false;
|
2005-03-20 03:59:06 +00:00
|
|
|
}
|
2014-08-23 08:52:41 +00:00
|
|
|
$config = $this->getConfig();
|
|
|
|
|
if ( !$config->get( 'CachePages' ) ) {
|
2014-02-06 19:19:09 +00:00
|
|
|
wfDebug( __METHOD__ . ": CACHE DISABLED\n" );
|
2008-08-29 08:40:13 +00:00
|
|
|
return false;
|
2003-07-10 04:55:41 +00:00
|
|
|
}
|
2004-03-20 15:03:26 +00:00
|
|
|
|
2008-08-29 08:40:13 +00:00
|
|
|
$timestamp = wfTimestamp( TS_MW, $timestamp );
|
2016-02-17 09:09:32 +00:00
|
|
|
$modifiedTimes = [
|
2013-04-17 14:52:47 +00:00
|
|
|
'page' => $timestamp,
|
|
|
|
|
'user' => $this->getUser()->getTouched(),
|
2014-08-23 08:52:41 +00:00
|
|
|
'epoch' => $config->get( 'CacheEpoch' )
|
2016-02-17 09:09:32 +00:00
|
|
|
];
|
2014-08-23 08:52:41 +00:00
|
|
|
if ( $config->get( 'UseSquid' ) ) {
|
2017-02-20 22:44:19 +00:00
|
|
|
// T46570: the core page itself may not change, but resources might
|
2014-08-23 08:52:41 +00:00
|
|
|
$modifiedTimes['sepoch'] = wfTimestamp( TS_MW, time() - $config->get( 'SquidMaxage' ) );
|
2013-04-09 20:55:36 +00:00
|
|
|
}
|
2016-05-11 00:13:47 +00:00
|
|
|
Hooks::run( 'OutputPageCheckLastModified', [ &$modifiedTimes, $this ] );
|
2008-04-14 07:45:50 +00:00
|
|
|
|
2008-08-29 08:40:13 +00:00
|
|
|
$maxModified = max( $modifiedTimes );
|
|
|
|
|
$this->mLastModified = wfTimestamp( TS_RFC2822, $maxModified );
|
|
|
|
|
|
2012-07-19 16:35:25 +00:00
|
|
|
$clientHeader = $this->getRequest()->getHeader( 'If-Modified-Since' );
|
|
|
|
|
if ( $clientHeader === false ) {
|
2015-12-30 19:48:01 +00:00
|
|
|
wfDebug( __METHOD__ . ": client did not send If-Modified-Since header", 'private' );
|
2008-08-29 08:40:13 +00:00
|
|
|
return false;
|
2003-04-14 23:10:40 +00:00
|
|
|
}
|
2008-08-29 08:40:13 +00:00
|
|
|
|
|
|
|
|
# IE sends sizes after the date like this:
|
|
|
|
|
# Wed, 20 Aug 2003 06:51:19 GMT; length=5202
|
|
|
|
|
# this breaks strtotime().
|
2012-07-19 16:35:25 +00:00
|
|
|
$clientHeader = preg_replace( '/;.*$/', '', $clientHeader );
|
2008-08-29 08:40:13 +00:00
|
|
|
|
2015-06-10 18:29:05 +00:00
|
|
|
MediaWiki\suppressWarnings(); // E_STRICT system time bitching
|
2008-12-23 19:39:00 +00:00
|
|
|
$clientHeaderTime = strtotime( $clientHeader );
|
2015-06-10 18:29:05 +00:00
|
|
|
MediaWiki\restoreWarnings();
|
2008-12-23 19:39:00 +00:00
|
|
|
if ( !$clientHeaderTime ) {
|
2014-05-11 01:54:15 +00:00
|
|
|
wfDebug( __METHOD__
|
|
|
|
|
. ": unable to parse the client's If-Modified-Since header: $clientHeader\n" );
|
2008-08-29 08:40:13 +00:00
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
$clientHeaderTime = wfTimestamp( TS_MW, $clientHeaderTime );
|
|
|
|
|
|
2012-07-19 16:35:25 +00:00
|
|
|
# Make debug info
|
|
|
|
|
$info = '';
|
|
|
|
|
foreach ( $modifiedTimes as $name => $value ) {
|
|
|
|
|
if ( $info !== '' ) {
|
|
|
|
|
$info .= ', ';
|
|
|
|
|
}
|
|
|
|
|
$info .= "$name=" . wfTimestamp( TS_ISO_8601, $value );
|
|
|
|
|
}
|
|
|
|
|
|
here it is ... the upload-api, script-server, js2 (javascript phase2) branch merge 1st attempt.
Here is a short overview of changes and associated default configuration variables (most everything is off by default) also see ~soon to be updated~: http://www.mediawiki.org/wiki/Media_Projects_Overview
= Upload Improvements =
==Upload API ==
* Based on the early work of Bryan Tong and others it adds the upload option to the api.
* We rewrite Special:Upload page to include use the new refactoring
* Added in token checks in both the SpecialUpload.php page so avoids DOS / xss copy-by-url JavaScript based cross site POST file submissions
== Copy by URL==
$wgAllowCopyUploads = false;
* http class rewrite includes a new http background download see: includes/HttpFunctions.php
* spins off a php process that calls: maintenance/http_session_download.php
* pushes updates to the session and gives the user a progress bar on http copy uploads from other server progress (using js2 upload interface) (if not using the js2 upload interface it does the request in-place but the download is limited to the php ini timeout time)
== Firefogg ==
* Firefogg enables resumable upload by chunks
* progress indicators and conditional invokation (js2 system)
* and of-course client side transcoding.
= Script Server =
$wgEnableScriptLoader = false;
* off by default if $wgEnableScriptLoader is turned on script files are grouped, gziped, cached etc.
for more info see: http://www.mediawiki.org/wiki/Extension:ScriptLoader
* Includes some early skin js include fixes (skin/script system still lots of love)
* Includes a "javascript class autoloader" this is packaged into mwEmbed so that the mwEmbed library can work in stand alone mode (while retaining localization and script serving) (one such application is the make page for firefogg.org : http://www.firefogg.org/make/index.html )
* The file that contains the autojavascript loading classes is: js2/php/jsAutoloadLocalClasses.php
* One can use this auto class loading dependency system with extensions and add-ons but I need to better document that.
= js2 system / mwEmbed=
$wgEnableJS2system = false
* includes initial rewrite towards more jquery based javascript code
* especially for the Special:Upload page.
* Also the edit page include support for the "add-media-wizard"
* includes dependency loader for javascript that optionally takes advantage of the script-loader
* remote embedding of javascript interfaces (like embedding video, or commons media searching)
* $wgDebugJavaScript = false; .. .this variable lets you always get "always fresh javascript". When used with the script-loader it does not minify the script-loader output.
= mwEmbed =
* Will commit a separate patch to oggHandler that conditionally outputs <video tag> to use the new javascript video player.
** mv_embed player includes: play-head, volume control, remote embedding, oggz-chop support across plugins.
* add-media-wizard adds easy inserts of media to pages (with import)
== jQuery==
* we include a base install of jQuery, jQuery ui and some plugins.
* all the javascript classes are in the scriptloader so its easy to load any set of jquery ui components that you may need using the script-server. You get a callback so you can then execute js with dependencies loaded.
== other stuff ==
there is a bit more code in js2 that pertains to sequence editing, timed text display and basic image editing. We include a base import of pixastic-lib & pixastic-editor... will work with the pixastic developer to try and ensure upstream compatibility on our usage of the library for in-browser photo and sequence manipulation.
2009-07-14 23:52:14 +00:00
|
|
|
wfDebug( __METHOD__ . ": client sent If-Modified-Since: " .
|
2015-12-30 19:48:01 +00:00
|
|
|
wfTimestamp( TS_ISO_8601, $clientHeaderTime ), 'private' );
|
here it is ... the upload-api, script-server, js2 (javascript phase2) branch merge 1st attempt.
Here is a short overview of changes and associated default configuration variables (most everything is off by default) also see ~soon to be updated~: http://www.mediawiki.org/wiki/Media_Projects_Overview
= Upload Improvements =
==Upload API ==
* Based on the early work of Bryan Tong and others it adds the upload option to the api.
* We rewrite Special:Upload page to include use the new refactoring
* Added in token checks in both the SpecialUpload.php page so avoids DOS / xss copy-by-url JavaScript based cross site POST file submissions
== Copy by URL==
$wgAllowCopyUploads = false;
* http class rewrite includes a new http background download see: includes/HttpFunctions.php
* spins off a php process that calls: maintenance/http_session_download.php
* pushes updates to the session and gives the user a progress bar on http copy uploads from other server progress (using js2 upload interface) (if not using the js2 upload interface it does the request in-place but the download is limited to the php ini timeout time)
== Firefogg ==
* Firefogg enables resumable upload by chunks
* progress indicators and conditional invokation (js2 system)
* and of-course client side transcoding.
= Script Server =
$wgEnableScriptLoader = false;
* off by default if $wgEnableScriptLoader is turned on script files are grouped, gziped, cached etc.
for more info see: http://www.mediawiki.org/wiki/Extension:ScriptLoader
* Includes some early skin js include fixes (skin/script system still lots of love)
* Includes a "javascript class autoloader" this is packaged into mwEmbed so that the mwEmbed library can work in stand alone mode (while retaining localization and script serving) (one such application is the make page for firefogg.org : http://www.firefogg.org/make/index.html )
* The file that contains the autojavascript loading classes is: js2/php/jsAutoloadLocalClasses.php
* One can use this auto class loading dependency system with extensions and add-ons but I need to better document that.
= js2 system / mwEmbed=
$wgEnableJS2system = false
* includes initial rewrite towards more jquery based javascript code
* especially for the Special:Upload page.
* Also the edit page include support for the "add-media-wizard"
* includes dependency loader for javascript that optionally takes advantage of the script-loader
* remote embedding of javascript interfaces (like embedding video, or commons media searching)
* $wgDebugJavaScript = false; .. .this variable lets you always get "always fresh javascript". When used with the script-loader it does not minify the script-loader output.
= mwEmbed =
* Will commit a separate patch to oggHandler that conditionally outputs <video tag> to use the new javascript video player.
** mv_embed player includes: play-head, volume control, remote embedding, oggz-chop support across plugins.
* add-media-wizard adds easy inserts of media to pages (with import)
== jQuery==
* we include a base install of jQuery, jQuery ui and some plugins.
* all the javascript classes are in the scriptloader so its easy to load any set of jquery ui components that you may need using the script-server. You get a callback so you can then execute js with dependencies loaded.
== other stuff ==
there is a bit more code in js2 that pertains to sequence editing, timed text display and basic image editing. We include a base import of pixastic-lib & pixastic-editor... will work with the pixastic developer to try and ensure upstream compatibility on our usage of the library for in-browser photo and sequence manipulation.
2009-07-14 23:52:14 +00:00
|
|
|
wfDebug( __METHOD__ . ": effective Last-Modified: " .
|
2015-12-30 19:48:01 +00:00
|
|
|
wfTimestamp( TS_ISO_8601, $maxModified ), 'private' );
|
2013-04-17 14:52:47 +00:00
|
|
|
if ( $clientHeaderTime < $maxModified ) {
|
2015-12-30 19:48:01 +00:00
|
|
|
wfDebug( __METHOD__ . ": STALE, $info", 'private' );
|
2008-08-29 08:40:13 +00:00
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
|
2008-12-23 19:39:00 +00:00
|
|
|
# Not modified
|
2015-05-24 12:31:11 +00:00
|
|
|
# Give a 304 Not Modified response code and disable body output
|
2015-12-30 19:48:01 +00:00
|
|
|
wfDebug( __METHOD__ . ": NOT MODIFIED, $info", 'private' );
|
2010-05-22 12:18:22 +00:00
|
|
|
ini_set( 'zlib.output_compression', 0 );
|
2015-05-24 12:31:11 +00:00
|
|
|
$this->getRequest()->response()->statusHeader( 304 );
|
2008-08-29 08:40:13 +00:00
|
|
|
$this->sendCacheControl();
|
|
|
|
|
$this->disable();
|
|
|
|
|
|
|
|
|
|
// Don't output a compressed blob when using ob_gzhandler;
|
|
|
|
|
// it's technically against HTTP spec and seems to confuse
|
|
|
|
|
// Firefox when the response gets split over two packets.
|
|
|
|
|
wfClearOutputBuffers();
|
|
|
|
|
|
|
|
|
|
return true;
|
2003-04-14 23:10:40 +00:00
|
|
|
}
|
|
|
|
|
|
2010-04-05 16:14:58 +00:00
|
|
|
/**
|
|
|
|
|
* Override the last modified timestamp
|
|
|
|
|
*
|
2014-07-24 17:42:24 +00:00
|
|
|
* @param string $timestamp New timestamp, in a format readable by
|
2010-04-05 16:14:58 +00:00
|
|
|
* wfTimestamp()
|
|
|
|
|
*/
|
|
|
|
|
public function setLastModified( $timestamp ) {
|
|
|
|
|
$this->mLastModified = wfTimestamp( TS_RFC2822, $timestamp );
|
|
|
|
|
}
|
|
|
|
|
|
2008-07-23 19:05:43 +00:00
|
|
|
/**
|
|
|
|
|
* Set the robot policy for the page: <http://www.robotstxt.org/meta.html>
|
|
|
|
|
*
|
2014-07-24 17:42:24 +00:00
|
|
|
* @param string $policy The literal string to output as the contents of
|
2013-12-02 21:20:11 +00:00
|
|
|
* the meta tag. Will be parsed according to the spec and output in
|
|
|
|
|
* standardized form.
|
2008-07-23 19:05:43 +00:00
|
|
|
* @return null
|
|
|
|
|
*/
|
|
|
|
|
public function setRobotPolicy( $policy ) {
|
2009-08-31 19:19:12 +00:00
|
|
|
$policy = Article::formatRobotPolicy( $policy );
|
2008-07-23 19:05:43 +00:00
|
|
|
|
2013-04-17 14:52:47 +00:00
|
|
|
if ( isset( $policy['index'] ) ) {
|
2009-08-31 19:19:12 +00:00
|
|
|
$this->setIndexPolicy( $policy['index'] );
|
2010-01-28 21:58:50 +00:00
|
|
|
}
|
2013-04-17 14:52:47 +00:00
|
|
|
if ( isset( $policy['follow'] ) ) {
|
2009-08-31 19:19:12 +00:00
|
|
|
$this->setFollowPolicy( $policy['follow'] );
|
2010-01-28 21:58:50 +00:00
|
|
|
}
|
2008-07-23 19:05:43 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Set the index policy for the page, but leave the follow policy un-
|
|
|
|
|
* touched.
|
|
|
|
|
*
|
2013-03-11 17:15:01 +00:00
|
|
|
* @param string $policy Either 'index' or 'noindex'.
|
2008-07-23 19:05:43 +00:00
|
|
|
* @return null
|
|
|
|
|
*/
|
|
|
|
|
public function setIndexPolicy( $policy ) {
|
|
|
|
|
$policy = trim( $policy );
|
2016-02-17 09:09:32 +00:00
|
|
|
if ( in_array( $policy, [ 'index', 'noindex' ] ) ) {
|
2008-07-23 19:05:43 +00:00
|
|
|
$this->mIndexPolicy = $policy;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Set the follow policy for the page, but leave the index policy un-
|
|
|
|
|
* touched.
|
|
|
|
|
*
|
2014-07-24 17:42:24 +00:00
|
|
|
* @param string $policy Either 'follow' or 'nofollow'.
|
2008-07-23 19:05:43 +00:00
|
|
|
* @return null
|
|
|
|
|
*/
|
|
|
|
|
public function setFollowPolicy( $policy ) {
|
|
|
|
|
$policy = trim( $policy );
|
2016-02-17 09:09:32 +00:00
|
|
|
if ( in_array( $policy, [ 'follow', 'nofollow' ] ) ) {
|
2008-07-23 19:05:43 +00:00
|
|
|
$this->mFollowPolicy = $policy;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2010-01-28 21:58:50 +00:00
|
|
|
/**
|
|
|
|
|
* Set the new value of the "action text", this will be added to the
|
|
|
|
|
* "HTML title", separated from it with " - ".
|
|
|
|
|
*
|
2014-07-24 17:42:24 +00:00
|
|
|
* @param string $text New value of the "action text"
|
2010-01-28 21:58:50 +00:00
|
|
|
*/
|
|
|
|
|
public function setPageTitleActionText( $text ) {
|
|
|
|
|
$this->mPageTitleActionText = $text;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Get the value of the "action text"
|
|
|
|
|
*
|
2014-04-10 18:50:10 +00:00
|
|
|
* @return string
|
2010-01-28 21:58:50 +00:00
|
|
|
*/
|
|
|
|
|
public function getPageTitleActionText() {
|
2014-07-01 17:17:02 +00:00
|
|
|
return $this->mPageTitleActionText;
|
2010-01-28 21:58:50 +00:00
|
|
|
}
|
|
|
|
|
|
2009-04-09 05:15:43 +00:00
|
|
|
/**
|
2012-07-10 12:48:06 +00:00
|
|
|
* "HTML title" means the contents of "<title>".
|
2010-04-10 05:46:01 +00:00
|
|
|
* It is stored as plain, unescaped text and will be run through htmlspecialchars in the skin file.
|
2011-05-21 19:07:24 +00:00
|
|
|
*
|
2014-07-27 15:21:01 +00:00
|
|
|
* @param string|Message $name
|
2009-04-09 05:15:43 +00:00
|
|
|
*/
|
2010-04-10 13:38:50 +00:00
|
|
|
public function setHTMLTitle( $name ) {
|
2011-10-27 20:23:16 +00:00
|
|
|
if ( $name instanceof Message ) {
|
|
|
|
|
$this->mHTMLtitle = $name->setContext( $this->getContext() )->text();
|
|
|
|
|
} else {
|
|
|
|
|
$this->mHTMLtitle = $name;
|
|
|
|
|
}
|
2011-10-24 17:24:38 +00:00
|
|
|
}
|
|
|
|
|
|
2010-01-28 21:58:50 +00:00
|
|
|
/**
|
2012-07-10 12:48:06 +00:00
|
|
|
* Return the "HTML title", i.e. the content of the "<title>" tag.
|
2010-01-28 21:58:50 +00:00
|
|
|
*
|
2014-04-10 18:50:10 +00:00
|
|
|
* @return string
|
2010-01-28 21:58:50 +00:00
|
|
|
*/
|
|
|
|
|
public function getHTMLTitle() {
|
|
|
|
|
return $this->mHTMLtitle;
|
|
|
|
|
}
|
|
|
|
|
|
2011-11-30 12:43:10 +00:00
|
|
|
/**
|
|
|
|
|
* Set $mRedirectedFrom, the Title of the page which redirected us to the current page.
|
|
|
|
|
*
|
2014-04-10 18:50:10 +00:00
|
|
|
* @param Title $t
|
2011-11-30 12:43:10 +00:00
|
|
|
*/
|
|
|
|
|
public function setRedirectedFrom( $t ) {
|
|
|
|
|
$this->mRedirectedFrom = $t;
|
|
|
|
|
}
|
|
|
|
|
|
2009-04-09 05:15:43 +00:00
|
|
|
/**
|
2014-05-11 01:54:15 +00:00
|
|
|
* "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.
|
2011-05-21 19:07:24 +00:00
|
|
|
*
|
2014-04-10 18:50:10 +00:00
|
|
|
* @param string|Message $name
|
2009-11-14 21:27:13 +00:00
|
|
|
*/
|
2006-11-07 05:37:31 +00:00
|
|
|
public function setPageTitle( $name ) {
|
2011-10-27 20:23:16 +00:00
|
|
|
if ( $name instanceof Message ) {
|
|
|
|
|
$name = $name->setContext( $this->getContext() )->text();
|
|
|
|
|
}
|
|
|
|
|
|
2009-04-09 05:15:43 +00:00
|
|
|
# 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;
|
2009-02-04 19:43:30 +00:00
|
|
|
|
2009-04-09 05:15:43 +00:00
|
|
|
# change "<i>foo&bar</i>" to "foo&bar"
|
2013-11-12 08:36:00 +00:00
|
|
|
$this->setHTMLTitle(
|
|
|
|
|
$this->msg( 'pagetitle' )->rawParams( Sanitizer::stripAllTags( $nameWithTags ) )
|
|
|
|
|
->inContentLanguage()
|
|
|
|
|
);
|
2004-04-25 00:32:24 +00:00
|
|
|
}
|
here it is ... the upload-api, script-server, js2 (javascript phase2) branch merge 1st attempt.
Here is a short overview of changes and associated default configuration variables (most everything is off by default) also see ~soon to be updated~: http://www.mediawiki.org/wiki/Media_Projects_Overview
= Upload Improvements =
==Upload API ==
* Based on the early work of Bryan Tong and others it adds the upload option to the api.
* We rewrite Special:Upload page to include use the new refactoring
* Added in token checks in both the SpecialUpload.php page so avoids DOS / xss copy-by-url JavaScript based cross site POST file submissions
== Copy by URL==
$wgAllowCopyUploads = false;
* http class rewrite includes a new http background download see: includes/HttpFunctions.php
* spins off a php process that calls: maintenance/http_session_download.php
* pushes updates to the session and gives the user a progress bar on http copy uploads from other server progress (using js2 upload interface) (if not using the js2 upload interface it does the request in-place but the download is limited to the php ini timeout time)
== Firefogg ==
* Firefogg enables resumable upload by chunks
* progress indicators and conditional invokation (js2 system)
* and of-course client side transcoding.
= Script Server =
$wgEnableScriptLoader = false;
* off by default if $wgEnableScriptLoader is turned on script files are grouped, gziped, cached etc.
for more info see: http://www.mediawiki.org/wiki/Extension:ScriptLoader
* Includes some early skin js include fixes (skin/script system still lots of love)
* Includes a "javascript class autoloader" this is packaged into mwEmbed so that the mwEmbed library can work in stand alone mode (while retaining localization and script serving) (one such application is the make page for firefogg.org : http://www.firefogg.org/make/index.html )
* The file that contains the autojavascript loading classes is: js2/php/jsAutoloadLocalClasses.php
* One can use this auto class loading dependency system with extensions and add-ons but I need to better document that.
= js2 system / mwEmbed=
$wgEnableJS2system = false
* includes initial rewrite towards more jquery based javascript code
* especially for the Special:Upload page.
* Also the edit page include support for the "add-media-wizard"
* includes dependency loader for javascript that optionally takes advantage of the script-loader
* remote embedding of javascript interfaces (like embedding video, or commons media searching)
* $wgDebugJavaScript = false; .. .this variable lets you always get "always fresh javascript". When used with the script-loader it does not minify the script-loader output.
= mwEmbed =
* Will commit a separate patch to oggHandler that conditionally outputs <video tag> to use the new javascript video player.
** mv_embed player includes: play-head, volume control, remote embedding, oggz-chop support across plugins.
* add-media-wizard adds easy inserts of media to pages (with import)
== jQuery==
* we include a base install of jQuery, jQuery ui and some plugins.
* all the javascript classes are in the scriptloader so its easy to load any set of jquery ui components that you may need using the script-server. You get a callback so you can then execute js with dependencies loaded.
== other stuff ==
there is a bit more code in js2 that pertains to sequence editing, timed text display and basic image editing. We include a base import of pixastic-lib & pixastic-editor... will work with the pixastic developer to try and ensure upstream compatibility on our usage of the library for in-browser photo and sequence manipulation.
2009-07-14 23:52:14 +00:00
|
|
|
|
2010-01-28 21:58:50 +00:00
|
|
|
/**
|
2010-02-02 16:26:52 +00:00
|
|
|
* Return the "page title", i.e. the content of the \<h1\> tag.
|
2010-01-28 21:58:50 +00:00
|
|
|
*
|
2014-04-10 18:50:10 +00:00
|
|
|
* @return string
|
2010-01-28 21:58:50 +00:00
|
|
|
*/
|
|
|
|
|
public function getPageTitle() {
|
|
|
|
|
return $this->mPagetitle;
|
|
|
|
|
}
|
|
|
|
|
|
2011-04-03 03:59:47 +00:00
|
|
|
/**
|
2011-04-03 10:41:14 +00:00
|
|
|
* Set the Title object to use
|
2011-04-03 03:59:47 +00:00
|
|
|
*
|
2014-04-10 18:50:10 +00:00
|
|
|
* @param Title $t
|
2011-04-03 03:59:47 +00:00
|
|
|
*/
|
2011-07-28 17:48:35 +00:00
|
|
|
public function setTitle( Title $t ) {
|
2011-04-18 12:43:53 +00:00
|
|
|
$this->getContext()->setTitle( $t );
|
2011-04-03 10:41:14 +00:00
|
|
|
}
|
|
|
|
|
|
2010-01-28 21:58:50 +00:00
|
|
|
/**
|
2013-03-13 07:42:41 +00:00
|
|
|
* Replace the subtitle with $str
|
2010-01-28 21:58:50 +00:00
|
|
|
*
|
2014-07-24 17:42:24 +00:00
|
|
|
* @param string|Message $str New value of the subtitle. String should be safe HTML.
|
2010-01-28 21:58:50 +00:00
|
|
|
*/
|
|
|
|
|
public function setSubtitle( $str ) {
|
2011-11-08 18:02:26 +00:00
|
|
|
$this->clearSubtitle();
|
|
|
|
|
$this->addSubtitle( $str );
|
2010-01-28 21:58:50 +00:00
|
|
|
}
|
|
|
|
|
|
2011-11-08 18:02:26 +00:00
|
|
|
/**
|
|
|
|
|
* Add $str to the subtitle
|
|
|
|
|
*
|
2014-07-24 17:42:24 +00:00
|
|
|
* @param string|Message $str String or Message to add to the subtitle. String should be safe HTML.
|
2011-11-08 18:02:26 +00:00
|
|
|
*/
|
|
|
|
|
public function addSubtitle( $str ) {
|
|
|
|
|
if ( $str instanceof Message ) {
|
|
|
|
|
$this->mSubtitle[] = $str->setContext( $this->getContext() )->parse();
|
|
|
|
|
} else {
|
|
|
|
|
$this->mSubtitle[] = $str;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
2014-08-03 20:04:45 +00:00
|
|
|
* Build message object for a subtitle containing a backlink to a page
|
2011-11-08 18:02:26 +00:00
|
|
|
*
|
2014-04-10 18:50:10 +00:00
|
|
|
* @param Title $title Title to link to
|
2014-08-07 08:22:57 +00:00
|
|
|
* @param array $query Array of additional parameters to include in the link
|
2014-08-03 20:04:45 +00:00
|
|
|
* @return Message
|
|
|
|
|
* @since 1.25
|
2011-11-08 18:02:26 +00:00
|
|
|
*/
|
2016-02-17 09:09:32 +00:00
|
|
|
public static function buildBacklinkSubtitle( Title $title, $query = [] ) {
|
2011-11-08 18:02:26 +00:00
|
|
|
if ( $title->isRedirect() ) {
|
|
|
|
|
$query['redirect'] = 'no';
|
|
|
|
|
}
|
2016-11-30 21:28:55 +00:00
|
|
|
$linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
|
2014-08-03 20:04:45 +00:00
|
|
|
return wfMessage( 'backlinksubtitle' )
|
2016-11-30 21:28:55 +00:00
|
|
|
->rawParams( $linkRenderer->makeLink( $title, null, [], $query ) );
|
2014-08-03 20:04:45 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Add a subtitle containing a backlink to a page
|
|
|
|
|
*
|
|
|
|
|
* @param Title $title Title to link to
|
|
|
|
|
* @param array $query Array of additional parameters to include in the link
|
|
|
|
|
*/
|
2016-02-17 09:09:32 +00:00
|
|
|
public function addBacklinkSubtitle( Title $title, $query = [] ) {
|
2014-08-03 20:04:45 +00:00
|
|
|
$this->addSubtitle( self::buildBacklinkSubtitle( $title, $query ) );
|
2011-11-08 18:02:26 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Clear the subtitles
|
|
|
|
|
*/
|
|
|
|
|
public function clearSubtitle() {
|
2016-02-17 09:09:32 +00:00
|
|
|
$this->mSubtitle = [];
|
2010-01-28 21:58:50 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Get the subtitle
|
|
|
|
|
*
|
2014-04-10 18:50:10 +00:00
|
|
|
* @return string
|
2010-01-28 21:58:50 +00:00
|
|
|
*/
|
|
|
|
|
public function getSubtitle() {
|
2011-11-08 18:02:26 +00:00
|
|
|
return implode( "<br />\n\t\t\t\t", $this->mSubtitle );
|
2010-01-28 21:58:50 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
2014-12-16 00:41:45 +00:00
|
|
|
* Set the page as printable, i.e. it'll be displayed with all
|
2010-01-28 21:58:50 +00:00
|
|
|
* print styles included
|
|
|
|
|
*/
|
|
|
|
|
public function setPrintable() {
|
|
|
|
|
$this->mPrintable = true;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Return whether the page is "printable"
|
|
|
|
|
*
|
2014-04-10 18:50:10 +00:00
|
|
|
* @return bool
|
2010-01-28 21:58:50 +00:00
|
|
|
*/
|
|
|
|
|
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
|
|
|
|
|
*
|
2014-04-10 18:50:10 +00:00
|
|
|
* @return bool
|
2010-01-28 21:58:50 +00:00
|
|
|
*/
|
|
|
|
|
public function isDisabled() {
|
|
|
|
|
return $this->mDoNothing;
|
|
|
|
|
}
|
|
|
|
|
|
2010-01-29 21:32:45 +00:00
|
|
|
/**
|
|
|
|
|
* Show an "add new section" link?
|
|
|
|
|
*
|
2014-04-10 18:50:10 +00:00
|
|
|
* @return bool
|
2010-01-29 21:32:45 +00:00
|
|
|
*/
|
|
|
|
|
public function showNewSectionLink() {
|
|
|
|
|
return $this->mNewSectionLink;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Forcibly hide the new section link?
|
|
|
|
|
*
|
2014-04-10 18:50:10 +00:00
|
|
|
* @return bool
|
2010-01-29 21:32:45 +00:00
|
|
|
*/
|
|
|
|
|
public function forceHideNewSectionLink() {
|
|
|
|
|
return $this->mHideNewSectionLink;
|
|
|
|
|
}
|
|
|
|
|
|
2010-01-26 20:47:34 +00:00
|
|
|
/**
|
|
|
|
|
* 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()
|
|
|
|
|
*
|
2014-07-24 17:42:24 +00:00
|
|
|
* @param bool $show True: add default feeds, false: remove all feeds
|
2010-01-26 20:47:34 +00:00
|
|
|
*/
|
2010-01-13 20:23:14 +00:00
|
|
|
public function setSyndicated( $show = true ) {
|
|
|
|
|
if ( $show ) {
|
|
|
|
|
$this->setFeedAppendQuery( false );
|
|
|
|
|
} else {
|
2016-02-17 09:09:32 +00:00
|
|
|
$this->mFeedLinks = [];
|
2010-01-13 20:23:14 +00:00
|
|
|
}
|
|
|
|
|
}
|
2009-10-24 21:32:53 +00:00
|
|
|
|
2010-01-26 20:47:34 +00:00
|
|
|
/**
|
|
|
|
|
* Add default feeds to the page header
|
|
|
|
|
* This is mainly kept for backward compatibility, see OutputPage::addFeedLink()
|
|
|
|
|
* for the new version
|
|
|
|
|
* @see addFeedLink()
|
|
|
|
|
*
|
2014-07-24 17:42:24 +00:00
|
|
|
* @param string $val Query to append to feed links or false to output
|
2010-01-26 20:47:34 +00:00
|
|
|
* default links
|
|
|
|
|
*/
|
2009-09-30 17:35:41 +00:00
|
|
|
public function setFeedAppendQuery( $val ) {
|
2016-02-17 09:09:32 +00:00
|
|
|
$this->mFeedLinks = [];
|
2009-10-24 21:32:53 +00:00
|
|
|
|
2014-08-23 08:52:41 +00:00
|
|
|
foreach ( $this->getConfig()->get( 'AdvertisedFeedTypes' ) as $type ) {
|
2010-01-13 20:23:14 +00:00
|
|
|
$query = "feed=$type";
|
2010-01-13 21:29:47 +00:00
|
|
|
if ( is_string( $val ) ) {
|
2010-01-13 20:23:14 +00:00
|
|
|
$query .= '&' . $val;
|
2010-01-13 21:29:47 +00:00
|
|
|
}
|
2009-09-30 17:35:41 +00:00
|
|
|
$this->mFeedLinks[$type] = $this->getTitle()->getLocalURL( $query );
|
|
|
|
|
}
|
|
|
|
|
}
|
2009-10-24 21:32:53 +00:00
|
|
|
|
2010-01-26 20:47:34 +00:00
|
|
|
/**
|
|
|
|
|
* Add a feed link to the page header
|
|
|
|
|
*
|
2014-07-24 17:42:24 +00:00
|
|
|
* @param string $format Feed type, should be a key of $wgFeedClasses
|
2013-03-11 17:15:01 +00:00
|
|
|
* @param string $href URL
|
2010-01-26 20:47:34 +00:00
|
|
|
*/
|
2009-09-30 17:35:41 +00:00
|
|
|
public function addFeedLink( $format, $href ) {
|
2014-08-23 08:52:41 +00:00
|
|
|
if ( in_array( $format, $this->getConfig()->get( 'AdvertisedFeedTypes' ) ) ) {
|
2010-05-11 19:36:47 +00:00
|
|
|
$this->mFeedLinks[$format] = $href;
|
|
|
|
|
}
|
2009-09-30 17:35:41 +00:00
|
|
|
}
|
2009-10-24 21:32:53 +00:00
|
|
|
|
2010-01-26 20:47:34 +00:00
|
|
|
/**
|
2010-01-27 00:11:13 +00:00
|
|
|
* Should we output feed links for this page?
|
2014-04-10 18:50:10 +00:00
|
|
|
* @return bool
|
2010-01-26 20:47:34 +00:00
|
|
|
*/
|
2010-01-28 21:58:50 +00:00
|
|
|
public function isSyndicated() {
|
|
|
|
|
return count( $this->mFeedLinks ) > 0;
|
|
|
|
|
}
|
2006-11-07 05:37:31 +00:00
|
|
|
|
2010-01-29 21:32:45 +00:00
|
|
|
/**
|
|
|
|
|
* Return URLs for each supported syndication format for this page.
|
2014-07-24 17:42:24 +00:00
|
|
|
* @return array Associating format keys with URLs
|
2010-01-29 21:32:45 +00:00
|
|
|
*/
|
|
|
|
|
public function getSyndicationLinks() {
|
|
|
|
|
return $this->mFeedLinks;
|
|
|
|
|
}
|
|
|
|
|
|
2010-01-28 21:58:50 +00:00
|
|
|
/**
|
|
|
|
|
* Will currently always return null
|
|
|
|
|
*
|
|
|
|
|
* @return null
|
|
|
|
|
*/
|
|
|
|
|
public function getFeedAppendQuery() {
|
|
|
|
|
return $this->mFeedLinksAppendQuery;
|
|
|
|
|
}
|
2010-01-26 20:47:34 +00:00
|
|
|
|
2010-01-28 21:58:50 +00:00
|
|
|
/**
|
|
|
|
|
* 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
|
|
|
|
|
*
|
2014-04-10 18:50:10 +00:00
|
|
|
* @param bool $v
|
2010-01-28 21:58:50 +00:00
|
|
|
*/
|
|
|
|
|
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
|
|
|
|
|
*
|
2014-04-10 18:50:10 +00:00
|
|
|
* @return bool
|
2010-01-28 21:58:50 +00:00
|
|
|
*/
|
|
|
|
|
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
|
|
|
|
|
*
|
2014-04-10 18:50:10 +00:00
|
|
|
* @param bool $v
|
2010-01-28 21:58:50 +00:00
|
|
|
*/
|
2006-11-07 05:37:31 +00:00
|
|
|
public function setArticleRelated( $v ) {
|
2004-01-17 09:49:43 +00:00
|
|
|
$this->mIsArticleRelated = $v;
|
|
|
|
|
if ( !$v ) {
|
|
|
|
|
$this->mIsarticle = false;
|
|
|
|
|
}
|
|
|
|
|
}
|
2010-01-28 21:58:50 +00:00
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Return whether this page is related an article on the wiki
|
|
|
|
|
*
|
2014-04-10 18:50:10 +00:00
|
|
|
* @return bool
|
2010-01-28 21:58:50 +00:00
|
|
|
*/
|
|
|
|
|
public function isArticleRelated() {
|
|
|
|
|
return $this->mIsArticleRelated;
|
2004-01-17 09:49:43 +00:00
|
|
|
}
|
|
|
|
|
|
2010-01-28 21:58:50 +00:00
|
|
|
/**
|
|
|
|
|
* Add new language links
|
|
|
|
|
*
|
2016-11-07 13:13:51 +00:00
|
|
|
* @param string[] $newLinkArray Array of interwiki-prefixed (non DB key) titles
|
|
|
|
|
* (e.g. 'fr:Test page')
|
2010-01-28 21:58:50 +00:00
|
|
|
*/
|
2014-07-23 02:49:30 +00:00
|
|
|
public function addLanguageLinks( array $newLinkArray ) {
|
2004-06-01 18:29:31 +00:00
|
|
|
$this->mLanguageLinks += $newLinkArray;
|
|
|
|
|
}
|
2010-01-28 21:58:50 +00:00
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Reset the language links and add new language links
|
|
|
|
|
*
|
2016-11-07 13:13:51 +00:00
|
|
|
* @param string[] $newLinkArray Array of interwiki-prefixed (non DB key) titles
|
|
|
|
|
* (e.g. 'fr:Test page')
|
2010-01-28 21:58:50 +00:00
|
|
|
*/
|
2014-07-23 02:49:30 +00:00
|
|
|
public function setLanguageLinks( array $newLinkArray ) {
|
2004-06-01 18:29:31 +00:00
|
|
|
$this->mLanguageLinks = $newLinkArray;
|
|
|
|
|
}
|
2004-09-17 15:24:43 +00:00
|
|
|
|
2010-01-28 21:58:50 +00:00
|
|
|
/**
|
|
|
|
|
* Get the list of language links
|
|
|
|
|
*
|
2016-11-07 13:13:51 +00:00
|
|
|
* @return string[] Array of interwiki-prefixed (non DB key) titles (e.g. 'fr:Test page')
|
2010-01-28 21:58:50 +00:00
|
|
|
*/
|
|
|
|
|
public function getLanguageLinks() {
|
|
|
|
|
return $this->mLanguageLinks;
|
2004-07-08 14:53:54 +00:00
|
|
|
}
|
2005-12-30 09:33:11 +00:00
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Add an array of categories, with names in the keys
|
2010-01-28 21:58:50 +00:00
|
|
|
*
|
2014-07-24 17:42:24 +00:00
|
|
|
* @param array $categories Mapping category name => sort key
|
2005-12-30 09:33:11 +00:00
|
|
|
*/
|
2014-07-23 02:49:30 +00:00
|
|
|
public function addCategoryLinks( array $categories ) {
|
2014-08-23 08:52:41 +00:00
|
|
|
global $wgContLang;
|
2005-12-30 09:33:11 +00:00
|
|
|
|
2008-02-25 16:38:25 +00:00
|
|
|
if ( !is_array( $categories ) || count( $categories ) == 0 ) {
|
2008-02-20 08:53:12 +00:00
|
|
|
return;
|
|
|
|
|
}
|
2008-02-25 16:38:25 +00:00
|
|
|
|
2016-07-08 19:11:53 +00:00
|
|
|
$res = $this->addCategoryLinksToLBAndGetResult( $categories );
|
2008-02-20 08:53:12 +00:00
|
|
|
|
2014-07-23 02:41:50 +00:00
|
|
|
# Set all the values to 'normal'.
|
|
|
|
|
$categories = array_fill_keys( array_keys( $categories ), 'normal' );
|
2008-02-25 16:38:25 +00:00
|
|
|
|
|
|
|
|
# Mark hidden categories
|
2008-02-20 08:53:12 +00:00
|
|
|
foreach ( $res as $row ) {
|
2008-02-25 16:38:25 +00:00
|
|
|
if ( isset( $row->pp_value ) ) {
|
|
|
|
|
$categories[$row->page_title] = 'hidden';
|
2008-02-20 08:53:12 +00:00
|
|
|
}
|
|
|
|
|
}
|
2008-02-25 16:38:25 +00:00
|
|
|
|
2017-01-01 23:07:11 +00:00
|
|
|
// Avoid PHP 7.1 warning of passing $this by reference
|
|
|
|
|
$outputPage = $this;
|
2008-02-20 08:53:12 +00:00
|
|
|
# Add the remaining categories to the skin
|
2014-12-09 07:23:30 +00:00
|
|
|
if ( Hooks::run(
|
2014-05-11 01:54:15 +00:00
|
|
|
'OutputPageMakeCategoryLinks',
|
2017-01-01 23:07:11 +00:00
|
|
|
[ &$outputPage, $categories, &$this->mCategoryLinks ] )
|
2014-05-11 01:54:15 +00:00
|
|
|
) {
|
2016-11-30 21:28:55 +00:00
|
|
|
$linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
|
2008-07-02 20:02:51 +00:00
|
|
|
foreach ( $categories as $category => $type ) {
|
2015-12-03 14:15:59 +00:00
|
|
|
// array keys will cast numeric category names to ints, so cast back to string
|
|
|
|
|
$category = (string)$category;
|
2009-02-02 07:54:43 +00:00
|
|
|
$origcategory = $category;
|
2008-07-02 20:02:51 +00:00
|
|
|
$title = Title::makeTitleSafe( NS_CATEGORY, $category );
|
2014-07-22 19:18:07 +00:00
|
|
|
if ( !$title ) {
|
|
|
|
|
continue;
|
|
|
|
|
}
|
2009-02-02 07:54:43 +00:00
|
|
|
$wgContLang->findVariantLink( $category, $title, true );
|
2014-07-22 19:19:41 +00:00
|
|
|
if ( $category != $origcategory && array_key_exists( $category, $categories ) ) {
|
|
|
|
|
continue;
|
2010-05-22 12:18:22 +00:00
|
|
|
}
|
2008-07-02 20:02:51 +00:00
|
|
|
$text = $wgContLang->convertHtml( $title->getText() );
|
2016-07-08 19:11:53 +00:00
|
|
|
$this->mCategories[$type][] = $title->getText();
|
2016-11-30 21:28:55 +00:00
|
|
|
$this->mCategoryLinks[$type][] = $linkRenderer->makeLink( $title, new HtmlArmor( $text ) );
|
2008-07-02 20:02:51 +00:00
|
|
|
}
|
2005-12-30 09:33:11 +00:00
|
|
|
}
|
2004-06-19 06:46:54 +00:00
|
|
|
}
|
2005-12-30 09:33:11 +00:00
|
|
|
|
2016-07-08 19:11:53 +00:00
|
|
|
/**
|
|
|
|
|
* @param array $categories
|
|
|
|
|
* @return bool|ResultWrapper
|
|
|
|
|
*/
|
|
|
|
|
protected function addCategoryLinksToLBAndGetResult( array $categories ) {
|
|
|
|
|
# Add the links to a LinkBatch
|
|
|
|
|
$arr = [ NS_CATEGORY => $categories ];
|
|
|
|
|
$lb = new LinkBatch;
|
|
|
|
|
$lb->setArray( $arr );
|
|
|
|
|
|
|
|
|
|
# Fetch existence plus the hiddencat property
|
|
|
|
|
$dbr = wfGetDB( DB_REPLICA );
|
|
|
|
|
$fields = array_merge(
|
|
|
|
|
LinkCache::getSelectFields(),
|
|
|
|
|
[ 'page_namespace', 'page_title', 'pp_value' ]
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
$res = $dbr->select( [ 'page', 'page_props' ],
|
|
|
|
|
$fields,
|
|
|
|
|
$lb->constructSet( 'page', $dbr ),
|
|
|
|
|
__METHOD__,
|
|
|
|
|
[],
|
|
|
|
|
[ 'page_props' => [ 'LEFT JOIN', [
|
|
|
|
|
'pp_propname' => 'hiddencat',
|
|
|
|
|
'pp_page = page_id'
|
|
|
|
|
] ] ]
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
# Add the results to the link cache
|
|
|
|
|
$lb->addResultToCache( LinkCache::singleton(), $res );
|
|
|
|
|
|
|
|
|
|
return $res;
|
|
|
|
|
}
|
|
|
|
|
|
2010-01-28 21:58:50 +00:00
|
|
|
/**
|
|
|
|
|
* Reset the category links (but not the category list) and add $categories
|
|
|
|
|
*
|
2014-07-24 17:42:24 +00:00
|
|
|
* @param array $categories Mapping category name => sort key
|
2010-01-28 21:58:50 +00:00
|
|
|
*/
|
2014-07-23 02:49:30 +00:00
|
|
|
public function setCategoryLinks( array $categories ) {
|
2016-02-17 09:09:32 +00:00
|
|
|
$this->mCategoryLinks = [];
|
2010-01-28 21:58:50 +00:00
|
|
|
$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
|
|
|
|
|
*
|
2014-04-10 18:50:10 +00:00
|
|
|
* @return array
|
2010-01-28 21:58:50 +00:00
|
|
|
*/
|
|
|
|
|
public function getCategoryLinks() {
|
|
|
|
|
return $this->mCategoryLinks;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
2016-07-08 19:11:53 +00:00
|
|
|
* Get the list of category names this page belongs to.
|
2010-01-28 21:58:50 +00:00
|
|
|
*
|
2016-07-08 19:11:53 +00:00
|
|
|
* @param string $type The type of categories which should be returned. Possible values:
|
|
|
|
|
* * all: all categories of all types
|
|
|
|
|
* * hidden: only the hidden categories
|
|
|
|
|
* * normal: all categories, except hidden categories
|
2014-04-10 18:50:10 +00:00
|
|
|
* @return array Array of strings
|
2010-01-28 21:58:50 +00:00
|
|
|
*/
|
2016-07-08 19:11:53 +00:00
|
|
|
public function getCategories( $type = 'all' ) {
|
|
|
|
|
if ( $type === 'all' ) {
|
|
|
|
|
$allCategories = [];
|
|
|
|
|
foreach ( $this->mCategories as $categories ) {
|
|
|
|
|
$allCategories = array_merge( $allCategories, $categories );
|
|
|
|
|
}
|
|
|
|
|
return $allCategories;
|
|
|
|
|
}
|
|
|
|
|
if ( !isset( $this->mCategories[$type] ) ) {
|
|
|
|
|
throw new InvalidArgumentException( 'Invalid category type given: ' . $type );
|
|
|
|
|
}
|
|
|
|
|
return $this->mCategories[$type];
|
2004-06-19 06:46:54 +00:00
|
|
|
}
|
|
|
|
|
|
Implement page status indicators
Page status indicators are icons (or short text snippets) usually
displayed in the top-right corner of the page, outside of the main
content. Basically, <indicator name="foo">[[File:Foo.svg|20px]]</indicator>
may be used on a page to place the icon in the indicator area. They
are also known as top icons, page icons, heading icons or title icons.
I found the discussion on bug 23796 highly illuminating. I suggest
that everyone read it before suggesting different design choices.
I spent some time with a thesaurus pondering the name. "Emblems" and
"badges" were also considered, but the former has a much more limited
meaning and the latter is already taken by Wikidata, with a similar
but subtly different feature set. I am not aware of any naming
conflicts ;) besides new talk page message "indicator" (used by core
and Echo in some documents) and OOjs UI indicators (tiny icons like
the arrow on a dropdown form element), which shouldn't be confusing.
Potential use cases include:
* "Lock" indicators for page protection levels
* Featured/good article indicators
* Redirect shortcuts display ("WP:VPT")
* Links to help/manual for special pages
* Coordinates?… or globe icon for inline pop-up maps
Design features:
* Skin-customizable. Skins can fully control where and how indicators
are shown, or may just do <?php echo $this->getIndicators(); ?> to
output the default structure. By default they are not shown at all.
* Extension-customizable. Extensions can call ParserOutput::addIndicator()
to insert an indicator from one of the numerous parser hooks.
* Wiki-customizable. In addition to just using the parser functions,
on-wiki styles and scripts can use the provided classes and ids
(.mw-indicator, #mw-indicator-<name>) to customize their display.
Design limitations:
* Every indicator must have a unique identifier (name). It's not
possible to create arrays, or to have several indicators with the
same name. In case of duplicates, the latest occurrence of the
parser function wins.
* Indicators are displayed ordered by their names (and not occurrence
order). This ensures consistency across pages and provides a simple
means of ordering or grouping them.
* Indicators are not stored, tracked or accessible outside of
ParserOutput (in particular they're not in the page_props table).
They are intended to merely reflect the content or metadata that is
already present on the page, and not be data themselves. If you ever
think you need to list pages with a given status indicator, instead
figure out what it means and use the appropriate tracking category,
special page report, already existing page_prop, or other means.
Corresponding patch in Vector: I90a8ae15ac8275d084ea5f47b6b2684d5e6c7412.
I'll implement support in the other three skins included in the tarball
and document it on mediawiki.org after this is merged.
Bug: 23796
Change-Id: I2389ff9a5332a2b1d033eb75f0946e5241cfaaf4
2014-09-24 10:44:16 +00:00
|
|
|
/**
|
2014-08-31 10:25:18 +00:00
|
|
|
* Add an array of indicators, with their identifiers as array
|
|
|
|
|
* keys and HTML contents as values.
|
Implement page status indicators
Page status indicators are icons (or short text snippets) usually
displayed in the top-right corner of the page, outside of the main
content. Basically, <indicator name="foo">[[File:Foo.svg|20px]]</indicator>
may be used on a page to place the icon in the indicator area. They
are also known as top icons, page icons, heading icons or title icons.
I found the discussion on bug 23796 highly illuminating. I suggest
that everyone read it before suggesting different design choices.
I spent some time with a thesaurus pondering the name. "Emblems" and
"badges" were also considered, but the former has a much more limited
meaning and the latter is already taken by Wikidata, with a similar
but subtly different feature set. I am not aware of any naming
conflicts ;) besides new talk page message "indicator" (used by core
and Echo in some documents) and OOjs UI indicators (tiny icons like
the arrow on a dropdown form element), which shouldn't be confusing.
Potential use cases include:
* "Lock" indicators for page protection levels
* Featured/good article indicators
* Redirect shortcuts display ("WP:VPT")
* Links to help/manual for special pages
* Coordinates?… or globe icon for inline pop-up maps
Design features:
* Skin-customizable. Skins can fully control where and how indicators
are shown, or may just do <?php echo $this->getIndicators(); ?> to
output the default structure. By default they are not shown at all.
* Extension-customizable. Extensions can call ParserOutput::addIndicator()
to insert an indicator from one of the numerous parser hooks.
* Wiki-customizable. In addition to just using the parser functions,
on-wiki styles and scripts can use the provided classes and ids
(.mw-indicator, #mw-indicator-<name>) to customize their display.
Design limitations:
* Every indicator must have a unique identifier (name). It's not
possible to create arrays, or to have several indicators with the
same name. In case of duplicates, the latest occurrence of the
parser function wins.
* Indicators are displayed ordered by their names (and not occurrence
order). This ensures consistency across pages and provides a simple
means of ordering or grouping them.
* Indicators are not stored, tracked or accessible outside of
ParserOutput (in particular they're not in the page_props table).
They are intended to merely reflect the content or metadata that is
already present on the page, and not be data themselves. If you ever
think you need to list pages with a given status indicator, instead
figure out what it means and use the appropriate tracking category,
special page report, already existing page_prop, or other means.
Corresponding patch in Vector: I90a8ae15ac8275d084ea5f47b6b2684d5e6c7412.
I'll implement support in the other three skins included in the tarball
and document it on mediawiki.org after this is merged.
Bug: 23796
Change-Id: I2389ff9a5332a2b1d033eb75f0946e5241cfaaf4
2014-09-24 10:44:16 +00:00
|
|
|
*
|
|
|
|
|
* In case of duplicate keys, existing values are overwritten.
|
|
|
|
|
*
|
|
|
|
|
* @param array $indicators
|
|
|
|
|
* @since 1.25
|
|
|
|
|
*/
|
|
|
|
|
public function setIndicators( array $indicators ) {
|
|
|
|
|
$this->mIndicators = $indicators + $this->mIndicators;
|
|
|
|
|
// Keep ordered by key
|
|
|
|
|
ksort( $this->mIndicators );
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Get the indicators associated with this page.
|
|
|
|
|
*
|
|
|
|
|
* The array will be internally ordered by item keys.
|
|
|
|
|
*
|
|
|
|
|
* @return array Keys: identifiers, values: HTML contents
|
|
|
|
|
* @since 1.25
|
|
|
|
|
*/
|
|
|
|
|
public function getIndicators() {
|
|
|
|
|
return $this->mIndicators;
|
|
|
|
|
}
|
|
|
|
|
|
2014-08-31 10:25:18 +00:00
|
|
|
/**
|
|
|
|
|
* Adds help link with an icon via page indicators.
|
2015-05-02 11:37:19 +00:00
|
|
|
* Link target can be overridden by a local message containing a wikilink:
|
|
|
|
|
* the message key is: lowercase action or special page name + '-helppage'.
|
|
|
|
|
* @param string $to Target MediaWiki.org page title or encoded URL.
|
|
|
|
|
* @param bool $overrideBaseUrl Whether $url is a full URL, to avoid MW.o.
|
2014-08-31 10:25:18 +00:00
|
|
|
* @since 1.25
|
|
|
|
|
*/
|
|
|
|
|
public function addHelpLink( $to, $overrideBaseUrl = false ) {
|
2015-03-07 17:36:41 +00:00
|
|
|
$this->addModuleStyles( 'mediawiki.helplink' );
|
|
|
|
|
$text = $this->msg( 'helppage-top-gethelp' )->escaped();
|
2014-08-31 10:25:18 +00:00
|
|
|
|
|
|
|
|
if ( $overrideBaseUrl ) {
|
|
|
|
|
$helpUrl = $to;
|
|
|
|
|
} else {
|
2015-03-10 18:26:39 +00:00
|
|
|
$toUrlencoded = wfUrlencode( str_replace( ' ', '_', $to ) );
|
|
|
|
|
$helpUrl = "//www.mediawiki.org/wiki/Special:MyLanguage/$toUrlencoded";
|
2014-08-31 10:25:18 +00:00
|
|
|
}
|
2015-05-02 11:37:19 +00:00
|
|
|
|
2014-08-31 10:25:18 +00:00
|
|
|
$link = Html::rawElement(
|
|
|
|
|
'a',
|
2016-02-17 09:09:32 +00:00
|
|
|
[
|
2014-08-31 10:25:18 +00:00
|
|
|
'href' => $helpUrl,
|
|
|
|
|
'target' => '_blank',
|
|
|
|
|
'class' => 'mw-helplink',
|
2016-02-17 09:09:32 +00:00
|
|
|
],
|
2014-08-31 10:25:18 +00:00
|
|
|
$text
|
|
|
|
|
);
|
|
|
|
|
|
2016-02-17 09:09:32 +00:00
|
|
|
$this->setIndicators( [ 'mw-helplink' => $link ] );
|
2014-08-31 10:25:18 +00:00
|
|
|
}
|
|
|
|
|
|
2010-01-29 21:32:45 +00:00
|
|
|
/**
|
2014-10-10 06:46:12 +00:00
|
|
|
* 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.
|
|
|
|
|
* Site-wide styles are controlled by a config setting, since they can be
|
|
|
|
|
* used to create a custom skin/theme, but not user-specific ones.
|
2014-09-11 23:14:16 +00:00
|
|
|
*
|
2014-10-10 06:46:12 +00:00
|
|
|
* @todo this should be given a more accurate name
|
2010-01-29 21:32:45 +00:00
|
|
|
*/
|
|
|
|
|
public function disallowUserJs() {
|
2014-10-10 06:46:12 +00:00
|
|
|
$this->reduceAllowedModules(
|
|
|
|
|
ResourceLoaderModule::TYPE_SCRIPTS,
|
|
|
|
|
ResourceLoaderModule::ORIGIN_CORE_INDIVIDUAL
|
|
|
|
|
);
|
|
|
|
|
|
2017-02-20 22:44:19 +00:00
|
|
|
// Site-wide styles are controlled by a config setting, see T73621
|
2014-10-10 06:46:12 +00:00
|
|
|
// for background on why. User styles are never allowed.
|
|
|
|
|
if ( $this->getConfig()->get( 'AllowSiteCSSOnRestrictedPages' ) ) {
|
|
|
|
|
$styleOrigin = ResourceLoaderModule::ORIGIN_USER_SITEWIDE;
|
|
|
|
|
} else {
|
|
|
|
|
$styleOrigin = ResourceLoaderModule::ORIGIN_CORE_INDIVIDUAL;
|
|
|
|
|
}
|
|
|
|
|
$this->reduceAllowedModules(
|
|
|
|
|
ResourceLoaderModule::TYPE_STYLES,
|
|
|
|
|
$styleOrigin
|
|
|
|
|
);
|
2010-01-29 21:32:45 +00:00
|
|
|
}
|
|
|
|
|
|
2011-02-04 16:39:17 +00:00
|
|
|
/**
|
2014-10-10 06:46:12 +00:00
|
|
|
* Show what level of JavaScript / CSS untrustworthiness is allowed on this page
|
2011-02-04 16:39:17 +00:00
|
|
|
* @see ResourceLoaderModule::$origin
|
2014-10-10 06:46:12 +00:00
|
|
|
* @param string $type ResourceLoaderModule TYPE_ constant
|
2014-04-10 18:50:10 +00:00
|
|
|
* @return int ResourceLoaderModule ORIGIN_ class constant
|
2011-02-04 16:39:17 +00:00
|
|
|
*/
|
2014-10-10 06:46:12 +00:00
|
|
|
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;
|
|
|
|
|
}
|
2011-02-04 16:39:17 +00:00
|
|
|
}
|
|
|
|
|
|
2014-09-11 23:14:16 +00:00
|
|
|
/**
|
|
|
|
|
* Limit the highest level of CSS/JS untrustworthiness allowed.
|
|
|
|
|
*
|
|
|
|
|
* If passed the same or a higher level than the current level of untrustworthiness set, the
|
|
|
|
|
* level will remain unchanged.
|
|
|
|
|
*
|
2014-10-10 06:46:12 +00:00
|
|
|
* @param string $type
|
2014-09-11 23:14:16 +00:00
|
|
|
* @param int $level ResourceLoaderModule class constant
|
|
|
|
|
*/
|
2014-10-10 06:46:12 +00:00
|
|
|
public function reduceAllowedModules( $type, $level ) {
|
|
|
|
|
$this->mAllowedModules[$type] = min( $this->getAllowedModules( $type ), $level );
|
2010-01-29 21:32:45 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Prepend $text to the body HTML
|
|
|
|
|
*
|
2013-03-11 17:15:01 +00:00
|
|
|
* @param string $text HTML
|
2010-01-29 21:32:45 +00:00
|
|
|
*/
|
|
|
|
|
public function prependHTML( $text ) {
|
|
|
|
|
$this->mBodytext = $text . $this->mBodytext;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Append $text to the body HTML
|
|
|
|
|
*
|
2013-03-11 17:15:01 +00:00
|
|
|
* @param string $text HTML
|
2010-01-29 21:32:45 +00:00
|
|
|
*/
|
|
|
|
|
public function addHTML( $text ) {
|
|
|
|
|
$this->mBodytext .= $text;
|
|
|
|
|
}
|
2011-10-16 03:27:12 +00:00
|
|
|
|
2011-10-10 21:05:02 +00:00
|
|
|
/**
|
|
|
|
|
* Shortcut for adding an Html::element via addHTML.
|
2011-10-16 03:27:12 +00:00
|
|
|
*
|
2011-10-10 21:05:02 +00:00
|
|
|
* @since 1.19
|
2011-10-16 03:27:12 +00:00
|
|
|
*
|
2014-04-10 18:50:10 +00:00
|
|
|
* @param string $element
|
|
|
|
|
* @param array $attribs
|
|
|
|
|
* @param string $contents
|
2011-10-10 21:05:02 +00:00
|
|
|
*/
|
2016-02-17 09:09:32 +00:00
|
|
|
public function addElement( $element, array $attribs = [], $contents = '' ) {
|
2011-10-10 21:05:02 +00:00
|
|
|
$this->addHTML( Html::element( $element, $attribs, $contents ) );
|
|
|
|
|
}
|
2010-01-29 21:32:45 +00:00
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Clear the body HTML
|
|
|
|
|
*/
|
|
|
|
|
public function clearHTML() {
|
|
|
|
|
$this->mBodytext = '';
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Get the body HTML
|
|
|
|
|
*
|
2014-04-08 15:29:17 +00:00
|
|
|
* @return string HTML
|
2010-01-29 21:32:45 +00:00
|
|
|
*/
|
|
|
|
|
public function getHTML() {
|
|
|
|
|
return $this->mBodytext;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Get/set the ParserOptions object to use for wikitext parsing
|
|
|
|
|
*
|
2014-04-10 18:50:10 +00:00
|
|
|
* @param ParserOptions|null $options Either the ParserOption to use or null to only get the
|
|
|
|
|
* current ParserOption object
|
|
|
|
|
* @return ParserOptions
|
2010-01-29 21:32:45 +00:00
|
|
|
*/
|
2006-11-07 05:37:31 +00:00
|
|
|
public function parserOptions( $options = null ) {
|
2016-02-03 20:18:52 +00:00
|
|
|
if ( $options !== null && !empty( $options->isBogus ) ) {
|
|
|
|
|
// Someone is trying to set a bogus pre-$wgUser PO. Check if it has
|
|
|
|
|
// been changed somehow, and keep it if so.
|
|
|
|
|
$anonPO = ParserOptions::newFromAnon();
|
|
|
|
|
$anonPO->setEditSection( false );
|
2017-02-06 03:00:39 +00:00
|
|
|
$anonPO->setAllowUnsafeRawHtml( false );
|
2016-02-03 20:18:52 +00:00
|
|
|
if ( !$options->matches( $anonPO ) ) {
|
|
|
|
|
wfLogWarning( __METHOD__ . ': Setting a changed bogus ParserOptions: ' . wfGetAllCallers( 5 ) );
|
|
|
|
|
$options->isBogus = false;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2006-07-26 07:15:39 +00:00
|
|
|
if ( !$this->mParserOptions ) {
|
2016-02-03 20:18:52 +00:00
|
|
|
if ( !$this->getContext()->getUser()->isSafeToLoad() ) {
|
2017-10-03 22:50:12 +00:00
|
|
|
// $wgUser isn't loaded yet, so don't try to get a
|
2016-02-03 20:18:52 +00:00
|
|
|
// ParserOptions for it. And don't cache this ParserOptions
|
|
|
|
|
// either.
|
|
|
|
|
$po = ParserOptions::newFromAnon();
|
|
|
|
|
$po->setEditSection( false );
|
2017-02-06 03:00:39 +00:00
|
|
|
$po->setAllowUnsafeRawHtml( false );
|
2016-02-03 20:18:52 +00:00
|
|
|
$po->isBogus = true;
|
|
|
|
|
if ( $options !== null ) {
|
|
|
|
|
$this->mParserOptions = empty( $options->isBogus ) ? $options : null;
|
|
|
|
|
}
|
|
|
|
|
return $po;
|
|
|
|
|
}
|
|
|
|
|
|
2011-10-19 14:16:01 +00:00
|
|
|
$this->mParserOptions = ParserOptions::newFromContext( $this->getContext() );
|
2011-07-20 22:32:30 +00:00
|
|
|
$this->mParserOptions->setEditSection( false );
|
2017-02-06 03:00:39 +00:00
|
|
|
$this->mParserOptions->setAllowUnsafeRawHtml( false );
|
2006-07-26 07:15:39 +00:00
|
|
|
}
|
2016-02-03 20:18:52 +00:00
|
|
|
|
|
|
|
|
if ( $options !== null && !empty( $options->isBogus ) ) {
|
|
|
|
|
// They're trying to restore the bogus pre-$wgUser PO. Do the right
|
|
|
|
|
// thing.
|
|
|
|
|
return wfSetVar( $this->mParserOptions, null, true );
|
|
|
|
|
} else {
|
|
|
|
|
return wfSetVar( $this->mParserOptions, $options );
|
|
|
|
|
}
|
2004-02-29 08:43:29 +00:00
|
|
|
}
|
2006-01-07 13:31:29 +00:00
|
|
|
|
2005-11-27 06:04:41 +00:00
|
|
|
/**
|
|
|
|
|
* Set the revision ID which will be seen by the wiki text parser
|
|
|
|
|
* for things such as embedded {{REVISIONID}} variable use.
|
2010-01-29 21:32:45 +00:00
|
|
|
*
|
2014-04-08 15:29:17 +00:00
|
|
|
* @param int|null $revid An positive integer, or null
|
|
|
|
|
* @return mixed Previous value
|
2005-11-27 06:04:41 +00:00
|
|
|
*/
|
2006-11-07 05:37:31 +00:00
|
|
|
public function setRevisionId( $revid ) {
|
2005-11-27 06:04:41 +00:00
|
|
|
$val = is_null( $revid ) ? null : intval( $revid );
|
|
|
|
|
return wfSetVar( $this->mRevisionId, $val );
|
|
|
|
|
}
|
here it is ... the upload-api, script-server, js2 (javascript phase2) branch merge 1st attempt.
Here is a short overview of changes and associated default configuration variables (most everything is off by default) also see ~soon to be updated~: http://www.mediawiki.org/wiki/Media_Projects_Overview
= Upload Improvements =
==Upload API ==
* Based on the early work of Bryan Tong and others it adds the upload option to the api.
* We rewrite Special:Upload page to include use the new refactoring
* Added in token checks in both the SpecialUpload.php page so avoids DOS / xss copy-by-url JavaScript based cross site POST file submissions
== Copy by URL==
$wgAllowCopyUploads = false;
* http class rewrite includes a new http background download see: includes/HttpFunctions.php
* spins off a php process that calls: maintenance/http_session_download.php
* pushes updates to the session and gives the user a progress bar on http copy uploads from other server progress (using js2 upload interface) (if not using the js2 upload interface it does the request in-place but the download is limited to the php ini timeout time)
== Firefogg ==
* Firefogg enables resumable upload by chunks
* progress indicators and conditional invokation (js2 system)
* and of-course client side transcoding.
= Script Server =
$wgEnableScriptLoader = false;
* off by default if $wgEnableScriptLoader is turned on script files are grouped, gziped, cached etc.
for more info see: http://www.mediawiki.org/wiki/Extension:ScriptLoader
* Includes some early skin js include fixes (skin/script system still lots of love)
* Includes a "javascript class autoloader" this is packaged into mwEmbed so that the mwEmbed library can work in stand alone mode (while retaining localization and script serving) (one such application is the make page for firefogg.org : http://www.firefogg.org/make/index.html )
* The file that contains the autojavascript loading classes is: js2/php/jsAutoloadLocalClasses.php
* One can use this auto class loading dependency system with extensions and add-ons but I need to better document that.
= js2 system / mwEmbed=
$wgEnableJS2system = false
* includes initial rewrite towards more jquery based javascript code
* especially for the Special:Upload page.
* Also the edit page include support for the "add-media-wizard"
* includes dependency loader for javascript that optionally takes advantage of the script-loader
* remote embedding of javascript interfaces (like embedding video, or commons media searching)
* $wgDebugJavaScript = false; .. .this variable lets you always get "always fresh javascript". When used with the script-loader it does not minify the script-loader output.
= mwEmbed =
* Will commit a separate patch to oggHandler that conditionally outputs <video tag> to use the new javascript video player.
** mv_embed player includes: play-head, volume control, remote embedding, oggz-chop support across plugins.
* add-media-wizard adds easy inserts of media to pages (with import)
== jQuery==
* we include a base install of jQuery, jQuery ui and some plugins.
* all the javascript classes are in the scriptloader so its easy to load any set of jquery ui components that you may need using the script-server. You get a callback so you can then execute js with dependencies loaded.
== other stuff ==
there is a bit more code in js2 that pertains to sequence editing, timed text display and basic image editing. We include a base import of pixastic-lib & pixastic-editor... will work with the pixastic developer to try and ensure upstream compatibility on our usage of the library for in-browser photo and sequence manipulation.
2009-07-14 23:52:14 +00:00
|
|
|
|
2010-01-29 21:32:45 +00:00
|
|
|
/**
|
2011-07-05 05:23:26 +00:00
|
|
|
* Get the displayed revision ID
|
2010-01-29 21:32:45 +00:00
|
|
|
*
|
2014-04-10 18:50:10 +00:00
|
|
|
* @return int
|
2010-01-29 21:32:45 +00:00
|
|
|
*/
|
2008-08-11 13:23:45 +00:00
|
|
|
public function getRevisionId() {
|
|
|
|
|
return $this->mRevisionId;
|
|
|
|
|
}
|
2004-02-29 08:43:29 +00:00
|
|
|
|
2011-12-10 16:30:40 +00:00
|
|
|
/**
|
|
|
|
|
* Set the timestamp of the revision which will be displayed. This is used
|
|
|
|
|
* to avoid a extra DB call in Skin::lastModified().
|
|
|
|
|
*
|
2014-04-08 15:29:17 +00:00
|
|
|
* @param string|null $timestamp
|
|
|
|
|
* @return mixed Previous value
|
2011-12-10 16:30:40 +00:00
|
|
|
*/
|
2013-03-24 10:01:51 +00:00
|
|
|
public function setRevisionTimestamp( $timestamp ) {
|
2012-07-10 15:19:07 +00:00
|
|
|
return wfSetVar( $this->mRevisionTimestamp, $timestamp );
|
2011-12-10 16:30:40 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Get the timestamp of displayed revision.
|
|
|
|
|
* This will be null if not filled by setRevisionTimestamp().
|
|
|
|
|
*
|
2014-04-10 18:50:10 +00:00
|
|
|
* @return string|null
|
2011-12-10 16:30:40 +00:00
|
|
|
*/
|
|
|
|
|
public function getRevisionTimestamp() {
|
|
|
|
|
return $this->mRevisionTimestamp;
|
|
|
|
|
}
|
|
|
|
|
|
2011-07-05 05:23:26 +00:00
|
|
|
/**
|
|
|
|
|
* Set the displayed file version
|
|
|
|
|
*
|
2014-04-08 15:29:17 +00:00
|
|
|
* @param File|bool $file
|
|
|
|
|
* @return mixed Previous value
|
2011-07-05 05:23:26 +00:00
|
|
|
*/
|
|
|
|
|
public function setFileVersion( $file ) {
|
2011-07-06 17:27:33 +00:00
|
|
|
$val = null;
|
2011-07-05 05:23:26 +00:00
|
|
|
if ( $file instanceof File && $file->exists() ) {
|
2016-02-17 09:09:32 +00:00
|
|
|
$val = [ 'time' => $file->getTimestamp(), 'sha1' => $file->getSha1() ];
|
2011-07-05 05:23:26 +00:00
|
|
|
}
|
2011-07-06 17:27:33 +00:00
|
|
|
return wfSetVar( $this->mFileVersion, $val, true );
|
2011-07-05 05:23:26 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Get the displayed file version
|
|
|
|
|
*
|
2014-04-10 18:50:10 +00:00
|
|
|
* @return array|null ('time' => MW timestamp, 'sha1' => sha1)
|
2011-07-05 05:23:26 +00:00
|
|
|
*/
|
|
|
|
|
public function getFileVersion() {
|
|
|
|
|
return $this->mFileVersion;
|
|
|
|
|
}
|
|
|
|
|
|
2011-04-03 05:53:07 +00:00
|
|
|
/**
|
|
|
|
|
* Get the templates used on this page
|
|
|
|
|
*
|
2014-04-10 18:50:10 +00:00
|
|
|
* @return array (namespace => dbKey => revId)
|
2011-04-04 01:22:08 +00:00
|
|
|
* @since 1.18
|
2011-04-03 05:53:07 +00:00
|
|
|
*/
|
|
|
|
|
public function getTemplateIds() {
|
|
|
|
|
return $this->mTemplateIds;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Get the files used on this page
|
|
|
|
|
*
|
2014-04-10 18:50:10 +00:00
|
|
|
* @return array (dbKey => array('time' => MW timestamp or null, 'sha1' => sha1 or ''))
|
2011-04-04 01:22:08 +00:00
|
|
|
* @since 1.18
|
2011-04-03 05:53:07 +00:00
|
|
|
*/
|
2011-09-14 19:05:43 +00:00
|
|
|
public function getFileSearchOptions() {
|
2011-04-03 05:53:07 +00:00
|
|
|
return $this->mImageTimeKeys;
|
|
|
|
|
}
|
|
|
|
|
|
2004-09-02 23:28:24 +00:00
|
|
|
/**
|
|
|
|
|
* Convert wikitext to HTML and add it to the buffer
|
2010-01-29 21:32:45 +00:00
|
|
|
* Default assumes that the current page title will be used.
|
2006-11-07 05:37:31 +00:00
|
|
|
*
|
2014-04-08 15:29:17 +00:00
|
|
|
* @param string $text
|
|
|
|
|
* @param bool $linestart Is this the start of a line?
|
|
|
|
|
* @param bool $interface Is this text in the user interface language?
|
2014-12-24 13:49:20 +00:00
|
|
|
* @throws MWException
|
2004-09-02 23:28:24 +00:00
|
|
|
*/
|
2011-09-11 21:07:17 +00:00
|
|
|
public function addWikiText( $text, $linestart = true, $interface = true ) {
|
2013-03-13 07:42:41 +00:00
|
|
|
$title = $this->getTitle(); // Work around E_STRICT
|
2013-01-18 18:50:38 +00:00
|
|
|
if ( !$title ) {
|
|
|
|
|
throw new MWException( 'Title is null' );
|
|
|
|
|
}
|
2011-09-10 20:05:13 +00:00
|
|
|
$this->addWikiTextTitle( $text, $title, $linestart, /*tidy*/false, $interface );
|
2005-05-21 17:26:42 +00:00
|
|
|
}
|
|
|
|
|
|
2010-01-29 21:32:45 +00:00
|
|
|
/**
|
|
|
|
|
* Add wikitext with a custom Title object
|
|
|
|
|
*
|
2014-04-08 15:29:17 +00:00
|
|
|
* @param string $text Wikitext
|
2017-08-11 00:23:16 +00:00
|
|
|
* @param Title &$title
|
2014-04-08 15:29:17 +00:00
|
|
|
* @param bool $linestart Is this the start of a line?
|
2010-01-29 21:32:45 +00:00
|
|
|
*/
|
|
|
|
|
public function addWikiTextWithTitle( $text, &$title, $linestart = true ) {
|
|
|
|
|
$this->addWikiTextTitle( $text, $title, $linestart );
|
2005-05-21 17:26:42 +00:00
|
|
|
}
|
2005-07-01 00:03:31 +00:00
|
|
|
|
2010-01-29 21:32:45 +00:00
|
|
|
/**
|
2011-09-28 22:08:08 +00:00
|
|
|
* Add wikitext with a custom Title object and tidy enabled.
|
2010-01-29 21:32:45 +00:00
|
|
|
*
|
2014-04-08 15:29:17 +00:00
|
|
|
* @param string $text Wikitext
|
2017-08-11 00:23:16 +00:00
|
|
|
* @param Title &$title
|
2014-04-08 15:29:17 +00:00
|
|
|
* @param bool $linestart Is this the start of a line?
|
2010-01-29 21:32:45 +00:00
|
|
|
*/
|
|
|
|
|
function addWikiTextTitleTidy( $text, &$title, $linestart = true ) {
|
2007-01-14 17:37:29 +00:00
|
|
|
$this->addWikiTextTitle( $text, $title, $linestart, true );
|
2007-01-10 23:32:38 +00:00
|
|
|
}
|
|
|
|
|
|
2010-01-29 21:32:45 +00:00
|
|
|
/**
|
|
|
|
|
* Add wikitext with tidy enabled
|
|
|
|
|
*
|
2014-04-08 15:29:17 +00:00
|
|
|
* @param string $text Wikitext
|
|
|
|
|
* @param bool $linestart Is this the start of a line?
|
2010-01-29 21:32:45 +00:00
|
|
|
*/
|
|
|
|
|
public function addWikiTextTidy( $text, $linestart = true ) {
|
|
|
|
|
$title = $this->getTitle();
|
2010-05-22 12:18:22 +00:00
|
|
|
$this->addWikiTextTitleTidy( $text, $title, $linestart );
|
2010-01-29 21:32:45 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Add wikitext with a custom Title object
|
|
|
|
|
*
|
2014-04-08 15:29:17 +00:00
|
|
|
* @param string $text Wikitext
|
|
|
|
|
* @param Title $title
|
|
|
|
|
* @param bool $linestart Is this the start of a line?
|
|
|
|
|
* @param bool $tidy Whether to use tidy
|
|
|
|
|
* @param bool $interface Whether it is an interface message
|
|
|
|
|
* (for example disables conversion)
|
2010-01-29 21:32:45 +00:00
|
|
|
*/
|
2014-05-11 01:54:15 +00:00
|
|
|
public function addWikiTextTitle( $text, Title $title, $linestart,
|
|
|
|
|
$tidy = false, $interface = false
|
|
|
|
|
) {
|
2005-12-04 18:27:59 +00:00
|
|
|
global $wgParser;
|
2007-01-10 23:32:38 +00:00
|
|
|
|
|
|
|
|
$popts = $this->parserOptions();
|
2008-04-16 13:46:16 +00:00
|
|
|
$oldTidy = $popts->setTidy( $tidy );
|
2013-08-31 16:36:02 +00:00
|
|
|
$popts->setInterfaceMessage( (bool)$interface );
|
2007-01-10 23:32:38 +00:00
|
|
|
|
2014-06-20 20:38:10 +00:00
|
|
|
$parserOutput = $wgParser->getFreshParser()->parse(
|
2010-05-22 12:18:22 +00:00
|
|
|
$text, $title, $popts,
|
|
|
|
|
$linestart, true, $this->mRevisionId
|
|
|
|
|
);
|
2008-04-14 07:45:50 +00:00
|
|
|
|
2007-09-11 18:22:37 +00:00
|
|
|
$popts->setTidy( $oldTidy );
|
2007-01-10 23:32:38 +00:00
|
|
|
|
2006-01-01 20:08:08 +00:00
|
|
|
$this->addParserOutput( $parserOutput );
|
|
|
|
|
}
|
|
|
|
|
|
2014-05-08 20:10:13 +00:00
|
|
|
/**
|
|
|
|
|
* Add all metadata associated with a ParserOutput object, but without the actual HTML. This
|
|
|
|
|
* includes categories, language links, ResourceLoader modules, effects of certain magic words,
|
|
|
|
|
* and so on.
|
|
|
|
|
*
|
|
|
|
|
* @since 1.24
|
|
|
|
|
* @param ParserOutput $parserOutput
|
|
|
|
|
*/
|
2014-08-23 16:20:51 +00:00
|
|
|
public function addParserOutputMetadata( $parserOutput ) {
|
2004-08-21 14:56:07 +00:00
|
|
|
$this->mLanguageLinks += $parserOutput->getLanguageLinks();
|
2005-12-30 09:33:11 +00:00
|
|
|
$this->addCategoryLinks( $parserOutput->getCategories() );
|
Implement page status indicators
Page status indicators are icons (or short text snippets) usually
displayed in the top-right corner of the page, outside of the main
content. Basically, <indicator name="foo">[[File:Foo.svg|20px]]</indicator>
may be used on a page to place the icon in the indicator area. They
are also known as top icons, page icons, heading icons or title icons.
I found the discussion on bug 23796 highly illuminating. I suggest
that everyone read it before suggesting different design choices.
I spent some time with a thesaurus pondering the name. "Emblems" and
"badges" were also considered, but the former has a much more limited
meaning and the latter is already taken by Wikidata, with a similar
but subtly different feature set. I am not aware of any naming
conflicts ;) besides new talk page message "indicator" (used by core
and Echo in some documents) and OOjs UI indicators (tiny icons like
the arrow on a dropdown form element), which shouldn't be confusing.
Potential use cases include:
* "Lock" indicators for page protection levels
* Featured/good article indicators
* Redirect shortcuts display ("WP:VPT")
* Links to help/manual for special pages
* Coordinates?… or globe icon for inline pop-up maps
Design features:
* Skin-customizable. Skins can fully control where and how indicators
are shown, or may just do <?php echo $this->getIndicators(); ?> to
output the default structure. By default they are not shown at all.
* Extension-customizable. Extensions can call ParserOutput::addIndicator()
to insert an indicator from one of the numerous parser hooks.
* Wiki-customizable. In addition to just using the parser functions,
on-wiki styles and scripts can use the provided classes and ids
(.mw-indicator, #mw-indicator-<name>) to customize their display.
Design limitations:
* Every indicator must have a unique identifier (name). It's not
possible to create arrays, or to have several indicators with the
same name. In case of duplicates, the latest occurrence of the
parser function wins.
* Indicators are displayed ordered by their names (and not occurrence
order). This ensures consistency across pages and provides a simple
means of ordering or grouping them.
* Indicators are not stored, tracked or accessible outside of
ParserOutput (in particular they're not in the page_props table).
They are intended to merely reflect the content or metadata that is
already present on the page, and not be data themselves. If you ever
think you need to list pages with a given status indicator, instead
figure out what it means and use the appropriate tracking category,
special page report, already existing page_prop, or other means.
Corresponding patch in Vector: I90a8ae15ac8275d084ea5f47b6b2684d5e6c7412.
I'll implement support in the other three skins included in the tarball
and document it on mediawiki.org after this is merged.
Bug: 23796
Change-Id: I2389ff9a5332a2b1d033eb75f0946e5241cfaaf4
2014-09-24 10:44:16 +00:00
|
|
|
$this->setIndicators( $parserOutput->getIndicators() );
|
2006-05-01 20:35:08 +00:00
|
|
|
$this->mNewSectionLink = $parserOutput->getNewSection();
|
2009-02-19 22:14:59 +00:00
|
|
|
$this->mHideNewSectionLink = $parserOutput->getHideNewSection();
|
2008-07-24 18:02:20 +00:00
|
|
|
|
2010-06-01 14:28:51 +00:00
|
|
|
if ( !$parserOutput->isCacheable() ) {
|
2005-05-28 11:09:22 +00:00
|
|
|
$this->enableClientCache( false );
|
|
|
|
|
}
|
2006-08-24 17:05:52 +00:00
|
|
|
$this->mNoGallery = $parserOutput->getNoGallery();
|
2010-01-16 13:07:58 +00:00
|
|
|
$this->mHeadItems = array_merge( $this->mHeadItems, $parserOutput->getHeadItems() );
|
2010-09-04 04:00:09 +00:00
|
|
|
$this->addModules( $parserOutput->getModules() );
|
2011-08-02 15:40:03 +00:00
|
|
|
$this->addModuleScripts( $parserOutput->getModuleScripts() );
|
|
|
|
|
$this->addModuleStyles( $parserOutput->getModuleStyles() );
|
2014-01-19 15:39:46 +00:00
|
|
|
$this->addJsConfigVars( $parserOutput->getJsConfigVars() );
|
2014-07-10 19:16:29 +00:00
|
|
|
$this->mPreventClickjacking = $this->mPreventClickjacking
|
|
|
|
|
|| $parserOutput->preventClickjacking();
|
2011-03-23 17:35:40 +00:00
|
|
|
|
|
|
|
|
// Template versioning...
|
|
|
|
|
foreach ( (array)$parserOutput->getTemplateIds() as $ns => $dbks ) {
|
2008-11-01 23:20:25 +00:00
|
|
|
if ( isset( $this->mTemplateIds[$ns] ) ) {
|
|
|
|
|
$this->mTemplateIds[$ns] = $dbks + $this->mTemplateIds[$ns];
|
|
|
|
|
} else {
|
|
|
|
|
$this->mTemplateIds[$ns] = $dbks;
|
|
|
|
|
}
|
|
|
|
|
}
|
2011-03-23 17:35:40 +00:00
|
|
|
// File versioning...
|
2011-09-14 19:05:43 +00:00
|
|
|
foreach ( (array)$parserOutput->getFileSearchOptions() as $dbk => $data ) {
|
2011-03-23 17:35:40 +00:00
|
|
|
$this->mImageTimeKeys[$dbk] = $data;
|
|
|
|
|
}
|
Basic integrated audio/video support, with Ogg implementation.
* JavaScript video player based loosely on Greg Maxwell's player
* Image page text snippet customisation
* Abstraction of transform parameters in the parser. Introduced Linker::makeImageLink2().
* Made canRender(), mustRender() depend on file, not just on handler. Moved width=0, height=0 checking to ImageHandler::canRender(), since audio streams have width=height=0 but should be rendered.
Also:
* Automatic upgrade for oldimage rows on image page view, allows media handler selection based on oi_*_mime
* oi_*_mime unconditionally referenced, REQUIRES SCHEMA UPGRADE
* Don't destroy file info for missing files on upgrade
* Simple, centralised extension message file handling
* Made MessageCache::loadAllMessages non-static, optimised for repeated-call case due to abuse in User.php
* Support for lightweight parser output hooks, with callback whitelist for security
* Moved Linker::formatSize() to Language, to join the new formatTimePeriod() and formatBitrate()
* Introduced MagicWordArray, regex capture trick requires that magic word IDs DO NOT CONTAIN HYPHENS.
2007-08-15 10:50:09 +00:00
|
|
|
|
2008-02-20 08:53:12 +00:00
|
|
|
// Hooks registered in the object
|
2014-08-23 08:52:41 +00:00
|
|
|
$parserOutputHooks = $this->getConfig()->get( 'ParserOutputHooks' );
|
Basic integrated audio/video support, with Ogg implementation.
* JavaScript video player based loosely on Greg Maxwell's player
* Image page text snippet customisation
* Abstraction of transform parameters in the parser. Introduced Linker::makeImageLink2().
* Made canRender(), mustRender() depend on file, not just on handler. Moved width=0, height=0 checking to ImageHandler::canRender(), since audio streams have width=height=0 but should be rendered.
Also:
* Automatic upgrade for oldimage rows on image page view, allows media handler selection based on oi_*_mime
* oi_*_mime unconditionally referenced, REQUIRES SCHEMA UPGRADE
* Don't destroy file info for missing files on upgrade
* Simple, centralised extension message file handling
* Made MessageCache::loadAllMessages non-static, optimised for repeated-call case due to abuse in User.php
* Support for lightweight parser output hooks, with callback whitelist for security
* Moved Linker::formatSize() to Language, to join the new formatTimePeriod() and formatBitrate()
* Introduced MagicWordArray, regex capture trick requires that magic word IDs DO NOT CONTAIN HYPHENS.
2007-08-15 10:50:09 +00:00
|
|
|
foreach ( $parserOutput->getOutputHooks() as $hookInfo ) {
|
|
|
|
|
list( $hookName, $data ) = $hookInfo;
|
2014-08-23 08:52:41 +00:00
|
|
|
if ( isset( $parserOutputHooks[$hookName] ) ) {
|
|
|
|
|
call_user_func( $parserOutputHooks[$hookName], $this, $parserOutput, $data );
|
Basic integrated audio/video support, with Ogg implementation.
* JavaScript video player based loosely on Greg Maxwell's player
* Image page text snippet customisation
* Abstraction of transform parameters in the parser. Introduced Linker::makeImageLink2().
* Made canRender(), mustRender() depend on file, not just on handler. Moved width=0, height=0 checking to ImageHandler::canRender(), since audio streams have width=height=0 but should be rendered.
Also:
* Automatic upgrade for oldimage rows on image page view, allows media handler selection based on oi_*_mime
* oi_*_mime unconditionally referenced, REQUIRES SCHEMA UPGRADE
* Don't destroy file info for missing files on upgrade
* Simple, centralised extension message file handling
* Made MessageCache::loadAllMessages non-static, optimised for repeated-call case due to abuse in User.php
* Support for lightweight parser output hooks, with callback whitelist for security
* Moved Linker::formatSize() to Language, to join the new formatTimePeriod() and formatBitrate()
* Introduced MagicWordArray, regex capture trick requires that magic word IDs DO NOT CONTAIN HYPHENS.
2007-08-15 10:50:09 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2016-11-10 20:29:27 +00:00
|
|
|
// Enable OOUI if requested via ParserOutput
|
2015-07-25 15:32:08 +00:00
|
|
|
if ( $parserOutput->getEnableOOUI() ) {
|
|
|
|
|
$this->enableOOUI();
|
|
|
|
|
}
|
|
|
|
|
|
2016-11-10 20:29:27 +00:00
|
|
|
// Include parser limit report
|
|
|
|
|
if ( !$this->limitReportJSData ) {
|
|
|
|
|
$this->limitReportJSData = $parserOutput->getLimitReportJSData();
|
|
|
|
|
}
|
|
|
|
|
|
2013-04-19 11:19:06 +00:00
|
|
|
// Link flags are ignored for now, but may in the future be
|
|
|
|
|
// used to mark individual language links.
|
2016-02-17 09:09:32 +00:00
|
|
|
$linkFlags = [];
|
2017-01-01 23:07:11 +00:00
|
|
|
// Avoid PHP 7.1 warning of passing $this by reference
|
|
|
|
|
$outputPage = $this;
|
2016-02-17 09:09:32 +00:00
|
|
|
Hooks::run( 'LanguageLinks', [ $this->getTitle(), &$this->mLanguageLinks, &$linkFlags ] );
|
2017-08-19 00:48:45 +00:00
|
|
|
Hooks::runWithoutAbort( 'OutputPageParserOutput', [ &$outputPage, $parserOutput ] );
|
2017-05-20 13:39:40 +00:00
|
|
|
|
|
|
|
|
// This check must be after 'OutputPageParserOutput' runs in addParserOutputMetadata
|
|
|
|
|
// so that extensions may modify ParserOutput to toggle TOC.
|
|
|
|
|
// This cannot be moved to addParserOutputText because that is not
|
|
|
|
|
// called by EditPage for Preview.
|
|
|
|
|
if ( $parserOutput->getTOCEnabled() && $parserOutput->getTOCHTML() ) {
|
|
|
|
|
$this->mEnableTOC = true;
|
|
|
|
|
}
|
2006-01-01 20:08:08 +00:00
|
|
|
}
|
2006-01-07 13:31:29 +00:00
|
|
|
|
2006-11-07 05:37:31 +00:00
|
|
|
/**
|
2014-05-08 20:10:13 +00:00
|
|
|
* Add the HTML and enhancements for it (like ResourceLoader modules) associated with a
|
|
|
|
|
* ParserOutput object, without any other metadata.
|
|
|
|
|
*
|
|
|
|
|
* @since 1.24
|
|
|
|
|
* @param ParserOutput $parserOutput
|
|
|
|
|
*/
|
2014-08-23 16:20:51 +00:00
|
|
|
public function addParserOutputContent( $parserOutput ) {
|
2014-05-08 20:10:13 +00:00
|
|
|
$this->addParserOutputText( $parserOutput );
|
|
|
|
|
|
|
|
|
|
$this->addModules( $parserOutput->getModules() );
|
|
|
|
|
$this->addModuleScripts( $parserOutput->getModuleScripts() );
|
|
|
|
|
$this->addModuleStyles( $parserOutput->getModuleStyles() );
|
|
|
|
|
|
|
|
|
|
$this->addJsConfigVars( $parserOutput->getJsConfigVars() );
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Add the HTML associated with a ParserOutput object, without any metadata.
|
|
|
|
|
*
|
|
|
|
|
* @since 1.24
|
|
|
|
|
* @param ParserOutput $parserOutput
|
|
|
|
|
*/
|
2014-08-23 16:20:51 +00:00
|
|
|
public function addParserOutputText( $parserOutput ) {
|
2014-05-08 20:10:13 +00:00
|
|
|
$text = $parserOutput->getText();
|
2017-01-01 23:07:11 +00:00
|
|
|
// Avoid PHP 7.1 warning of passing $this by reference
|
|
|
|
|
$outputPage = $this;
|
2017-08-19 00:48:45 +00:00
|
|
|
Hooks::runWithoutAbort( 'OutputPageBeforeHTML', [ &$outputPage, &$text ] );
|
2014-05-08 20:10:13 +00:00
|
|
|
$this->addHTML( $text );
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Add everything from a ParserOutput object.
|
2010-01-29 21:32:45 +00:00
|
|
|
*
|
2014-04-10 18:50:10 +00:00
|
|
|
* @param ParserOutput $parserOutput
|
2006-11-07 05:37:31 +00:00
|
|
|
*/
|
2014-08-23 16:20:51 +00:00
|
|
|
function addParserOutput( $parserOutput ) {
|
2014-05-08 20:10:13 +00:00
|
|
|
$this->addParserOutputMetadata( $parserOutput );
|
2014-03-11 20:00:02 +00:00
|
|
|
|
|
|
|
|
// Touch section edit links only if not previously disabled
|
|
|
|
|
if ( $parserOutput->getEditSectionTokens() ) {
|
|
|
|
|
$parserOutput->setEditSectionTokens( $this->mEnableSectionEditLinks );
|
|
|
|
|
}
|
2014-05-08 20:10:13 +00:00
|
|
|
|
|
|
|
|
$this->addParserOutputText( $parserOutput );
|
2005-07-01 00:03:31 +00:00
|
|
|
}
|
|
|
|
|
|
2004-11-25 06:04:16 +00:00
|
|
|
/**
|
|
|
|
|
* Add the output of a QuickTemplate to the output buffer
|
2006-11-07 05:37:31 +00:00
|
|
|
*
|
2017-08-11 00:23:16 +00:00
|
|
|
* @param QuickTemplate &$template
|
2004-11-25 06:04:16 +00:00
|
|
|
*/
|
2006-11-07 05:37:31 +00:00
|
|
|
public function addTemplate( &$template ) {
|
2013-11-21 07:47:39 +00:00
|
|
|
$this->addHTML( $template->getHTML() );
|
2004-11-25 06:04:16 +00:00
|
|
|
}
|
2004-11-29 11:26:24 +00:00
|
|
|
|
|
|
|
|
/**
|
2006-04-29 13:15:19 +00:00
|
|
|
* Parse wikitext and return the HTML.
|
2006-11-07 05:37:31 +00:00
|
|
|
*
|
2014-04-10 18:50:10 +00:00
|
|
|
* @param string $text
|
2014-04-08 15:29:17 +00:00
|
|
|
* @param bool $linestart Is this the start of a line?
|
|
|
|
|
* @param bool $interface Use interface language ($wgLang instead of
|
|
|
|
|
* $wgContLang) while parsing language sensitive magic words like GRAMMAR and PLURAL.
|
|
|
|
|
* This also disables LanguageConverter.
|
|
|
|
|
* @param Language $language Target language object, will override $interface
|
2012-10-07 23:35:26 +00:00
|
|
|
* @throws MWException
|
2014-04-08 15:29:17 +00:00
|
|
|
* @return string HTML
|
2004-11-29 11:26:24 +00:00
|
|
|
*/
|
2011-01-05 12:24:39 +00:00
|
|
|
public function parse( $text, $linestart = true, $interface = false, $language = null ) {
|
2009-04-09 02:22:36 +00:00
|
|
|
global $wgParser;
|
2011-01-05 12:24:39 +00:00
|
|
|
|
2013-04-17 14:52:47 +00:00
|
|
|
if ( is_null( $this->getTitle() ) ) {
|
2009-04-09 02:22:36 +00:00
|
|
|
throw new MWException( 'Empty $mTitle in ' . __METHOD__ );
|
2008-11-24 01:58:15 +00:00
|
|
|
}
|
2011-01-05 12:24:39 +00:00
|
|
|
|
2006-07-26 07:15:39 +00:00
|
|
|
$popts = $this->parserOptions();
|
2010-05-22 12:18:22 +00:00
|
|
|
if ( $interface ) {
|
|
|
|
|
$popts->setInterfaceMessage( true );
|
|
|
|
|
}
|
2011-01-05 12:24:39 +00:00
|
|
|
if ( $language !== null ) {
|
|
|
|
|
$oldLang = $popts->setTargetLanguage( $language );
|
|
|
|
|
}
|
|
|
|
|
|
2014-06-20 20:38:10 +00:00
|
|
|
$parserOutput = $wgParser->getFreshParser()->parse(
|
2010-05-22 12:18:22 +00:00
|
|
|
$text, $this->getTitle(), $popts,
|
|
|
|
|
$linestart, true, $this->mRevisionId
|
|
|
|
|
);
|
2011-01-05 12:24:39 +00:00
|
|
|
|
2010-05-22 12:18:22 +00:00
|
|
|
if ( $interface ) {
|
|
|
|
|
$popts->setInterfaceMessage( false );
|
|
|
|
|
}
|
2011-01-05 12:24:39 +00:00
|
|
|
if ( $language !== null ) {
|
|
|
|
|
$popts->setTargetLanguage( $oldLang );
|
|
|
|
|
}
|
|
|
|
|
|
2004-11-29 11:26:24 +00:00
|
|
|
return $parserOutput->getText();
|
|
|
|
|
}
|
2005-07-01 00:03:31 +00:00
|
|
|
|
2010-01-29 21:32:45 +00:00
|
|
|
/**
|
|
|
|
|
* Parse wikitext, strip paragraphs, and return the HTML.
|
|
|
|
|
*
|
2014-04-08 15:29:17 +00:00
|
|
|
* @param string $text
|
|
|
|
|
* @param bool $linestart Is this the start of a line?
|
|
|
|
|
* @param bool $interface Use interface language ($wgLang instead of
|
|
|
|
|
* $wgContLang) while parsing language sensitive magic
|
|
|
|
|
* words like GRAMMAR and PLURAL
|
|
|
|
|
* @return string HTML
|
2010-01-29 21:32:45 +00:00
|
|
|
*/
|
2009-01-31 01:59:13 +00:00
|
|
|
public function parseInline( $text, $linestart = true, $interface = false ) {
|
|
|
|
|
$parsed = $this->parse( $text, $linestart, $interface );
|
2014-02-22 15:21:36 +00:00
|
|
|
return Parser::stripOuterParagraph( $parsed );
|
2009-01-31 01:59:13 +00:00
|
|
|
}
|
|
|
|
|
|
2015-12-10 01:07:05 +00:00
|
|
|
/**
|
2017-08-11 15:46:31 +00:00
|
|
|
* @param int $maxage
|
2015-12-10 01:07:05 +00:00
|
|
|
* @deprecated since 1.27 Use setCdnMaxage() instead
|
|
|
|
|
*/
|
|
|
|
|
public function setSquidMaxage( $maxage ) {
|
|
|
|
|
$this->setCdnMaxage( $maxage );
|
|
|
|
|
}
|
|
|
|
|
|
2004-09-02 23:28:24 +00:00
|
|
|
/**
|
2010-01-29 21:32:45 +00:00
|
|
|
* Set the value of the "s-maxage" part of the "Cache-control" HTTP header
|
|
|
|
|
*
|
2015-12-10 01:07:05 +00:00
|
|
|
* @param int $maxage Maximum cache time on the CDN, in seconds.
|
2004-09-02 23:28:24 +00:00
|
|
|
*/
|
2015-12-10 01:07:05 +00:00
|
|
|
public function setCdnMaxage( $maxage ) {
|
|
|
|
|
$this->mCdnMaxage = min( $maxage, $this->mCdnMaxageLimit );
|
2015-10-01 07:24:18 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Lower the value of the "s-maxage" part of the "Cache-control" HTTP header
|
|
|
|
|
*
|
2015-12-10 01:07:05 +00:00
|
|
|
* @param int $maxage Maximum cache time on the CDN, in seconds
|
2015-10-01 07:24:18 +00:00
|
|
|
* @since 1.27
|
|
|
|
|
*/
|
|
|
|
|
public function lowerCdnMaxage( $maxage ) {
|
2015-10-10 03:55:47 +00:00
|
|
|
$this->mCdnMaxageLimit = min( $maxage, $this->mCdnMaxageLimit );
|
2015-12-10 01:07:05 +00:00
|
|
|
$this->setCdnMaxage( $this->mCdnMaxage );
|
2004-02-08 21:12:07 +00:00
|
|
|
}
|
2004-07-08 14:53:54 +00:00
|
|
|
|
2016-08-23 04:10:13 +00:00
|
|
|
/**
|
|
|
|
|
* Get TTL in [$minTTL,$maxTTL] in pass it to lowerCdnMaxage()
|
|
|
|
|
*
|
|
|
|
|
* This sets and returns $minTTL if $mtime is false or null. Otherwise,
|
|
|
|
|
* the TTL is higher the older the $mtime timestamp is. Essentially, the
|
|
|
|
|
* TTL is 90% of the age of the object, subject to the min and max.
|
|
|
|
|
*
|
2017-08-20 11:20:59 +00:00
|
|
|
* @param string|int|float|bool|null $mtime Last-Modified timestamp
|
|
|
|
|
* @param int $minTTL Mimimum TTL in seconds [default: 1 minute]
|
|
|
|
|
* @param int $maxTTL Maximum TTL in seconds [default: $wgSquidMaxage]
|
|
|
|
|
* @return int TTL in seconds
|
2016-08-23 04:10:13 +00:00
|
|
|
* @since 1.28
|
|
|
|
|
*/
|
|
|
|
|
public function adaptCdnTTL( $mtime, $minTTL = 0, $maxTTL = 0 ) {
|
|
|
|
|
$minTTL = $minTTL ?: IExpiringStore::TTL_MINUTE;
|
|
|
|
|
$maxTTL = $maxTTL ?: $this->getConfig()->get( 'SquidMaxage' );
|
|
|
|
|
|
|
|
|
|
if ( $mtime === null || $mtime === false ) {
|
|
|
|
|
return $minTTL; // entity does not exist
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
$age = time() - wfTimestamp( TS_UNIX, $mtime );
|
2017-09-10 19:11:37 +00:00
|
|
|
$adaptiveTTL = max( 0.9 * $age, $minTTL );
|
2016-08-23 04:10:13 +00:00
|
|
|
$adaptiveTTL = min( $adaptiveTTL, $maxTTL );
|
|
|
|
|
|
|
|
|
|
$this->lowerCdnMaxage( (int)$adaptiveTTL );
|
|
|
|
|
|
|
|
|
|
return $adaptiveTTL;
|
|
|
|
|
}
|
|
|
|
|
|
2004-09-02 23:28:24 +00:00
|
|
|
/**
|
|
|
|
|
* Use enableClientCache(false) to force it to send nocache headers
|
2010-01-29 21:32:45 +00:00
|
|
|
*
|
2014-04-10 18:50:10 +00:00
|
|
|
* @param bool $state
|
2011-05-21 19:07:24 +00:00
|
|
|
*
|
|
|
|
|
* @return bool
|
2004-09-02 23:28:24 +00:00
|
|
|
*/
|
2006-11-07 05:37:31 +00:00
|
|
|
public function enableClientCache( $state ) {
|
2004-03-23 10:19:31 +00:00
|
|
|
return wfSetVar( $this->mEnableClientCache, $state );
|
|
|
|
|
}
|
2004-07-08 14:53:54 +00:00
|
|
|
|
2010-01-29 21:32:45 +00:00
|
|
|
/**
|
|
|
|
|
* Get the list of cookies that will influence on the cache
|
|
|
|
|
*
|
2014-04-10 18:50:10 +00:00
|
|
|
* @return array
|
2010-01-29 21:32:45 +00:00
|
|
|
*/
|
2008-02-20 04:13:24 +00:00
|
|
|
function getCacheVaryCookies() {
|
2008-04-10 08:42:36 +00:00
|
|
|
static $cookies;
|
|
|
|
|
if ( $cookies === null ) {
|
2014-08-23 08:52:41 +00:00
|
|
|
$config = $this->getConfig();
|
2008-04-14 07:45:50 +00:00
|
|
|
$cookies = array_merge(
|
2016-02-01 20:44:03 +00:00
|
|
|
SessionManager::singleton()->getVaryCookies(),
|
2016-02-17 09:09:32 +00:00
|
|
|
[
|
2016-02-01 20:44:03 +00:00
|
|
|
'forceHTTPS',
|
2016-02-17 09:09:32 +00:00
|
|
|
],
|
2014-08-23 08:52:41 +00:00
|
|
|
$config->get( 'CacheVaryCookies' )
|
2008-04-10 08:42:36 +00:00
|
|
|
);
|
2016-02-17 09:09:32 +00:00
|
|
|
Hooks::run( 'GetCacheVaryCookies', [ $this, &$cookies ] );
|
2008-04-10 08:42:36 +00:00
|
|
|
}
|
|
|
|
|
return $cookies;
|
2008-02-20 04:13:24 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Check if the request has a cache-varying cookie header
|
|
|
|
|
* If it does, it's very important that we don't allow public caching
|
2010-01-29 21:32:45 +00:00
|
|
|
*
|
2014-04-10 18:50:10 +00:00
|
|
|
* @return bool
|
2008-02-20 04:13:24 +00:00
|
|
|
*/
|
|
|
|
|
function haveCacheVaryCookies() {
|
2015-10-06 07:01:10 +00:00
|
|
|
$request = $this->getRequest();
|
|
|
|
|
foreach ( $this->getCacheVaryCookies() as $cookieName ) {
|
2015-10-08 04:45:26 +00:00
|
|
|
if ( $request->getCookie( $cookieName, '', '' ) !== '' ) {
|
2010-05-22 12:18:22 +00:00
|
|
|
wfDebug( __METHOD__ . ": found $cookieName\n" );
|
2008-02-20 04:13:24 +00:00
|
|
|
return true;
|
|
|
|
|
}
|
|
|
|
|
}
|
2010-05-22 12:18:22 +00:00
|
|
|
wfDebug( __METHOD__ . ": no cache-varying cookies found\n" );
|
2008-02-20 04:13:24 +00:00
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
|
2010-01-29 21:32:45 +00:00
|
|
|
/**
|
|
|
|
|
* Add an HTTP header that will influence on the cache
|
|
|
|
|
*
|
2014-07-24 17:42:24 +00:00
|
|
|
* @param string $header Header name
|
2015-10-06 07:01:10 +00:00
|
|
|
* @param string[]|null $option Options for the Key header. See
|
|
|
|
|
* https://datatracker.ietf.org/doc/draft-fielding-http-key/
|
|
|
|
|
* for the list of valid options.
|
2010-01-29 21:32:45 +00:00
|
|
|
*/
|
2015-09-08 21:59:45 +00:00
|
|
|
public function addVaryHeader( $header, array $option = null ) {
|
2009-11-29 06:47:51 +00:00
|
|
|
if ( !array_key_exists( $header, $this->mVaryHeader ) ) {
|
2016-02-17 09:09:32 +00:00
|
|
|
$this->mVaryHeader[$header] = [];
|
2015-09-08 21:59:45 +00:00
|
|
|
}
|
|
|
|
|
if ( !is_array( $option ) ) {
|
2016-02-17 09:09:32 +00:00
|
|
|
$option = [];
|
2009-11-28 19:13:23 +00:00
|
|
|
}
|
2015-09-08 21:59:45 +00:00
|
|
|
$this->mVaryHeader[$header] = array_unique( array_merge( $this->mVaryHeader[$header], $option ) );
|
2009-11-28 19:13:23 +00:00
|
|
|
}
|
|
|
|
|
|
2012-06-01 10:23:53 +00:00
|
|
|
/**
|
|
|
|
|
* Return a Vary: header on which to vary caches. Based on the keys of $mVaryHeader,
|
|
|
|
|
* such as Accept-Encoding or Cookie
|
2012-08-08 08:42:17 +00:00
|
|
|
*
|
2014-04-10 18:50:10 +00:00
|
|
|
* @return string
|
2012-06-01 10:23:53 +00:00
|
|
|
*/
|
|
|
|
|
public function getVaryHeader() {
|
2016-01-31 20:43:00 +00:00
|
|
|
// If we vary on cookies, let's make sure it's always included here too.
|
|
|
|
|
if ( $this->getCacheVaryCookies() ) {
|
|
|
|
|
$this->addVaryHeader( 'Cookie' );
|
|
|
|
|
}
|
|
|
|
|
|
2016-02-01 20:44:03 +00:00
|
|
|
foreach ( SessionManager::singleton()->getVaryHeaders() as $header => $options ) {
|
|
|
|
|
$this->addVaryHeader( $header, $options );
|
|
|
|
|
}
|
2016-03-08 08:13:12 +00:00
|
|
|
return 'Vary: ' . implode( ', ', array_keys( $this->mVaryHeader ) );
|
2012-06-01 10:23:53 +00:00
|
|
|
}
|
|
|
|
|
|
2015-06-01 16:58:42 +00:00
|
|
|
/**
|
|
|
|
|
* Add an HTTP Link: header
|
|
|
|
|
*
|
|
|
|
|
* @param string $header Header value
|
|
|
|
|
*/
|
|
|
|
|
public function addLinkHeader( $header ) {
|
|
|
|
|
$this->mLinkHeader[] = $header;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Return a Link: header. Based on the values of $mLinkHeader.
|
|
|
|
|
*
|
|
|
|
|
* @return string
|
|
|
|
|
*/
|
|
|
|
|
public function getLinkHeader() {
|
|
|
|
|
if ( !$this->mLinkHeader ) {
|
|
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return 'Link: ' . implode( ',', $this->mLinkHeader );
|
|
|
|
|
}
|
|
|
|
|
|
2010-01-29 21:32:45 +00:00
|
|
|
/**
|
2015-10-06 07:01:10 +00:00
|
|
|
* Get a complete Key header
|
2010-01-29 21:32:45 +00:00
|
|
|
*
|
2014-04-10 18:50:10 +00:00
|
|
|
* @return string
|
2010-01-29 21:32:45 +00:00
|
|
|
*/
|
2015-10-06 07:01:10 +00:00
|
|
|
public function getKeyHeader() {
|
2008-02-20 04:13:24 +00:00
|
|
|
$cvCookies = $this->getCacheVaryCookies();
|
2010-05-22 11:47:56 +00:00
|
|
|
|
2016-02-17 09:09:32 +00:00
|
|
|
$cookiesOption = [];
|
2008-02-20 04:13:24 +00:00
|
|
|
foreach ( $cvCookies as $cookieName ) {
|
2015-10-06 07:01:10 +00:00
|
|
|
$cookiesOption[] = 'param=' . $cookieName;
|
2009-11-28 19:13:23 +00:00
|
|
|
}
|
2009-11-29 06:47:51 +00:00
|
|
|
$this->addVaryHeader( 'Cookie', $cookiesOption );
|
2010-05-22 11:47:56 +00:00
|
|
|
|
2016-02-01 20:44:03 +00:00
|
|
|
foreach ( SessionManager::singleton()->getVaryHeaders() as $header => $options ) {
|
|
|
|
|
$this->addVaryHeader( $header, $options );
|
|
|
|
|
}
|
|
|
|
|
|
2016-02-17 09:09:32 +00:00
|
|
|
$headers = [];
|
2013-04-17 14:52:47 +00:00
|
|
|
foreach ( $this->mVaryHeader as $header => $option ) {
|
2009-11-28 19:13:23 +00:00
|
|
|
$newheader = $header;
|
2012-06-05 22:58:54 +00:00
|
|
|
if ( is_array( $option ) && count( $option ) > 0 ) {
|
2009-11-28 19:13:23 +00:00
|
|
|
$newheader .= ';' . implode( ';', $option );
|
2010-05-22 12:18:22 +00:00
|
|
|
}
|
2009-11-28 19:13:23 +00:00
|
|
|
$headers[] = $newheader;
|
|
|
|
|
}
|
2015-10-06 07:01:10 +00:00
|
|
|
$key = 'Key: ' . implode( ',', $headers );
|
2010-05-22 11:47:56 +00:00
|
|
|
|
2015-10-06 07:01:10 +00:00
|
|
|
return $key;
|
2008-02-08 07:12:38 +00:00
|
|
|
}
|
|
|
|
|
|
2010-01-29 21:32:45 +00:00
|
|
|
/**
|
2015-10-06 07:01:10 +00:00
|
|
|
* T23672: Add Accept-Language to Vary and Key headers
|
2010-01-30 17:40:17 +00:00
|
|
|
* if there's no 'variant' parameter existed in GET.
|
2010-01-29 21:32:45 +00:00
|
|
|
*
|
|
|
|
|
* 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.
|
|
|
|
|
*/
|
2009-12-21 18:55:42 +00:00
|
|
|
function addAcceptLanguage() {
|
2014-06-11 20:00:24 +00:00
|
|
|
$title = $this->getTitle();
|
|
|
|
|
if ( !$title instanceof Title ) {
|
|
|
|
|
return;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
$lang = $title->getPageLanguage();
|
2013-04-17 14:52:47 +00:00
|
|
|
if ( !$this->getRequest()->getCheck( 'variant' ) && $lang->hasVariants() ) {
|
2011-09-22 20:31:23 +00:00
|
|
|
$variants = $lang->getVariants();
|
2016-02-17 09:09:32 +00:00
|
|
|
$aloption = [];
|
2009-12-21 18:55:42 +00:00
|
|
|
foreach ( $variants as $variant ) {
|
2013-04-17 14:52:47 +00:00
|
|
|
if ( $variant === $lang->getCode() ) {
|
2009-12-21 18:55:42 +00:00
|
|
|
continue;
|
2010-05-22 12:18:22 +00:00
|
|
|
} else {
|
2015-10-06 07:01:10 +00:00
|
|
|
$aloption[] = 'substr=' . $variant;
|
2011-01-13 22:08:13 +00:00
|
|
|
|
2012-11-17 20:00:12 +00:00
|
|
|
// IE and some other browsers use BCP 47 standards in
|
|
|
|
|
// their Accept-Language header, like "zh-CN" or "zh-Hant".
|
2010-10-28 16:58:39 +00:00
|
|
|
// We should handle these too.
|
2012-11-17 20:00:12 +00:00
|
|
|
$variantBCP47 = wfBCP47( $variant );
|
|
|
|
|
if ( $variantBCP47 !== $variant ) {
|
2015-10-06 07:01:10 +00:00
|
|
|
$aloption[] = 'substr=' . $variantBCP47;
|
2010-10-28 16:58:39 +00:00
|
|
|
}
|
2010-05-22 12:18:22 +00:00
|
|
|
}
|
2009-12-21 18:55:42 +00:00
|
|
|
}
|
|
|
|
|
$this->addVaryHeader( 'Accept-Language', $aloption );
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2011-01-04 06:12:33 +00:00
|
|
|
/**
|
2011-04-23 19:28:35 +00:00
|
|
|
* Set a flag which will cause an X-Frame-Options header appropriate for
|
|
|
|
|
* edit pages to be sent. The header value is controlled by
|
2011-01-04 06:12:33 +00:00
|
|
|
* $wgEditPageFrameOptions.
|
|
|
|
|
*
|
2011-04-23 19:28:35 +00:00
|
|
|
* This is the default for special pages. If you display a CSRF-protected
|
2011-01-04 06:12:33 +00:00
|
|
|
* form on an ordinary view page, then you need to call this function.
|
2011-05-21 19:07:24 +00:00
|
|
|
*
|
2014-04-10 18:50:10 +00:00
|
|
|
* @param bool $enable
|
2011-01-04 06:12:33 +00:00
|
|
|
*/
|
|
|
|
|
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;
|
|
|
|
|
}
|
|
|
|
|
|
2014-07-10 19:16:29 +00:00
|
|
|
/**
|
|
|
|
|
* Get the prevent-clickjacking flag
|
|
|
|
|
*
|
|
|
|
|
* @since 1.24
|
2014-08-04 10:00:15 +00:00
|
|
|
* @return bool
|
2014-07-10 19:16:29 +00:00
|
|
|
*/
|
|
|
|
|
public function getPreventClickjacking() {
|
|
|
|
|
return $this->mPreventClickjacking;
|
|
|
|
|
}
|
|
|
|
|
|
2011-01-04 06:12:33 +00:00
|
|
|
/**
|
2011-04-23 19:28:35 +00:00
|
|
|
* 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
|
2011-01-04 06:12:33 +00:00
|
|
|
* JavaScript frame-breaking, for clients that don't support X-Frame-Options.
|
2011-05-21 19:07:24 +00:00
|
|
|
*
|
2016-12-08 05:04:53 +00:00
|
|
|
* @return string|false
|
2011-01-04 06:12:33 +00:00
|
|
|
*/
|
|
|
|
|
public function getFrameOptions() {
|
2014-08-23 08:52:41 +00:00
|
|
|
$config = $this->getConfig();
|
|
|
|
|
if ( $config->get( 'BreakFrames' ) ) {
|
2011-01-04 06:12:33 +00:00
|
|
|
return 'DENY';
|
2014-08-23 08:52:41 +00:00
|
|
|
} elseif ( $this->mPreventClickjacking && $config->get( 'EditPageFrameOptions' ) ) {
|
|
|
|
|
return $config->get( 'EditPageFrameOptions' );
|
2011-01-04 06:12:33 +00:00
|
|
|
}
|
2011-10-16 03:27:12 +00:00
|
|
|
return false;
|
2011-01-04 06:12:33 +00:00
|
|
|
}
|
|
|
|
|
|
2010-01-29 21:32:45 +00:00
|
|
|
/**
|
|
|
|
|
* Send cache control HTTP headers
|
|
|
|
|
*/
|
2006-11-07 05:37:31 +00:00
|
|
|
public function sendCacheControl() {
|
2011-04-03 12:46:36 +00:00
|
|
|
$response = $this->getRequest()->response();
|
2014-08-23 08:52:41 +00:00
|
|
|
$config = $this->getConfig();
|
2008-12-23 19:39:00 +00:00
|
|
|
|
2012-06-01 10:23:53 +00:00
|
|
|
$this->addVaryHeader( 'Cookie' );
|
2009-12-21 18:55:42 +00:00
|
|
|
$this->addAcceptLanguage();
|
|
|
|
|
|
2008-12-23 19:39:00 +00:00
|
|
|
# don't serve compressed data to clients who can't handle it
|
2005-03-08 02:58:43 +00:00
|
|
|
# maintain different caches for logged-in users and non-logged in ones
|
2012-06-01 10:23:53 +00:00
|
|
|
$response->header( $this->getVaryHeader() );
|
2008-02-08 07:12:38 +00:00
|
|
|
|
2015-10-06 07:01:10 +00:00
|
|
|
if ( $config->get( 'UseKeyHeader' ) ) {
|
|
|
|
|
$response->header( $this->getKeyHeader() );
|
2009-07-24 20:01:23 +00:00
|
|
|
}
|
2008-02-08 07:12:38 +00:00
|
|
|
|
2013-04-17 14:52:47 +00:00
|
|
|
if ( $this->mEnableClientCache ) {
|
|
|
|
|
if (
|
2016-02-24 06:03:17 +00:00
|
|
|
$config->get( 'UseSquid' ) &&
|
|
|
|
|
!$response->hasCookies() &&
|
|
|
|
|
!SessionManager::getGlobalSession()->isPersistent() &&
|
|
|
|
|
!$this->isPrintable() &&
|
|
|
|
|
$this->mCdnMaxage != 0 &&
|
|
|
|
|
!$this->haveCacheVaryCookies()
|
2013-04-17 14:52:47 +00:00
|
|
|
) {
|
2014-08-23 08:52:41 +00:00
|
|
|
if ( $config->get( 'UseESI' ) ) {
|
2004-02-02 01:40:03 +00:00
|
|
|
# We'll purge the proxy cache explicitly, but require end user agents
|
2004-01-31 12:45:09 +00:00
|
|
|
# to revalidate against the proxy on each visit.
|
2015-12-10 01:30:47 +00:00
|
|
|
# Surrogate-Control controls our CDN, Cache-Control downstream caches
|
2016-11-03 20:06:59 +00:00
|
|
|
wfDebug( __METHOD__ .
|
|
|
|
|
": proxy caching with ESI; {$this->mLastModified} **", 'private' );
|
2004-01-31 12:45:09 +00:00
|
|
|
# start with a shorter timeout for initial testing
|
|
|
|
|
# header( 'Surrogate-Control: max-age=2678400+2678400, content="ESI/1.0"');
|
2016-11-03 20:06:59 +00:00
|
|
|
$response->header(
|
|
|
|
|
"Surrogate-Control: max-age={$config->get( 'SquidMaxage' )}" .
|
|
|
|
|
"+{$this->mCdnMaxage}, content=\"ESI/1.0\""
|
|
|
|
|
);
|
2008-02-08 07:12:38 +00:00
|
|
|
$response->header( 'Cache-Control: s-maxage=0, must-revalidate, max-age=0' );
|
2004-01-31 12:45:09 +00:00
|
|
|
} else {
|
|
|
|
|
# We'll purge the proxy cache for anons explicitly, but require end user agents
|
|
|
|
|
# to revalidate against the proxy on each visit.
|
2015-12-10 01:30:47 +00:00
|
|
|
# IMPORTANT! The CDN needs to replace the Cache-Control header with
|
2004-01-31 12:45:09 +00:00
|
|
|
# Cache-Control: s-maxage=0, must-revalidate, max-age=0
|
2016-11-03 20:06:59 +00:00
|
|
|
wfDebug( __METHOD__ .
|
|
|
|
|
": local proxy caching; {$this->mLastModified} **", 'private' );
|
2004-01-31 12:45:09 +00:00
|
|
|
# start with a shorter timeout for initial testing
|
|
|
|
|
# header( "Cache-Control: s-maxage=2678400, must-revalidate, max-age=0" );
|
2016-11-03 20:06:59 +00:00
|
|
|
$response->header( "Cache-Control: " .
|
|
|
|
|
"s-maxage={$this->mCdnMaxage}, must-revalidate, max-age=0" );
|
2004-01-31 12:45:09 +00:00
|
|
|
}
|
2004-01-31 10:29:31 +00:00
|
|
|
} else {
|
|
|
|
|
# We do want clients to cache if they can, but they *must* check for updates
|
|
|
|
|
# on revisiting the page.
|
2015-12-30 19:48:01 +00:00
|
|
|
wfDebug( __METHOD__ . ": private caching; {$this->mLastModified} **", 'private' );
|
2008-02-08 07:12:38 +00:00
|
|
|
$response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
|
|
|
|
|
$response->header( "Cache-Control: private, must-revalidate, max-age=0" );
|
2004-01-31 10:29:31 +00:00
|
|
|
}
|
2013-04-17 14:52:47 +00:00
|
|
|
if ( $this->mLastModified ) {
|
2008-08-29 08:40:13 +00:00
|
|
|
$response->header( "Last-Modified: {$this->mLastModified}" );
|
|
|
|
|
}
|
2003-07-03 10:18:07 +00:00
|
|
|
} else {
|
2015-12-30 19:48:01 +00:00
|
|
|
wfDebug( __METHOD__ . ": no caching **", 'private' );
|
2004-03-23 10:19:31 +00:00
|
|
|
|
|
|
|
|
# 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.
|
2008-02-08 07:12:38 +00:00
|
|
|
$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' );
|
2003-07-03 10:18:07 +00:00
|
|
|
}
|
|
|
|
|
}
|
2004-07-08 14:53:54 +00:00
|
|
|
|
2004-09-02 23:28:24 +00:00
|
|
|
/**
|
|
|
|
|
* Finally, all the text has been munged and accumulated into
|
|
|
|
|
* the object, let's actually output it:
|
2016-08-24 21:22:11 +00:00
|
|
|
*
|
|
|
|
|
* @param bool $return Set to true to get the result as a string rather than sending it
|
|
|
|
|
* @return string|null
|
|
|
|
|
* @throws Exception
|
|
|
|
|
* @throws FatalError
|
|
|
|
|
* @throws MWException
|
2004-09-02 23:28:24 +00:00
|
|
|
*/
|
2016-08-24 21:22:11 +00:00
|
|
|
public function output( $return = false ) {
|
2016-10-04 15:40:35 +00:00
|
|
|
global $wgContLang;
|
|
|
|
|
|
2013-04-17 14:52:47 +00:00
|
|
|
if ( $this->mDoNothing ) {
|
2016-08-24 21:22:11 +00:00
|
|
|
return $return ? '' : null;
|
2008-12-31 17:56:04 +00:00
|
|
|
}
|
2011-04-02 18:38:42 +00:00
|
|
|
|
2011-04-03 12:46:36 +00:00
|
|
|
$response = $this->getRequest()->response();
|
2014-08-23 08:52:41 +00:00
|
|
|
$config = $this->getConfig();
|
2011-04-02 18:38:42 +00:00
|
|
|
|
2010-01-06 19:59:42 +00:00
|
|
|
if ( $this->mRedirect != '' ) {
|
2008-02-13 05:59:14 +00:00
|
|
|
# Standards require redirect URLs to be absolute
|
2011-08-19 15:46:08 +00:00
|
|
|
$this->mRedirect = wfExpandUrl( $this->mRedirect, PROTO_CURRENT );
|
2011-12-14 00:38:21 +00:00
|
|
|
|
|
|
|
|
$redirect = $this->mRedirect;
|
|
|
|
|
$code = $this->mRedirectCode;
|
|
|
|
|
|
2016-02-17 09:09:32 +00:00
|
|
|
if ( Hooks::run( "BeforePageRedirect", [ $this, &$redirect, &$code ] ) ) {
|
2013-04-17 14:52:47 +00:00
|
|
|
if ( $code == '301' || $code == '303' ) {
|
2014-08-23 08:52:41 +00:00
|
|
|
if ( !$config->get( 'DebugRedirects' ) ) {
|
2015-05-24 12:31:11 +00:00
|
|
|
$response->statusHeader( $code );
|
2011-12-14 00:38:21 +00:00
|
|
|
}
|
|
|
|
|
$this->mLastModified = wfTimestamp( TS_RFC2822 );
|
|
|
|
|
}
|
2014-08-23 08:52:41 +00:00
|
|
|
if ( $config->get( 'VaryOnXFP' ) ) {
|
2011-12-14 00:38:21 +00:00
|
|
|
$this->addVaryHeader( 'X-Forwarded-Proto' );
|
|
|
|
|
}
|
|
|
|
|
$this->sendCacheControl();
|
|
|
|
|
|
|
|
|
|
$response->header( "Content-Type: text/html; charset=utf-8" );
|
2014-08-23 08:52:41 +00:00
|
|
|
if ( $config->get( 'DebugRedirects' ) ) {
|
2011-12-14 00:38:21 +00:00
|
|
|
$url = htmlspecialchars( $redirect );
|
2016-09-25 15:34:47 +00:00
|
|
|
print "<!DOCTYPE html>\n<html>\n<head>\n<title>Redirect</title>\n</head>\n<body>\n";
|
2011-12-14 00:38:21 +00:00
|
|
|
print "<p>Location: <a href=\"$url\">$url</a></p>\n";
|
|
|
|
|
print "</body>\n</html>\n";
|
|
|
|
|
} else {
|
|
|
|
|
$response->header( 'Location: ' . $redirect );
|
2004-03-05 03:18:31 +00:00
|
|
|
}
|
|
|
|
|
}
|
2011-12-14 00:38:21 +00:00
|
|
|
|
2016-08-24 21:22:11 +00:00
|
|
|
return $return ? '' : null;
|
2009-12-01 20:56:43 +00:00
|
|
|
} elseif ( $this->mStatusCode ) {
|
2015-05-24 12:31:11 +00:00
|
|
|
$response->statusHeader( $this->mStatusCode );
|
2008-10-10 01:15:11 +00:00
|
|
|
}
|
2010-05-22 11:47:56 +00:00
|
|
|
|
2004-11-12 09:34:11 +00:00
|
|
|
# Buffer output; final headers may depend on later processing
|
2008-09-15 01:27:22 +00:00
|
|
|
ob_start();
|
2004-11-12 09:34:11 +00:00
|
|
|
|
2014-08-23 08:52:41 +00:00
|
|
|
$response->header( 'Content-type: ' . $config->get( 'MimeType' ) . '; charset=UTF-8' );
|
2016-10-04 15:40:35 +00:00
|
|
|
$response->header( 'Content-language: ' . $wgContLang->getHtmlCode() );
|
2003-04-14 23:10:40 +00:00
|
|
|
|
2014-04-21 22:46:56 +00:00
|
|
|
// Avoid Internet Explorer "compatibility view" in IE 8-10, so that
|
|
|
|
|
// jQuery etc. can work correctly.
|
|
|
|
|
$response->header( 'X-UA-Compatible: IE=Edge' );
|
|
|
|
|
|
2017-05-02 12:58:06 +00:00
|
|
|
if ( !$this->mArticleBodyOnly ) {
|
|
|
|
|
$sk = $this->getSkin();
|
|
|
|
|
|
|
|
|
|
if ( $sk->shouldPreloadLogo() ) {
|
|
|
|
|
$this->addLogoPreloadLinkHeaders();
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2015-06-01 16:58:42 +00:00
|
|
|
$linkHeader = $this->getLinkHeader();
|
|
|
|
|
if ( $linkHeader ) {
|
|
|
|
|
$response->header( $linkHeader );
|
|
|
|
|
}
|
|
|
|
|
|
2011-01-04 06:12:33 +00:00
|
|
|
// Prevent framing, if requested
|
|
|
|
|
$frameOptions = $this->getFrameOptions();
|
|
|
|
|
if ( $frameOptions ) {
|
2011-04-02 18:38:42 +00:00
|
|
|
$response->header( "X-Frame-Options: $frameOptions" );
|
2011-01-04 06:12:33 +00:00
|
|
|
}
|
|
|
|
|
|
2010-05-22 12:18:22 +00:00
|
|
|
if ( $this->mArticleBodyOnly ) {
|
2013-05-12 09:00:16 +00:00
|
|
|
echo $this->mBodytext;
|
2005-07-03 04:00:33 +00:00
|
|
|
} else {
|
2017-03-29 21:01:11 +00:00
|
|
|
// Enable safe mode if requested
|
|
|
|
|
if ( $this->getRequest()->getBool( 'safemode' ) ) {
|
|
|
|
|
$this->disallowUserJs();
|
|
|
|
|
}
|
|
|
|
|
|
2011-06-22 18:24:58 +00:00
|
|
|
$sk = $this->getSkin();
|
2017-05-20 13:07:37 +00:00
|
|
|
foreach ( $sk->getDefaultModules() as $group ) {
|
2013-05-13 22:09:33 +00:00
|
|
|
$this->addModules( $group );
|
|
|
|
|
}
|
2017-05-20 13:07:37 +00:00
|
|
|
|
2013-05-13 22:09:33 +00:00
|
|
|
MWDebug::addModules( $this );
|
2011-03-11 14:31:12 +00:00
|
|
|
|
2017-01-01 23:07:11 +00:00
|
|
|
// Avoid PHP 7.1 warning of passing $this by reference
|
|
|
|
|
$outputPage = $this;
|
2008-04-06 20:25:45 +00:00
|
|
|
// Hook that allows last minute changes to the output page, e.g.
|
|
|
|
|
// adding of CSS or Javascript by extensions.
|
2017-08-19 00:48:45 +00:00
|
|
|
Hooks::runWithoutAbort( 'BeforePageDisplay', [ &$outputPage, &$sk ] );
|
2008-04-06 20:25:45 +00:00
|
|
|
|
2016-03-18 19:11:45 +00:00
|
|
|
try {
|
|
|
|
|
$sk->outputPage();
|
|
|
|
|
} catch ( Exception $e ) {
|
|
|
|
|
ob_end_clean(); // bug T129657
|
|
|
|
|
throw $e;
|
|
|
|
|
}
|
2005-07-03 04:00:33 +00:00
|
|
|
}
|
2005-07-01 00:03:31 +00:00
|
|
|
|
2016-03-18 19:11:45 +00:00
|
|
|
try {
|
|
|
|
|
// This hook allows last minute changes to final overall output by modifying output buffer
|
2017-08-19 00:48:45 +00:00
|
|
|
Hooks::runWithoutAbort( 'AfterFinalPageOutput', [ $this ] );
|
2016-03-18 19:11:45 +00:00
|
|
|
} catch ( Exception $e ) {
|
|
|
|
|
ob_end_clean(); // bug T129657
|
|
|
|
|
throw $e;
|
|
|
|
|
}
|
2012-07-05 14:21:21 +00:00
|
|
|
|
2004-11-12 09:34:11 +00:00
|
|
|
$this->sendCacheControl();
|
2012-07-04 21:23:56 +00:00
|
|
|
|
2016-08-24 21:22:11 +00:00
|
|
|
if ( $return ) {
|
|
|
|
|
return ob_get_clean();
|
|
|
|
|
} else {
|
|
|
|
|
ob_end_flush();
|
|
|
|
|
return null;
|
|
|
|
|
}
|
2003-04-14 23:10:40 +00:00
|
|
|
}
|
|
|
|
|
|
2011-10-28 15:45:54 +00:00
|
|
|
/**
|
|
|
|
|
* Prepare this object to display an error page; disable caching and
|
|
|
|
|
* indexing, clear the current text and redirect, set the page's title
|
2012-07-10 12:48:06 +00:00
|
|
|
* and optionally an custom HTML title (content of the "<title>" tag).
|
2011-10-28 15:45:54 +00:00
|
|
|
*
|
2014-07-24 17:42:24 +00:00
|
|
|
* @param string|Message $pageTitle Will be passed directly to setPageTitle()
|
|
|
|
|
* @param string|Message $htmlTitle Will be passed directly to setHTMLTitle();
|
2012-07-10 12:48:06 +00:00
|
|
|
* optional, if not passed the "<title>" attribute will be
|
2011-10-28 15:45:54 +00:00
|
|
|
* 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 = '';
|
2011-11-08 18:02:26 +00:00
|
|
|
$this->clearSubtitle();
|
2011-10-28 15:45:54 +00:00
|
|
|
$this->clearHTML();
|
|
|
|
|
}
|
|
|
|
|
|
2004-09-02 23:28:24 +00:00
|
|
|
/**
|
2007-05-18 20:46:42 +00:00
|
|
|
* Output a standard error page
|
2006-11-07 05:37:31 +00:00
|
|
|
*
|
2014-01-29 15:30:40 +00:00
|
|
|
* showErrorPage( 'titlemsg', 'pagetextmsg' );
|
2016-09-27 03:15:08 +00:00
|
|
|
* showErrorPage( 'titlemsg', 'pagetextmsg', [ 'param1', 'param2' ] );
|
2011-08-25 10:13:30 +00:00
|
|
|
* showErrorPage( 'titlemsg', $messageObject );
|
2014-01-29 15:30:40 +00:00
|
|
|
* showErrorPage( $titleMessageObject, $messageObject );
|
2011-08-31 14:47:08 +00:00
|
|
|
*
|
2014-04-08 15:29:17 +00:00
|
|
|
* @param string|Message $title Message key (string) for page title, or a Message object
|
|
|
|
|
* @param string|Message $msg Message key (string) for page text, or a Message object
|
|
|
|
|
* @param array $params Message parameters; ignored if $msg is a Message object
|
2004-09-02 23:28:24 +00:00
|
|
|
*/
|
2016-02-17 09:09:32 +00:00
|
|
|
public function showErrorPage( $title, $msg, $params = [] ) {
|
2013-04-17 14:52:47 +00:00
|
|
|
if ( !$title instanceof Message ) {
|
2012-08-06 21:07:24 +00:00
|
|
|
$title = $this->msg( $title );
|
|
|
|
|
}
|
|
|
|
|
|
2012-08-18 23:17:57 +00:00
|
|
|
$this->prepareErrorPage( $title );
|
2008-04-14 07:45:50 +00:00
|
|
|
|
2013-01-26 18:32:03 +00:00
|
|
|
if ( $msg instanceof Message ) {
|
2016-02-17 09:09:32 +00:00
|
|
|
if ( $params !== [] ) {
|
2014-05-11 01:54:15 +00:00
|
|
|
trigger_error( 'Argument ignored: $params. The message parameters argument '
|
|
|
|
|
. 'is discarded when the $msg argument is a Message object instead of '
|
|
|
|
|
. 'a string.', E_USER_NOTICE );
|
2014-01-29 15:31:03 +00:00
|
|
|
}
|
2012-10-06 15:28:09 +00:00
|
|
|
$this->addHTML( $msg->parseAsBlock() );
|
2011-08-25 10:13:30 +00:00
|
|
|
} else {
|
2011-08-25 10:56:46 +00:00
|
|
|
$this->addWikiMsgArray( $msg, $params );
|
2011-08-25 10:13:30 +00:00
|
|
|
}
|
2008-04-14 07:45:50 +00:00
|
|
|
|
2008-04-16 13:46:16 +00:00
|
|
|
$this->returnToMain();
|
2003-04-14 23:10:40 +00:00
|
|
|
}
|
|
|
|
|
|
2007-08-06 11:30:40 +00:00
|
|
|
/**
|
|
|
|
|
* Output a standard permission error page
|
|
|
|
|
*
|
2016-10-14 22:59:11 +00:00
|
|
|
* @param array $errors Error message keys or [key, param...] arrays
|
2014-07-24 17:42:24 +00:00
|
|
|
* @param string $action Action that was denied or null if unknown
|
2007-08-06 11:30:40 +00:00
|
|
|
*/
|
2014-07-23 02:49:30 +00:00
|
|
|
public function showPermissionsErrorPage( array $errors, $action = null ) {
|
2016-10-14 22:59:11 +00:00
|
|
|
foreach ( $errors as $key => $error ) {
|
|
|
|
|
$errors[$key] = (array)$error;
|
|
|
|
|
}
|
|
|
|
|
|
2011-11-05 19:51:05 +00:00
|
|
|
// 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
|
2016-02-17 09:09:32 +00:00
|
|
|
if ( in_array( $action, [ 'read', 'edit', 'createpage', 'createtalk', 'upload' ] )
|
2011-11-05 19:51:05 +00:00
|
|
|
&& $this->getUser()->isAnon() && count( $errors ) == 1 && isset( $errors[0][0] )
|
|
|
|
|
&& ( $errors[0][0] == 'badaccess-groups' || $errors[0][0] == 'badaccess-group0' )
|
2012-10-04 16:17:46 +00:00
|
|
|
&& ( User::groupHasPermission( 'user', $action )
|
|
|
|
|
|| User::groupHasPermission( 'autoconfirmed', $action ) )
|
2011-11-05 19:51:05 +00:00
|
|
|
) {
|
|
|
|
|
$displayReturnto = null;
|
2011-11-28 23:18:55 +00:00
|
|
|
|
2017-02-20 22:44:19 +00:00
|
|
|
# Due to T34276, if a user does not have read permissions,
|
2011-11-29 21:04:20 +00:00
|
|
|
# $this->getTitle() will just give Special:Badtitle, which is
|
|
|
|
|
# not especially useful as a returnto parameter. Use the title
|
2011-11-28 23:18:55 +00:00
|
|
|
# from the request instead, if there was one.
|
|
|
|
|
$request = $this->getRequest();
|
2015-12-11 21:50:55 +00:00
|
|
|
$returnto = Title::newFromText( $request->getVal( 'title', '' ) );
|
2011-11-05 19:51:05 +00:00
|
|
|
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();
|
|
|
|
|
}
|
|
|
|
|
|
2016-02-17 09:09:32 +00:00
|
|
|
$query = [];
|
2011-11-28 23:18:55 +00:00
|
|
|
|
2011-11-05 19:51:05 +00:00
|
|
|
if ( $returnto ) {
|
|
|
|
|
$query['returnto'] = $returnto->getPrefixedText();
|
2011-11-28 23:18:55 +00:00
|
|
|
|
2011-11-05 19:51:05 +00:00
|
|
|
if ( !$request->wasPosted() ) {
|
|
|
|
|
$returntoquery = $request->getValues();
|
|
|
|
|
unset( $returntoquery['title'] );
|
|
|
|
|
unset( $returntoquery['returnto'] );
|
|
|
|
|
unset( $returntoquery['returntoquery'] );
|
2013-01-28 18:04:20 +00:00
|
|
|
$query['returntoquery'] = wfArrayToCgi( $returntoquery );
|
2011-11-05 19:51:05 +00:00
|
|
|
}
|
|
|
|
|
}
|
2017-01-18 20:55:20 +00:00
|
|
|
$linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
|
|
|
|
|
$loginLink = $linkRenderer->makeKnownLink(
|
2011-11-05 19:51:05 +00:00
|
|
|
SpecialPage::getTitleFor( 'Userlogin' ),
|
2017-01-18 20:55:20 +00:00
|
|
|
$this->msg( 'loginreqlink' )->text(),
|
2016-02-17 09:09:32 +00:00
|
|
|
[],
|
2011-11-05 19:51:05 +00:00
|
|
|
$query
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
$this->prepareErrorPage( $this->msg( 'loginreqtitle' ) );
|
|
|
|
|
$this->addHTML( $this->msg( $msg )->rawParams( $loginLink )->parse() );
|
2011-10-28 15:45:54 +00:00
|
|
|
|
2011-11-05 19:51:05 +00:00
|
|
|
# Don't return to a page the user can't read otherwise
|
|
|
|
|
# we'll end up in a pointless loop
|
2011-12-19 16:10:06 +00:00
|
|
|
if ( $displayReturnto && $displayReturnto->userCan( 'read', $this->getUser() ) ) {
|
2011-11-05 19:51:05 +00:00
|
|
|
$this->returnToMain( null, $displayReturnto );
|
|
|
|
|
}
|
|
|
|
|
} else {
|
|
|
|
|
$this->prepareErrorPage( $this->msg( 'permissionserrors' ) );
|
|
|
|
|
$this->addWikiText( $this->formatPermissionsErrorMessage( $errors, $action ) );
|
|
|
|
|
}
|
2007-08-01 10:19:26 +00:00
|
|
|
}
|
|
|
|
|
|
2005-06-26 06:49:56 +00:00
|
|
|
/**
|
|
|
|
|
* Display an error page indicating that a given version of MediaWiki is
|
|
|
|
|
* required to use it
|
|
|
|
|
*
|
2014-04-08 15:29:17 +00:00
|
|
|
* @param mixed $version The version of MediaWiki needed to use the page
|
2005-06-26 06:49:56 +00:00
|
|
|
*/
|
2006-11-07 05:37:31 +00:00
|
|
|
public function versionRequired( $version ) {
|
2011-10-28 15:45:54 +00:00
|
|
|
$this->prepareErrorPage( $this->msg( 'versionrequired', $version ) );
|
2005-06-26 06:49:56 +00:00
|
|
|
|
2008-02-18 07:25:35 +00:00
|
|
|
$this->addWikiMsg( 'versionrequiredtext', $version );
|
2005-06-26 06:49:56 +00:00
|
|
|
$this->returnToMain();
|
|
|
|
|
}
|
2005-07-01 00:03:31 +00:00
|
|
|
|
2007-08-03 09:27:28 +00:00
|
|
|
/**
|
2010-01-29 21:32:45 +00:00
|
|
|
* Format a list of error messages
|
|
|
|
|
*
|
2014-04-08 15:29:17 +00:00
|
|
|
* @param array $errors Array 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.
|
2007-08-03 09:27:28 +00:00
|
|
|
*/
|
2014-07-23 02:49:30 +00:00
|
|
|
public function formatPermissionsErrorMessage( array $errors, $action = null ) {
|
2010-05-22 12:18:22 +00:00
|
|
|
if ( $action == null ) {
|
2011-10-23 08:13:52 +00:00
|
|
|
$text = $this->msg( 'permissionserrorstext', count( $errors ) )->plain() . "\n\n";
|
2008-05-23 10:34:11 +00:00
|
|
|
} else {
|
2011-10-23 08:13:52 +00:00
|
|
|
$action_desc = $this->msg( "action-$action" )->plain();
|
|
|
|
|
$text = $this->msg(
|
2010-05-22 12:18:22 +00:00
|
|
|
'permissionserrorstext-withaction',
|
|
|
|
|
count( $errors ),
|
|
|
|
|
$action_desc
|
2011-10-23 08:13:52 +00:00
|
|
|
)->plain() . "\n\n";
|
2008-05-23 10:34:11 +00:00
|
|
|
}
|
2008-01-02 01:16:44 +00:00
|
|
|
|
2010-05-22 12:18:22 +00:00
|
|
|
if ( count( $errors ) > 1 ) {
|
2007-08-16 07:05:38 +00:00
|
|
|
$text .= '<ul class="permissions-errors">' . "\n";
|
|
|
|
|
|
2013-04-17 14:52:47 +00:00
|
|
|
foreach ( $errors as $error ) {
|
2007-08-16 07:05:38 +00:00
|
|
|
$text .= '<li>';
|
2016-02-17 09:09:32 +00:00
|
|
|
$text .= call_user_func_array( [ $this, 'msg' ], $error )->plain();
|
2007-08-16 07:05:38 +00:00
|
|
|
$text .= "</li>\n";
|
|
|
|
|
}
|
|
|
|
|
$text .= '</ul>';
|
|
|
|
|
} else {
|
2010-05-22 12:18:22 +00:00
|
|
|
$text .= "<div class=\"permissions-errors\">\n" .
|
2016-02-17 09:09:32 +00:00
|
|
|
call_user_func_array( [ $this, 'msg' ], reset( $errors ) )->plain() .
|
2010-05-22 12:18:22 +00:00
|
|
|
"\n</div>";
|
2007-08-03 09:27:28 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return $text;
|
|
|
|
|
}
|
|
|
|
|
|
2006-11-07 05:37:31 +00:00
|
|
|
/**
|
2014-09-29 03:17:13 +00:00
|
|
|
* Display a page stating that the Wiki is in read-only mode.
|
|
|
|
|
* Should only be called after wfReadOnly() has returned true.
|
|
|
|
|
*
|
|
|
|
|
* Historically, this function was used to show the source of the page that the user
|
|
|
|
|
* was trying to edit and _also_ permissions error messages. The relevant code was
|
|
|
|
|
* moved into EditPage in 1.19 (r102024 / d83c2a431c2a) and removed here in 1.25.
|
|
|
|
|
*
|
|
|
|
|
* @deprecated since 1.25; throw the exception directly
|
2012-10-07 23:35:26 +00:00
|
|
|
* @throws ReadOnlyError
|
2006-11-07 05:37:31 +00:00
|
|
|
*/
|
2014-09-29 03:17:13 +00:00
|
|
|
public function readOnlyPage() {
|
|
|
|
|
if ( func_num_args() > 0 ) {
|
|
|
|
|
throw new MWException( __METHOD__ . ' no longer accepts arguments since 1.25.' );
|
2007-12-09 00:16:59 +00:00
|
|
|
}
|
|
|
|
|
|
2014-09-29 03:17:13 +00:00
|
|
|
throw new ReadOnlyError;
|
2003-04-14 23:10:40 +00:00
|
|
|
}
|
|
|
|
|
|
2011-04-07 16:04:08 +00:00
|
|
|
/**
|
2013-03-13 07:42:41 +00:00
|
|
|
* Turn off regular page output and return an error response
|
2011-04-07 16:04:08 +00:00
|
|
|
* for when rate limiting has triggered.
|
2014-09-29 04:01:30 +00:00
|
|
|
*
|
|
|
|
|
* @deprecated since 1.25; throw the exception directly
|
2011-04-07 16:04:08 +00:00
|
|
|
*/
|
|
|
|
|
public function rateLimited() {
|
2014-09-29 04:01:30 +00:00
|
|
|
wfDeprecated( __METHOD__, '1.25' );
|
2011-04-18 22:29:23 +00:00
|
|
|
throw new ThrottledError;
|
2011-04-07 16:04:08 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
2016-09-05 20:21:26 +00:00
|
|
|
* Show a warning about replica DB lag
|
2011-04-07 16:04:08 +00:00
|
|
|
*
|
|
|
|
|
* 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.
|
|
|
|
|
*
|
2014-04-08 15:29:17 +00:00
|
|
|
* @param int $lag Slave lag
|
2011-04-07 16:04:08 +00:00
|
|
|
*/
|
|
|
|
|
public function showLagWarning( $lag ) {
|
2014-08-23 08:52:41 +00:00
|
|
|
$config = $this->getConfig();
|
|
|
|
|
if ( $lag >= $config->get( 'SlaveLagWarning' ) ) {
|
2016-08-21 15:01:04 +00:00
|
|
|
$lag = floor( $lag ); // floor to avoid nano seconds to display
|
2014-08-23 08:52:41 +00:00
|
|
|
$message = $lag < $config->get( 'SlaveLagCritical' )
|
2011-04-07 16:04:08 +00:00
|
|
|
? 'lag-warn-normal'
|
|
|
|
|
: 'lag-warn-high';
|
2016-02-17 09:09:32 +00:00
|
|
|
$wrap = Html::rawElement( 'div', [ 'class' => "mw-{$message}" ], "\n$1\n" );
|
|
|
|
|
$this->wrapWikiMsg( "$wrap\n", [ $message, $this->getLanguage()->formatNum( $lag ) ] );
|
2011-04-07 16:04:08 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2006-11-07 05:37:31 +00:00
|
|
|
public function showFatalError( $message ) {
|
2011-10-28 15:45:54 +00:00
|
|
|
$this->prepareErrorPage( $this->msg( 'internalerror' ) );
|
|
|
|
|
|
|
|
|
|
$this->addHTML( $message );
|
2003-04-14 23:10:40 +00:00
|
|
|
}
|
|
|
|
|
|
2006-11-07 05:37:31 +00:00
|
|
|
public function showUnexpectedValueError( $name, $val ) {
|
2011-10-23 08:13:52 +00:00
|
|
|
$this->showFatalError( $this->msg( 'unexpected', $name, $val )->text() );
|
2003-04-14 23:10:40 +00:00
|
|
|
}
|
|
|
|
|
|
2006-11-07 05:37:31 +00:00
|
|
|
public function showFileCopyError( $old, $new ) {
|
2011-10-23 08:13:52 +00:00
|
|
|
$this->showFatalError( $this->msg( 'filecopyerror', $old, $new )->text() );
|
2003-04-14 23:10:40 +00:00
|
|
|
}
|
|
|
|
|
|
2006-11-07 05:37:31 +00:00
|
|
|
public function showFileRenameError( $old, $new ) {
|
2011-10-23 08:13:52 +00:00
|
|
|
$this->showFatalError( $this->msg( 'filerenameerror', $old, $new )->text() );
|
2003-04-14 23:10:40 +00:00
|
|
|
}
|
|
|
|
|
|
2006-11-07 05:37:31 +00:00
|
|
|
public function showFileDeleteError( $name ) {
|
2011-10-23 08:13:52 +00:00
|
|
|
$this->showFatalError( $this->msg( 'filedeleteerror', $name )->text() );
|
2003-04-14 23:10:40 +00:00
|
|
|
}
|
|
|
|
|
|
2006-11-07 05:37:31 +00:00
|
|
|
public function showFileNotFoundError( $name ) {
|
2011-10-23 08:13:52 +00:00
|
|
|
$this->showFatalError( $this->msg( 'filenotfound', $name )->text() );
|
2003-04-14 23:10:40 +00:00
|
|
|
}
|
|
|
|
|
|
2004-09-02 23:28:24 +00:00
|
|
|
/**
|
2007-07-29 23:53:45 +00:00
|
|
|
* Add a "return to" link pointing to a specified title
|
|
|
|
|
*
|
2014-04-10 18:50:10 +00:00
|
|
|
* @param Title $title Title to link
|
|
|
|
|
* @param array $query Query string parameters
|
|
|
|
|
* @param string $text Text of the link (input is not escaped)
|
|
|
|
|
* @param array $options Options array to pass to Linker
|
2007-07-29 23:53:45 +00:00
|
|
|
*/
|
2016-02-17 09:09:32 +00:00
|
|
|
public function addReturnTo( $title, array $query = [], $text = null, $options = [] ) {
|
2016-11-30 21:28:55 +00:00
|
|
|
$linkRenderer = MediaWikiServices::getInstance()
|
|
|
|
|
->getLinkRendererFactory()->createFromLegacyOptions( $options );
|
2011-10-23 08:13:52 +00:00
|
|
|
$link = $this->msg( 'returnto' )->rawParams(
|
2016-11-30 21:28:55 +00:00
|
|
|
$linkRenderer->makeLink( $title, $text, [], $query ) )->escaped();
|
2009-06-15 11:11:17 +00:00
|
|
|
$this->addHTML( "<p id=\"mw-returnto\">{$link}</p>\n" );
|
2007-07-29 23:53:45 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Add a "return to" link pointing to a specified title,
|
|
|
|
|
* or the title indicated in the request, or else the main page
|
|
|
|
|
*
|
2014-04-10 18:50:10 +00:00
|
|
|
* @param mixed $unused
|
|
|
|
|
* @param Title|string $returnto Title or String to return to
|
|
|
|
|
* @param string $returntoquery Query string for the return to link
|
2004-09-02 23:28:24 +00:00
|
|
|
*/
|
2009-07-14 21:25:33 +00:00
|
|
|
public function returnToMain( $unused = null, $returnto = null, $returntoquery = null ) {
|
|
|
|
|
if ( $returnto == null ) {
|
2011-04-03 12:46:36 +00:00
|
|
|
$returnto = $this->getRequest()->getText( 'returnto' );
|
2004-04-01 12:44:54 +00:00
|
|
|
}
|
2009-08-07 00:16:54 +00:00
|
|
|
|
2009-07-14 21:25:33 +00:00
|
|
|
if ( $returntoquery == null ) {
|
2011-04-03 12:46:36 +00:00
|
|
|
$returntoquery = $this->getRequest()->getText( 'returntoquery' );
|
2009-07-14 21:25:33 +00:00
|
|
|
}
|
2008-04-14 07:45:50 +00:00
|
|
|
|
2010-01-06 19:59:42 +00:00
|
|
|
if ( $returnto === '' ) {
|
2006-12-03 00:22:14 +00:00
|
|
|
$returnto = Title::newMainPage();
|
2003-04-14 23:10:40 +00:00
|
|
|
}
|
2006-06-21 16:28:04 +00:00
|
|
|
|
|
|
|
|
if ( is_object( $returnto ) ) {
|
|
|
|
|
$titleObj = $returnto;
|
|
|
|
|
} else {
|
|
|
|
|
$titleObj = Title::newFromText( $returnto );
|
|
|
|
|
}
|
2016-02-07 13:07:20 +00:00
|
|
|
// We don't want people to return to external interwiki. That
|
|
|
|
|
// might potentially be used as part of a phishing scheme
|
|
|
|
|
if ( !is_object( $titleObj ) || $titleObj->isExternal() ) {
|
2006-06-23 06:53:05 +00:00
|
|
|
$titleObj = Title::newMainPage();
|
|
|
|
|
}
|
2006-06-21 16:28:04 +00:00
|
|
|
|
2012-08-08 08:42:17 +00:00
|
|
|
$this->addReturnTo( $titleObj, wfCgiToArray( $returntoquery ) );
|
2003-04-14 23:10:40 +00:00
|
|
|
}
|
|
|
|
|
|
resourceloader: Move queue formatting out of OutputPage
HTML formatting of the queue was distributed over several OutputPage methods.
Each method demanding a snippet of HTML by calling makeResourceLoaderLink()
with a limited amount of information. As such, makeResourceLoaderLink() was
unable to provide the client with the proper state information.
Centralising it also allows it to better reduce duplication in HTML output
and maintain a more accurate state.
Problems fixed by centralising:
1. The 'user' module is special (due to per-user 'version' and 'user' params).
It is manually requested via script-src. To avoid a separate (and wrong)
request from something that requires it, we set state=loading directly.
However, because the module is in the bottom, the old HTML formatter could
only put state=loading in the bottom also. This sometimes caused a wrong
request to be fired for modules=user if something in the top queue
triggered a requirement for it.
2. Since a464d1d4 (T87871) we track states of page-style modules, with purpose
of allowing dependencies on style modules without risking duplicate loading
on pages where the styles are loaded already. This didn't work, because the
state information about page-style modules is output near the stylesheet,
which is after the script tag with mw.loader.load(). That runs first, and
mw.loader would still make a duplicate request before it learns the state.
Changes:
* Document reasons for style/script tag order in getHeadHtml (per 09537e83).
* Pass $type from getModuleStyles() to getAllowedModules(). This wasn't needed
before since a duplicate check in makeResourceLoaderLink() verified the
origin a second time.
* Declare explicit position 'top' on 'user.options' and 'user.tokens' module.
Previously, OutputPage hardcoded them in the top. The new formatter doesn't.
* Remove getHeadScripts().
* Remove getInlineHeadScripts().
* Remove getExternalHeadScripts().
* Remove buildCssLinks().
* Remove getScriptsForBottomQueue().
* Change where Skin::setupSkinUserCss() is called. This methods lets the skin
add modules to the queue. Previously it was called from buildCssLinks(),
via headElement(), via prepareQuickTemplate(), via OutputPage::output().
It's now in OutputPage::output() directly (slightly earlier). This is needed
because prepareQuickTemplate() calls bottomScripts() before headElement().
And bottomScript() would lazy-initialise the queue and lock it before
setupSkinUserCss() is called from headElement().
This makes execution order more predictable instead of being dependent on
the arbitrary order of data extraction in prepareQuickTemplate (which varies
from one skin to another).
* Compute isUserModulePreview() and isKnownEmpty() for the 'user' module early
on so. This avoids wrongful loading and fixes problem 1.
Effective changes in output:
* mw.loader.state() is now before mw.loader.load(). This fixes problem 2.
* mw.loader.state() now sets 'user.options' and 'user.tokens' to "loading".
* mw.loader.state() now sets 'user' (as "loading" or "ready"). Fixes problem 1.
* The <script async src> tag for 'startup' changed position (slightly).
Previously it was after all inline scripts and stylesheets. It's still after
all inline scripts and after most stylesheets, but before any user styles.
Since the queue is now formatted outside OutputPage, it can't inject the
meta-ResourceLoaderDynamicStyles tag and user-stylesheet hack in the middle
of existing output. This shouldn't have any noticable impact.
Bug: T87871
Change-Id: I605b8cd1e1fc009b4662a0edbc54d09dd65ee1df
2016-07-15 14:13:09 +00:00
|
|
|
private function getRlClientContext() {
|
|
|
|
|
if ( !$this->rlClientContext ) {
|
|
|
|
|
$query = ResourceLoader::makeLoaderQuery(
|
|
|
|
|
[], // modules; not relevant
|
|
|
|
|
$this->getLanguage()->getCode(),
|
|
|
|
|
$this->getSkin()->getSkinName(),
|
|
|
|
|
$this->getUser()->isLoggedIn() ? $this->getUser()->getName() : null,
|
|
|
|
|
null, // version; not relevant
|
|
|
|
|
ResourceLoader::inDebugMode(),
|
|
|
|
|
null, // only; not relevant
|
|
|
|
|
$this->isPrintable(),
|
|
|
|
|
$this->getRequest()->getBool( 'handheld' )
|
|
|
|
|
);
|
|
|
|
|
$this->rlClientContext = new ResourceLoaderContext(
|
|
|
|
|
$this->getResourceLoader(),
|
|
|
|
|
new FauxRequest( $query )
|
|
|
|
|
);
|
|
|
|
|
}
|
|
|
|
|
return $this->rlClientContext;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Call this to freeze the module queue and JS config and create a formatter.
|
|
|
|
|
*
|
|
|
|
|
* Depending on the Skin, this may get lazy-initialised in either headElement() or
|
|
|
|
|
* getBottomScripts(). See SkinTemplate::prepareQuickTemplate(). Calling this too early may
|
|
|
|
|
* cause unexpected side-effects since disallowUserJs() may be called at any time to change
|
|
|
|
|
* the module filters retroactively. Skins and extension hooks may also add modules until very
|
|
|
|
|
* late in the request lifecycle.
|
|
|
|
|
*
|
|
|
|
|
* @return ResourceLoaderClientHtml
|
|
|
|
|
*/
|
|
|
|
|
public function getRlClient() {
|
|
|
|
|
if ( !$this->rlClient ) {
|
|
|
|
|
$context = $this->getRlClientContext();
|
2016-08-19 02:04:21 +00:00
|
|
|
$rl = $this->getResourceLoader();
|
resourceloader: Move queue formatting out of OutputPage
HTML formatting of the queue was distributed over several OutputPage methods.
Each method demanding a snippet of HTML by calling makeResourceLoaderLink()
with a limited amount of information. As such, makeResourceLoaderLink() was
unable to provide the client with the proper state information.
Centralising it also allows it to better reduce duplication in HTML output
and maintain a more accurate state.
Problems fixed by centralising:
1. The 'user' module is special (due to per-user 'version' and 'user' params).
It is manually requested via script-src. To avoid a separate (and wrong)
request from something that requires it, we set state=loading directly.
However, because the module is in the bottom, the old HTML formatter could
only put state=loading in the bottom also. This sometimes caused a wrong
request to be fired for modules=user if something in the top queue
triggered a requirement for it.
2. Since a464d1d4 (T87871) we track states of page-style modules, with purpose
of allowing dependencies on style modules without risking duplicate loading
on pages where the styles are loaded already. This didn't work, because the
state information about page-style modules is output near the stylesheet,
which is after the script tag with mw.loader.load(). That runs first, and
mw.loader would still make a duplicate request before it learns the state.
Changes:
* Document reasons for style/script tag order in getHeadHtml (per 09537e83).
* Pass $type from getModuleStyles() to getAllowedModules(). This wasn't needed
before since a duplicate check in makeResourceLoaderLink() verified the
origin a second time.
* Declare explicit position 'top' on 'user.options' and 'user.tokens' module.
Previously, OutputPage hardcoded them in the top. The new formatter doesn't.
* Remove getHeadScripts().
* Remove getInlineHeadScripts().
* Remove getExternalHeadScripts().
* Remove buildCssLinks().
* Remove getScriptsForBottomQueue().
* Change where Skin::setupSkinUserCss() is called. This methods lets the skin
add modules to the queue. Previously it was called from buildCssLinks(),
via headElement(), via prepareQuickTemplate(), via OutputPage::output().
It's now in OutputPage::output() directly (slightly earlier). This is needed
because prepareQuickTemplate() calls bottomScripts() before headElement().
And bottomScript() would lazy-initialise the queue and lock it before
setupSkinUserCss() is called from headElement().
This makes execution order more predictable instead of being dependent on
the arbitrary order of data extraction in prepareQuickTemplate (which varies
from one skin to another).
* Compute isUserModulePreview() and isKnownEmpty() for the 'user' module early
on so. This avoids wrongful loading and fixes problem 1.
Effective changes in output:
* mw.loader.state() is now before mw.loader.load(). This fixes problem 2.
* mw.loader.state() now sets 'user.options' and 'user.tokens' to "loading".
* mw.loader.state() now sets 'user' (as "loading" or "ready"). Fixes problem 1.
* The <script async src> tag for 'startup' changed position (slightly).
Previously it was after all inline scripts and stylesheets. It's still after
all inline scripts and after most stylesheets, but before any user styles.
Since the queue is now formatted outside OutputPage, it can't inject the
meta-ResourceLoaderDynamicStyles tag and user-stylesheet hack in the middle
of existing output. This shouldn't have any noticable impact.
Bug: T87871
Change-Id: I605b8cd1e1fc009b4662a0edbc54d09dd65ee1df
2016-07-15 14:13:09 +00:00
|
|
|
$this->addModules( [
|
|
|
|
|
'user.options',
|
|
|
|
|
'user.tokens',
|
|
|
|
|
] );
|
2016-08-19 02:04:21 +00:00
|
|
|
$this->addModuleStyles( [
|
|
|
|
|
'site.styles',
|
|
|
|
|
'noscript',
|
|
|
|
|
'user.styles',
|
|
|
|
|
] );
|
2016-08-30 23:36:28 +00:00
|
|
|
$this->getSkin()->setupSkinUserCss( $this );
|
2016-08-19 02:04:21 +00:00
|
|
|
|
|
|
|
|
// Prepare exempt modules for buildExemptModules()
|
|
|
|
|
$exemptGroups = [ 'site' => [], 'noscript' => [], 'private' => [], 'user' => [] ];
|
|
|
|
|
$exemptStates = [];
|
2016-09-08 08:38:26 +00:00
|
|
|
$moduleStyles = $this->getModuleStyles( /*filter*/ true );
|
|
|
|
|
|
2016-10-20 21:43:57 +00:00
|
|
|
// Preload getTitleInfo for isKnownEmpty calls below and in ResourceLoaderClientHtml
|
|
|
|
|
// Separate user-specific batch for improved cache-hit ratio.
|
|
|
|
|
$userBatch = [ 'user.styles', 'user' ];
|
|
|
|
|
$siteBatch = array_diff( $moduleStyles, $userBatch );
|
|
|
|
|
$dbr = wfGetDB( DB_REPLICA );
|
|
|
|
|
ResourceLoaderWikiModule::preloadTitleInfo( $context, $dbr, $siteBatch );
|
|
|
|
|
ResourceLoaderWikiModule::preloadTitleInfo( $context, $dbr, $userBatch );
|
2016-09-08 08:38:26 +00:00
|
|
|
|
|
|
|
|
// Filter out modules handled by buildExemptModules()
|
|
|
|
|
$moduleStyles = array_filter( $moduleStyles,
|
2016-08-19 02:04:21 +00:00
|
|
|
function ( $name ) use ( $rl, $context, &$exemptGroups, &$exemptStates ) {
|
|
|
|
|
$module = $rl->getModule( $name );
|
|
|
|
|
if ( $module ) {
|
|
|
|
|
if ( $name === 'user.styles' && $this->isUserCssPreview() ) {
|
|
|
|
|
$exemptStates[$name] = 'ready';
|
|
|
|
|
// Special case in buildExemptModules()
|
|
|
|
|
return false;
|
|
|
|
|
}
|
2016-09-08 08:38:26 +00:00
|
|
|
$group = $module->getGroup();
|
2016-08-19 02:04:21 +00:00
|
|
|
if ( isset( $exemptGroups[$group] ) ) {
|
|
|
|
|
$exemptStates[$name] = 'ready';
|
|
|
|
|
if ( !$module->isKnownEmpty( $context ) ) {
|
|
|
|
|
// E.g. Don't output empty <styles>
|
|
|
|
|
$exemptGroups[$group][] = $name;
|
|
|
|
|
}
|
|
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
return true;
|
|
|
|
|
}
|
|
|
|
|
);
|
|
|
|
|
$this->rlExemptStyleModules = $exemptGroups;
|
|
|
|
|
|
2016-09-14 04:54:57 +00:00
|
|
|
$isUserModuleFiltered = !$this->filterModules( [ 'user' ] );
|
|
|
|
|
// If this page filters out 'user', makeResourceLoaderLink will drop it.
|
|
|
|
|
// Avoid indefinite "loading" state or untrue "ready" state (T145368).
|
|
|
|
|
if ( !$isUserModuleFiltered ) {
|
|
|
|
|
// Manually handled by getBottomScripts()
|
|
|
|
|
$userModule = $rl->getModule( 'user' );
|
|
|
|
|
$userState = $userModule->isKnownEmpty( $context ) && !$this->isUserJsPreview()
|
|
|
|
|
? 'ready'
|
|
|
|
|
: 'loading';
|
|
|
|
|
$this->rlUserModuleState = $exemptStates['user'] = $userState;
|
|
|
|
|
}
|
2016-08-19 02:04:21 +00:00
|
|
|
|
2016-08-16 22:25:08 +00:00
|
|
|
$rlClient = new ResourceLoaderClientHtml( $context, $this->getTarget() );
|
resourceloader: Move queue formatting out of OutputPage
HTML formatting of the queue was distributed over several OutputPage methods.
Each method demanding a snippet of HTML by calling makeResourceLoaderLink()
with a limited amount of information. As such, makeResourceLoaderLink() was
unable to provide the client with the proper state information.
Centralising it also allows it to better reduce duplication in HTML output
and maintain a more accurate state.
Problems fixed by centralising:
1. The 'user' module is special (due to per-user 'version' and 'user' params).
It is manually requested via script-src. To avoid a separate (and wrong)
request from something that requires it, we set state=loading directly.
However, because the module is in the bottom, the old HTML formatter could
only put state=loading in the bottom also. This sometimes caused a wrong
request to be fired for modules=user if something in the top queue
triggered a requirement for it.
2. Since a464d1d4 (T87871) we track states of page-style modules, with purpose
of allowing dependencies on style modules without risking duplicate loading
on pages where the styles are loaded already. This didn't work, because the
state information about page-style modules is output near the stylesheet,
which is after the script tag with mw.loader.load(). That runs first, and
mw.loader would still make a duplicate request before it learns the state.
Changes:
* Document reasons for style/script tag order in getHeadHtml (per 09537e83).
* Pass $type from getModuleStyles() to getAllowedModules(). This wasn't needed
before since a duplicate check in makeResourceLoaderLink() verified the
origin a second time.
* Declare explicit position 'top' on 'user.options' and 'user.tokens' module.
Previously, OutputPage hardcoded them in the top. The new formatter doesn't.
* Remove getHeadScripts().
* Remove getInlineHeadScripts().
* Remove getExternalHeadScripts().
* Remove buildCssLinks().
* Remove getScriptsForBottomQueue().
* Change where Skin::setupSkinUserCss() is called. This methods lets the skin
add modules to the queue. Previously it was called from buildCssLinks(),
via headElement(), via prepareQuickTemplate(), via OutputPage::output().
It's now in OutputPage::output() directly (slightly earlier). This is needed
because prepareQuickTemplate() calls bottomScripts() before headElement().
And bottomScript() would lazy-initialise the queue and lock it before
setupSkinUserCss() is called from headElement().
This makes execution order more predictable instead of being dependent on
the arbitrary order of data extraction in prepareQuickTemplate (which varies
from one skin to another).
* Compute isUserModulePreview() and isKnownEmpty() for the 'user' module early
on so. This avoids wrongful loading and fixes problem 1.
Effective changes in output:
* mw.loader.state() is now before mw.loader.load(). This fixes problem 2.
* mw.loader.state() now sets 'user.options' and 'user.tokens' to "loading".
* mw.loader.state() now sets 'user' (as "loading" or "ready"). Fixes problem 1.
* The <script async src> tag for 'startup' changed position (slightly).
Previously it was after all inline scripts and stylesheets. It's still after
all inline scripts and after most stylesheets, but before any user styles.
Since the queue is now formatted outside OutputPage, it can't inject the
meta-ResourceLoaderDynamicStyles tag and user-stylesheet hack in the middle
of existing output. This shouldn't have any noticable impact.
Bug: T87871
Change-Id: I605b8cd1e1fc009b4662a0edbc54d09dd65ee1df
2016-07-15 14:13:09 +00:00
|
|
|
$rlClient->setConfig( $this->getJSVars() );
|
|
|
|
|
$rlClient->setModules( $this->getModules( /*filter*/ true ) );
|
2016-08-19 02:04:21 +00:00
|
|
|
$rlClient->setModuleStyles( $moduleStyles );
|
resourceloader: Move queue formatting out of OutputPage
HTML formatting of the queue was distributed over several OutputPage methods.
Each method demanding a snippet of HTML by calling makeResourceLoaderLink()
with a limited amount of information. As such, makeResourceLoaderLink() was
unable to provide the client with the proper state information.
Centralising it also allows it to better reduce duplication in HTML output
and maintain a more accurate state.
Problems fixed by centralising:
1. The 'user' module is special (due to per-user 'version' and 'user' params).
It is manually requested via script-src. To avoid a separate (and wrong)
request from something that requires it, we set state=loading directly.
However, because the module is in the bottom, the old HTML formatter could
only put state=loading in the bottom also. This sometimes caused a wrong
request to be fired for modules=user if something in the top queue
triggered a requirement for it.
2. Since a464d1d4 (T87871) we track states of page-style modules, with purpose
of allowing dependencies on style modules without risking duplicate loading
on pages where the styles are loaded already. This didn't work, because the
state information about page-style modules is output near the stylesheet,
which is after the script tag with mw.loader.load(). That runs first, and
mw.loader would still make a duplicate request before it learns the state.
Changes:
* Document reasons for style/script tag order in getHeadHtml (per 09537e83).
* Pass $type from getModuleStyles() to getAllowedModules(). This wasn't needed
before since a duplicate check in makeResourceLoaderLink() verified the
origin a second time.
* Declare explicit position 'top' on 'user.options' and 'user.tokens' module.
Previously, OutputPage hardcoded them in the top. The new formatter doesn't.
* Remove getHeadScripts().
* Remove getInlineHeadScripts().
* Remove getExternalHeadScripts().
* Remove buildCssLinks().
* Remove getScriptsForBottomQueue().
* Change where Skin::setupSkinUserCss() is called. This methods lets the skin
add modules to the queue. Previously it was called from buildCssLinks(),
via headElement(), via prepareQuickTemplate(), via OutputPage::output().
It's now in OutputPage::output() directly (slightly earlier). This is needed
because prepareQuickTemplate() calls bottomScripts() before headElement().
And bottomScript() would lazy-initialise the queue and lock it before
setupSkinUserCss() is called from headElement().
This makes execution order more predictable instead of being dependent on
the arbitrary order of data extraction in prepareQuickTemplate (which varies
from one skin to another).
* Compute isUserModulePreview() and isKnownEmpty() for the 'user' module early
on so. This avoids wrongful loading and fixes problem 1.
Effective changes in output:
* mw.loader.state() is now before mw.loader.load(). This fixes problem 2.
* mw.loader.state() now sets 'user.options' and 'user.tokens' to "loading".
* mw.loader.state() now sets 'user' (as "loading" or "ready"). Fixes problem 1.
* The <script async src> tag for 'startup' changed position (slightly).
Previously it was after all inline scripts and stylesheets. It's still after
all inline scripts and after most stylesheets, but before any user styles.
Since the queue is now formatted outside OutputPage, it can't inject the
meta-ResourceLoaderDynamicStyles tag and user-stylesheet hack in the middle
of existing output. This shouldn't have any noticable impact.
Bug: T87871
Change-Id: I605b8cd1e1fc009b4662a0edbc54d09dd65ee1df
2016-07-15 14:13:09 +00:00
|
|
|
$rlClient->setModuleScripts( $this->getModuleScripts( /*filter*/ true ) );
|
2016-08-19 02:04:21 +00:00
|
|
|
$rlClient->setExemptStates( $exemptStates );
|
resourceloader: Move queue formatting out of OutputPage
HTML formatting of the queue was distributed over several OutputPage methods.
Each method demanding a snippet of HTML by calling makeResourceLoaderLink()
with a limited amount of information. As such, makeResourceLoaderLink() was
unable to provide the client with the proper state information.
Centralising it also allows it to better reduce duplication in HTML output
and maintain a more accurate state.
Problems fixed by centralising:
1. The 'user' module is special (due to per-user 'version' and 'user' params).
It is manually requested via script-src. To avoid a separate (and wrong)
request from something that requires it, we set state=loading directly.
However, because the module is in the bottom, the old HTML formatter could
only put state=loading in the bottom also. This sometimes caused a wrong
request to be fired for modules=user if something in the top queue
triggered a requirement for it.
2. Since a464d1d4 (T87871) we track states of page-style modules, with purpose
of allowing dependencies on style modules without risking duplicate loading
on pages where the styles are loaded already. This didn't work, because the
state information about page-style modules is output near the stylesheet,
which is after the script tag with mw.loader.load(). That runs first, and
mw.loader would still make a duplicate request before it learns the state.
Changes:
* Document reasons for style/script tag order in getHeadHtml (per 09537e83).
* Pass $type from getModuleStyles() to getAllowedModules(). This wasn't needed
before since a duplicate check in makeResourceLoaderLink() verified the
origin a second time.
* Declare explicit position 'top' on 'user.options' and 'user.tokens' module.
Previously, OutputPage hardcoded them in the top. The new formatter doesn't.
* Remove getHeadScripts().
* Remove getInlineHeadScripts().
* Remove getExternalHeadScripts().
* Remove buildCssLinks().
* Remove getScriptsForBottomQueue().
* Change where Skin::setupSkinUserCss() is called. This methods lets the skin
add modules to the queue. Previously it was called from buildCssLinks(),
via headElement(), via prepareQuickTemplate(), via OutputPage::output().
It's now in OutputPage::output() directly (slightly earlier). This is needed
because prepareQuickTemplate() calls bottomScripts() before headElement().
And bottomScript() would lazy-initialise the queue and lock it before
setupSkinUserCss() is called from headElement().
This makes execution order more predictable instead of being dependent on
the arbitrary order of data extraction in prepareQuickTemplate (which varies
from one skin to another).
* Compute isUserModulePreview() and isKnownEmpty() for the 'user' module early
on so. This avoids wrongful loading and fixes problem 1.
Effective changes in output:
* mw.loader.state() is now before mw.loader.load(). This fixes problem 2.
* mw.loader.state() now sets 'user.options' and 'user.tokens' to "loading".
* mw.loader.state() now sets 'user' (as "loading" or "ready"). Fixes problem 1.
* The <script async src> tag for 'startup' changed position (slightly).
Previously it was after all inline scripts and stylesheets. It's still after
all inline scripts and after most stylesheets, but before any user styles.
Since the queue is now formatted outside OutputPage, it can't inject the
meta-ResourceLoaderDynamicStyles tag and user-stylesheet hack in the middle
of existing output. This shouldn't have any noticable impact.
Bug: T87871
Change-Id: I605b8cd1e1fc009b4662a0edbc54d09dd65ee1df
2016-07-15 14:13:09 +00:00
|
|
|
$this->rlClient = $rlClient;
|
|
|
|
|
}
|
|
|
|
|
return $this->rlClient;
|
|
|
|
|
}
|
|
|
|
|
|
2004-09-02 23:28:24 +00:00
|
|
|
/**
|
2014-04-08 15:29:17 +00:00
|
|
|
* @param Skin $sk The given Skin
|
|
|
|
|
* @param bool $includeStyle Unused
|
|
|
|
|
* @return string The doctype, opening "<html>", and head element.
|
2004-09-02 23:28:24 +00:00
|
|
|
*/
|
2009-09-22 16:52:40 +00:00
|
|
|
public function headElement( Skin $sk, $includeStyle = true ) {
|
2014-08-23 08:52:41 +00:00
|
|
|
global $wgContLang;
|
2012-01-08 01:49:06 +00:00
|
|
|
|
2011-11-21 16:13:21 +00:00
|
|
|
$userdir = $this->getLanguage()->getDir();
|
2011-07-19 20:36:09 +00:00
|
|
|
$sitedir = $wgContLang->getDir();
|
2003-04-14 23:10:40 +00:00
|
|
|
|
2016-07-07 19:26:36 +00:00
|
|
|
$pieces = [];
|
resourceloader: Move queue formatting out of OutputPage
HTML formatting of the queue was distributed over several OutputPage methods.
Each method demanding a snippet of HTML by calling makeResourceLoaderLink()
with a limited amount of information. As such, makeResourceLoaderLink() was
unable to provide the client with the proper state information.
Centralising it also allows it to better reduce duplication in HTML output
and maintain a more accurate state.
Problems fixed by centralising:
1. The 'user' module is special (due to per-user 'version' and 'user' params).
It is manually requested via script-src. To avoid a separate (and wrong)
request from something that requires it, we set state=loading directly.
However, because the module is in the bottom, the old HTML formatter could
only put state=loading in the bottom also. This sometimes caused a wrong
request to be fired for modules=user if something in the top queue
triggered a requirement for it.
2. Since a464d1d4 (T87871) we track states of page-style modules, with purpose
of allowing dependencies on style modules without risking duplicate loading
on pages where the styles are loaded already. This didn't work, because the
state information about page-style modules is output near the stylesheet,
which is after the script tag with mw.loader.load(). That runs first, and
mw.loader would still make a duplicate request before it learns the state.
Changes:
* Document reasons for style/script tag order in getHeadHtml (per 09537e83).
* Pass $type from getModuleStyles() to getAllowedModules(). This wasn't needed
before since a duplicate check in makeResourceLoaderLink() verified the
origin a second time.
* Declare explicit position 'top' on 'user.options' and 'user.tokens' module.
Previously, OutputPage hardcoded them in the top. The new formatter doesn't.
* Remove getHeadScripts().
* Remove getInlineHeadScripts().
* Remove getExternalHeadScripts().
* Remove buildCssLinks().
* Remove getScriptsForBottomQueue().
* Change where Skin::setupSkinUserCss() is called. This methods lets the skin
add modules to the queue. Previously it was called from buildCssLinks(),
via headElement(), via prepareQuickTemplate(), via OutputPage::output().
It's now in OutputPage::output() directly (slightly earlier). This is needed
because prepareQuickTemplate() calls bottomScripts() before headElement().
And bottomScript() would lazy-initialise the queue and lock it before
setupSkinUserCss() is called from headElement().
This makes execution order more predictable instead of being dependent on
the arbitrary order of data extraction in prepareQuickTemplate (which varies
from one skin to another).
* Compute isUserModulePreview() and isKnownEmpty() for the 'user' module early
on so. This avoids wrongful loading and fixes problem 1.
Effective changes in output:
* mw.loader.state() is now before mw.loader.load(). This fixes problem 2.
* mw.loader.state() now sets 'user.options' and 'user.tokens' to "loading".
* mw.loader.state() now sets 'user' (as "loading" or "ready"). Fixes problem 1.
* The <script async src> tag for 'startup' changed position (slightly).
Previously it was after all inline scripts and stylesheets. It's still after
all inline scripts and after most stylesheets, but before any user styles.
Since the queue is now formatted outside OutputPage, it can't inject the
meta-ResourceLoaderDynamicStyles tag and user-stylesheet hack in the middle
of existing output. This shouldn't have any noticable impact.
Bug: T87871
Change-Id: I605b8cd1e1fc009b4662a0edbc54d09dd65ee1df
2016-07-15 14:13:09 +00:00
|
|
|
$pieces[] = Html::htmlHeader( Sanitizer::mergeAttributes(
|
|
|
|
|
$this->getRlClient()->getDocumentAttributes(),
|
|
|
|
|
$sk->getHtmlElementAttributes()
|
|
|
|
|
) );
|
|
|
|
|
$pieces[] = Html::openElement( 'head' );
|
2004-07-08 14:53:54 +00:00
|
|
|
|
2010-01-06 19:59:42 +00:00
|
|
|
if ( $this->getHTMLTitle() == '' ) {
|
2013-11-12 08:36:00 +00:00
|
|
|
$this->setHTMLTitle( $this->msg( 'pagetitle', $this->getPageTitle() )->inContentLanguage() );
|
2003-04-14 23:10:40 +00:00
|
|
|
}
|
2005-02-07 14:11:59 +00:00
|
|
|
|
2014-08-23 08:52:41 +00:00
|
|
|
if ( !Html::isXmlMimeType( $this->getConfig()->get( 'MimeType' ) ) ) {
|
2013-05-11 09:31:30 +00:00
|
|
|
// Add <meta charset="UTF-8">
|
|
|
|
|
// This should be before <title> since it defines the charset used by
|
|
|
|
|
// text including the text inside <title>.
|
|
|
|
|
// The spec recommends defining XHTML5's charset using the XML declaration
|
|
|
|
|
// instead of meta.
|
|
|
|
|
// Our XML declaration is output by Html::htmlHeader.
|
2016-10-13 05:34:26 +00:00
|
|
|
// https://html.spec.whatwg.org/multipage/semantics.html#attr-meta-http-equiv-content-type
|
|
|
|
|
// https://html.spec.whatwg.org/multipage/semantics.html#charset
|
2016-07-07 19:26:36 +00:00
|
|
|
$pieces[] = Html::element( 'meta', [ 'charset' => 'UTF-8' ] );
|
2013-05-11 09:31:30 +00:00
|
|
|
}
|
|
|
|
|
|
2016-07-07 19:26:36 +00:00
|
|
|
$pieces[] = Html::element( 'title', null, $this->getHTMLTitle() );
|
resourceloader: Move queue formatting out of OutputPage
HTML formatting of the queue was distributed over several OutputPage methods.
Each method demanding a snippet of HTML by calling makeResourceLoaderLink()
with a limited amount of information. As such, makeResourceLoaderLink() was
unable to provide the client with the proper state information.
Centralising it also allows it to better reduce duplication in HTML output
and maintain a more accurate state.
Problems fixed by centralising:
1. The 'user' module is special (due to per-user 'version' and 'user' params).
It is manually requested via script-src. To avoid a separate (and wrong)
request from something that requires it, we set state=loading directly.
However, because the module is in the bottom, the old HTML formatter could
only put state=loading in the bottom also. This sometimes caused a wrong
request to be fired for modules=user if something in the top queue
triggered a requirement for it.
2. Since a464d1d4 (T87871) we track states of page-style modules, with purpose
of allowing dependencies on style modules without risking duplicate loading
on pages where the styles are loaded already. This didn't work, because the
state information about page-style modules is output near the stylesheet,
which is after the script tag with mw.loader.load(). That runs first, and
mw.loader would still make a duplicate request before it learns the state.
Changes:
* Document reasons for style/script tag order in getHeadHtml (per 09537e83).
* Pass $type from getModuleStyles() to getAllowedModules(). This wasn't needed
before since a duplicate check in makeResourceLoaderLink() verified the
origin a second time.
* Declare explicit position 'top' on 'user.options' and 'user.tokens' module.
Previously, OutputPage hardcoded them in the top. The new formatter doesn't.
* Remove getHeadScripts().
* Remove getInlineHeadScripts().
* Remove getExternalHeadScripts().
* Remove buildCssLinks().
* Remove getScriptsForBottomQueue().
* Change where Skin::setupSkinUserCss() is called. This methods lets the skin
add modules to the queue. Previously it was called from buildCssLinks(),
via headElement(), via prepareQuickTemplate(), via OutputPage::output().
It's now in OutputPage::output() directly (slightly earlier). This is needed
because prepareQuickTemplate() calls bottomScripts() before headElement().
And bottomScript() would lazy-initialise the queue and lock it before
setupSkinUserCss() is called from headElement().
This makes execution order more predictable instead of being dependent on
the arbitrary order of data extraction in prepareQuickTemplate (which varies
from one skin to another).
* Compute isUserModulePreview() and isKnownEmpty() for the 'user' module early
on so. This avoids wrongful loading and fixes problem 1.
Effective changes in output:
* mw.loader.state() is now before mw.loader.load(). This fixes problem 2.
* mw.loader.state() now sets 'user.options' and 'user.tokens' to "loading".
* mw.loader.state() now sets 'user' (as "loading" or "ready"). Fixes problem 1.
* The <script async src> tag for 'startup' changed position (slightly).
Previously it was after all inline scripts and stylesheets. It's still after
all inline scripts and after most stylesheets, but before any user styles.
Since the queue is now formatted outside OutputPage, it can't inject the
meta-ResourceLoaderDynamicStyles tag and user-stylesheet hack in the middle
of existing output. This shouldn't have any noticable impact.
Bug: T87871
Change-Id: I605b8cd1e1fc009b4662a0edbc54d09dd65ee1df
2016-07-15 14:13:09 +00:00
|
|
|
$pieces[] = $this->getRlClient()->getHeadHtml();
|
|
|
|
|
$pieces[] = $this->buildExemptModules();
|
|
|
|
|
$pieces = array_merge( $pieces, array_values( $this->getHeadLinksArray() ) );
|
|
|
|
|
$pieces = array_merge( $pieces, array_values( $this->mHeadItems ) );
|
2017-08-03 15:35:10 +00:00
|
|
|
|
|
|
|
|
// Use an IE conditional comment to serve the script only to old IE
|
|
|
|
|
$pieces[] = '<!--[if lt IE 9]>' .
|
2017-08-15 20:00:27 +00:00
|
|
|
ResourceLoaderClientHtml::makeLoad(
|
|
|
|
|
ResourceLoaderContext::newDummyContext(),
|
|
|
|
|
[ 'html5shiv' ],
|
|
|
|
|
ResourceLoaderModule::TYPE_SCRIPTS,
|
|
|
|
|
[ 'sync' => true ]
|
|
|
|
|
) .
|
2017-08-03 15:35:10 +00:00
|
|
|
'<![endif]-->';
|
|
|
|
|
|
resourceloader: Move queue formatting out of OutputPage
HTML formatting of the queue was distributed over several OutputPage methods.
Each method demanding a snippet of HTML by calling makeResourceLoaderLink()
with a limited amount of information. As such, makeResourceLoaderLink() was
unable to provide the client with the proper state information.
Centralising it also allows it to better reduce duplication in HTML output
and maintain a more accurate state.
Problems fixed by centralising:
1. The 'user' module is special (due to per-user 'version' and 'user' params).
It is manually requested via script-src. To avoid a separate (and wrong)
request from something that requires it, we set state=loading directly.
However, because the module is in the bottom, the old HTML formatter could
only put state=loading in the bottom also. This sometimes caused a wrong
request to be fired for modules=user if something in the top queue
triggered a requirement for it.
2. Since a464d1d4 (T87871) we track states of page-style modules, with purpose
of allowing dependencies on style modules without risking duplicate loading
on pages where the styles are loaded already. This didn't work, because the
state information about page-style modules is output near the stylesheet,
which is after the script tag with mw.loader.load(). That runs first, and
mw.loader would still make a duplicate request before it learns the state.
Changes:
* Document reasons for style/script tag order in getHeadHtml (per 09537e83).
* Pass $type from getModuleStyles() to getAllowedModules(). This wasn't needed
before since a duplicate check in makeResourceLoaderLink() verified the
origin a second time.
* Declare explicit position 'top' on 'user.options' and 'user.tokens' module.
Previously, OutputPage hardcoded them in the top. The new formatter doesn't.
* Remove getHeadScripts().
* Remove getInlineHeadScripts().
* Remove getExternalHeadScripts().
* Remove buildCssLinks().
* Remove getScriptsForBottomQueue().
* Change where Skin::setupSkinUserCss() is called. This methods lets the skin
add modules to the queue. Previously it was called from buildCssLinks(),
via headElement(), via prepareQuickTemplate(), via OutputPage::output().
It's now in OutputPage::output() directly (slightly earlier). This is needed
because prepareQuickTemplate() calls bottomScripts() before headElement().
And bottomScript() would lazy-initialise the queue and lock it before
setupSkinUserCss() is called from headElement().
This makes execution order more predictable instead of being dependent on
the arbitrary order of data extraction in prepareQuickTemplate (which varies
from one skin to another).
* Compute isUserModulePreview() and isKnownEmpty() for the 'user' module early
on so. This avoids wrongful loading and fixes problem 1.
Effective changes in output:
* mw.loader.state() is now before mw.loader.load(). This fixes problem 2.
* mw.loader.state() now sets 'user.options' and 'user.tokens' to "loading".
* mw.loader.state() now sets 'user' (as "loading" or "ready"). Fixes problem 1.
* The <script async src> tag for 'startup' changed position (slightly).
Previously it was after all inline scripts and stylesheets. It's still after
all inline scripts and after most stylesheets, but before any user styles.
Since the queue is now formatted outside OutputPage, it can't inject the
meta-ResourceLoaderDynamicStyles tag and user-stylesheet hack in the middle
of existing output. This shouldn't have any noticable impact.
Bug: T87871
Change-Id: I605b8cd1e1fc009b4662a0edbc54d09dd65ee1df
2016-07-15 14:13:09 +00:00
|
|
|
$pieces[] = Html::closeElement( 'head' );
|
2010-01-15 01:16:52 +00:00
|
|
|
|
2017-09-11 07:12:03 +00:00
|
|
|
$bodyClasses = $this->mAdditionalBodyClasses;
|
2013-04-22 13:57:44 +00:00
|
|
|
$bodyClasses[] = 'mediawiki';
|
2010-01-15 01:16:52 +00:00
|
|
|
|
2011-07-06 02:26:06 +00:00
|
|
|
# Classes for LTR/RTL directionality support
|
2013-04-22 13:57:44 +00:00
|
|
|
$bodyClasses[] = $userdir;
|
|
|
|
|
$bodyClasses[] = "sitedir-$sitedir";
|
2010-01-15 01:16:52 +00:00
|
|
|
|
2016-09-07 22:51:48 +00:00
|
|
|
$underline = $this->getUser()->getOption( 'underline' );
|
|
|
|
|
if ( $underline < 2 ) {
|
|
|
|
|
// The following classes can be used here:
|
|
|
|
|
// * mw-underline-always
|
|
|
|
|
// * mw-underline-never
|
|
|
|
|
$bodyClasses[] = 'mw-underline-' . ( $underline ? 'always' : 'never' );
|
|
|
|
|
}
|
|
|
|
|
|
2011-11-21 16:13:21 +00:00
|
|
|
if ( $this->getLanguage()->capitalizeAllNouns() ) {
|
2010-01-15 01:16:52 +00:00
|
|
|
# A <body> class is probably not the best way to do this . . .
|
2013-04-22 13:57:44 +00:00
|
|
|
$bodyClasses[] = 'capitalize-all-nouns';
|
2010-01-15 01:16:52 +00:00
|
|
|
}
|
|
|
|
|
|
Hide marked empty elements by default (stage 1)
We originally imagined rolling out the display of empty elements
simultaneously with the Html5Depurate, but now we have added support for
marking empty elements to Html5Depurate and plan on having some sort of
longer migration period. So, move the relevant CSS to content.css, and
remove the concept of CSS dependant on tidy driver.
Add a body class which will allow the effect to be toggled in a gadget or
extension. Actual toggling in the CSS will be in the stage 2 patch, to be
deployed after the varnish cache and parser cache have expired.
I originally imagined that there would be a gadget that overrides the
rule with an !important selector, but that method does not allow you to
recover the original display property, which is often overridden by the
style attribute or site CSS to be "inline".
Also, in RaggettWrapper, switch to the new class mw-empty-elt, following
Html5Depurate, instead of mw-empty-li. The old class will be removed in
the stage 2 patch.
Change-Id: Ic0f432c43a006629ca5a1a7c2dda3552ceb4dc4f
2016-07-13 02:01:59 +00:00
|
|
|
// Parser feature migration class
|
|
|
|
|
// The idea is that this will eventually be removed, after the wikitext
|
|
|
|
|
// which requires it is cleaned up.
|
|
|
|
|
$bodyClasses[] = 'mw-hide-empty-elt';
|
|
|
|
|
|
2013-04-22 13:57:44 +00:00
|
|
|
$bodyClasses[] = $sk->getPageClasses( $this->getTitle() );
|
|
|
|
|
$bodyClasses[] = 'skin-' . Sanitizer::escapeClass( $sk->getSkinName() );
|
2014-05-11 01:54:15 +00:00
|
|
|
$bodyClasses[] =
|
|
|
|
|
'action-' . Sanitizer::escapeClass( Action::getActionName( $this->getContext() ) );
|
2013-04-22 13:57:44 +00:00
|
|
|
|
2016-02-17 09:09:32 +00:00
|
|
|
$bodyAttrs = [];
|
2013-04-22 13:57:44 +00:00
|
|
|
// 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 );
|
2016-02-17 09:09:32 +00:00
|
|
|
Hooks::run( 'OutputPageBodyAttributes', [ $this, $sk, &$bodyAttrs ] );
|
2010-10-03 14:12:41 +00:00
|
|
|
|
2016-07-07 19:26:36 +00:00
|
|
|
$pieces[] = Html::openElement( 'body', $bodyAttrs );
|
2010-01-15 01:16:52 +00:00
|
|
|
|
resourceloader: Move queue formatting out of OutputPage
HTML formatting of the queue was distributed over several OutputPage methods.
Each method demanding a snippet of HTML by calling makeResourceLoaderLink()
with a limited amount of information. As such, makeResourceLoaderLink() was
unable to provide the client with the proper state information.
Centralising it also allows it to better reduce duplication in HTML output
and maintain a more accurate state.
Problems fixed by centralising:
1. The 'user' module is special (due to per-user 'version' and 'user' params).
It is manually requested via script-src. To avoid a separate (and wrong)
request from something that requires it, we set state=loading directly.
However, because the module is in the bottom, the old HTML formatter could
only put state=loading in the bottom also. This sometimes caused a wrong
request to be fired for modules=user if something in the top queue
triggered a requirement for it.
2. Since a464d1d4 (T87871) we track states of page-style modules, with purpose
of allowing dependencies on style modules without risking duplicate loading
on pages where the styles are loaded already. This didn't work, because the
state information about page-style modules is output near the stylesheet,
which is after the script tag with mw.loader.load(). That runs first, and
mw.loader would still make a duplicate request before it learns the state.
Changes:
* Document reasons for style/script tag order in getHeadHtml (per 09537e83).
* Pass $type from getModuleStyles() to getAllowedModules(). This wasn't needed
before since a duplicate check in makeResourceLoaderLink() verified the
origin a second time.
* Declare explicit position 'top' on 'user.options' and 'user.tokens' module.
Previously, OutputPage hardcoded them in the top. The new formatter doesn't.
* Remove getHeadScripts().
* Remove getInlineHeadScripts().
* Remove getExternalHeadScripts().
* Remove buildCssLinks().
* Remove getScriptsForBottomQueue().
* Change where Skin::setupSkinUserCss() is called. This methods lets the skin
add modules to the queue. Previously it was called from buildCssLinks(),
via headElement(), via prepareQuickTemplate(), via OutputPage::output().
It's now in OutputPage::output() directly (slightly earlier). This is needed
because prepareQuickTemplate() calls bottomScripts() before headElement().
And bottomScript() would lazy-initialise the queue and lock it before
setupSkinUserCss() is called from headElement().
This makes execution order more predictable instead of being dependent on
the arbitrary order of data extraction in prepareQuickTemplate (which varies
from one skin to another).
* Compute isUserModulePreview() and isKnownEmpty() for the 'user' module early
on so. This avoids wrongful loading and fixes problem 1.
Effective changes in output:
* mw.loader.state() is now before mw.loader.load(). This fixes problem 2.
* mw.loader.state() now sets 'user.options' and 'user.tokens' to "loading".
* mw.loader.state() now sets 'user' (as "loading" or "ready"). Fixes problem 1.
* The <script async src> tag for 'startup' changed position (slightly).
Previously it was after all inline scripts and stylesheets. It's still after
all inline scripts and after most stylesheets, but before any user styles.
Since the queue is now formatted outside OutputPage, it can't inject the
meta-ResourceLoaderDynamicStyles tag and user-stylesheet hack in the middle
of existing output. This shouldn't have any noticable impact.
Bug: T87871
Change-Id: I605b8cd1e1fc009b4662a0edbc54d09dd65ee1df
2016-07-15 14:13:09 +00:00
|
|
|
return self::combineWrappedStrings( $pieces );
|
2004-04-09 04:53:52 +00:00
|
|
|
}
|
2010-10-02 13:45:35 +00:00
|
|
|
|
* Made Resources.php return a pure-data array instead of an ugly mix of data and code. This allows the class code to be lazy-loaded with the autoloader, for a performance advantage especially on non-APC installs. And using the convention where if the class is omitted, ResourceLoaderFileModule is assumed, the registration code becomes shorter and simpler.
* Modified ResourceLoader to lazy-initialise module objects, for a further performance advantage.
* Deleted ResourceLoader::getModules(), provided getModuleNames() instead. Although the startup module needs this functionality, it's slow to generate, so to avoid misuse, it's better to provide a foolproof fast interface and let the startup module do the slow thing itself.
* Modified ResourceLoader::register() to optionally accept an info array instead of an object.
* Added $wgResourceModules, allowing extensions to efficiently define their own resource loader modules. The trouble with hooks is that they contain code, and code is slow. We've been through all this before with i18n. Hooks are useful as a performance tool only if you call them very rarely.
* Moved ResourceLoader settings to their own section in DefaultSettings.php
* Added options to ResourceLoaderFileModule equivalent to the $localBasePath and $remoteBasePath parameters, to allow it to be instantiated via the new array style. Also added remoteExtPath, which allows modules to be registered before $wgExtensionAssetsPath is known.
* Added OutputPage::getResourceLoader(), mostly for debugging.
* The time saving at the moment is about 5ms per request with no extensions, which is significant already with 6 load.php requests for a cold cache page view. This is a much more scalable interface; the relative saving will grow as more extensions are added which use this interface, especially for non-APC installs.
Although the interface is backwards compatible, extension updates will follow in a subsequent commit.
2010-11-19 10:41:06 +00:00
|
|
|
/**
|
|
|
|
|
* Get a ResourceLoader object associated with this OutputPage
|
2011-02-21 17:12:33 +00:00
|
|
|
*
|
|
|
|
|
* @return ResourceLoader
|
* Made Resources.php return a pure-data array instead of an ugly mix of data and code. This allows the class code to be lazy-loaded with the autoloader, for a performance advantage especially on non-APC installs. And using the convention where if the class is omitted, ResourceLoaderFileModule is assumed, the registration code becomes shorter and simpler.
* Modified ResourceLoader to lazy-initialise module objects, for a further performance advantage.
* Deleted ResourceLoader::getModules(), provided getModuleNames() instead. Although the startup module needs this functionality, it's slow to generate, so to avoid misuse, it's better to provide a foolproof fast interface and let the startup module do the slow thing itself.
* Modified ResourceLoader::register() to optionally accept an info array instead of an object.
* Added $wgResourceModules, allowing extensions to efficiently define their own resource loader modules. The trouble with hooks is that they contain code, and code is slow. We've been through all this before with i18n. Hooks are useful as a performance tool only if you call them very rarely.
* Moved ResourceLoader settings to their own section in DefaultSettings.php
* Added options to ResourceLoaderFileModule equivalent to the $localBasePath and $remoteBasePath parameters, to allow it to be instantiated via the new array style. Also added remoteExtPath, which allows modules to be registered before $wgExtensionAssetsPath is known.
* Added OutputPage::getResourceLoader(), mostly for debugging.
* The time saving at the moment is about 5ms per request with no extensions, which is significant already with 6 load.php requests for a cold cache page view. This is a much more scalable interface; the relative saving will grow as more extensions are added which use this interface, especially for non-APC installs.
Although the interface is backwards compatible, extension updates will follow in a subsequent commit.
2010-11-19 10:41:06 +00:00
|
|
|
*/
|
|
|
|
|
public function getResourceLoader() {
|
|
|
|
|
if ( is_null( $this->mResourceLoader ) ) {
|
2015-06-04 03:52:45 +00:00
|
|
|
$this->mResourceLoader = new ResourceLoader(
|
|
|
|
|
$this->getConfig(),
|
|
|
|
|
LoggerFactory::getInstance( 'resourceloader' )
|
|
|
|
|
);
|
* Made Resources.php return a pure-data array instead of an ugly mix of data and code. This allows the class code to be lazy-loaded with the autoloader, for a performance advantage especially on non-APC installs. And using the convention where if the class is omitted, ResourceLoaderFileModule is assumed, the registration code becomes shorter and simpler.
* Modified ResourceLoader to lazy-initialise module objects, for a further performance advantage.
* Deleted ResourceLoader::getModules(), provided getModuleNames() instead. Although the startup module needs this functionality, it's slow to generate, so to avoid misuse, it's better to provide a foolproof fast interface and let the startup module do the slow thing itself.
* Modified ResourceLoader::register() to optionally accept an info array instead of an object.
* Added $wgResourceModules, allowing extensions to efficiently define their own resource loader modules. The trouble with hooks is that they contain code, and code is slow. We've been through all this before with i18n. Hooks are useful as a performance tool only if you call them very rarely.
* Moved ResourceLoader settings to their own section in DefaultSettings.php
* Added options to ResourceLoaderFileModule equivalent to the $localBasePath and $remoteBasePath parameters, to allow it to be instantiated via the new array style. Also added remoteExtPath, which allows modules to be registered before $wgExtensionAssetsPath is known.
* Added OutputPage::getResourceLoader(), mostly for debugging.
* The time saving at the moment is about 5ms per request with no extensions, which is significant already with 6 load.php requests for a cold cache page view. This is a much more scalable interface; the relative saving will grow as more extensions are added which use this interface, especially for non-APC installs.
Although the interface is backwards compatible, extension updates will follow in a subsequent commit.
2010-11-19 10:41:06 +00:00
|
|
|
}
|
|
|
|
|
return $this->mResourceLoader;
|
2011-04-23 19:28:35 +00:00
|
|
|
}
|
* Made Resources.php return a pure-data array instead of an ugly mix of data and code. This allows the class code to be lazy-loaded with the autoloader, for a performance advantage especially on non-APC installs. And using the convention where if the class is omitted, ResourceLoaderFileModule is assumed, the registration code becomes shorter and simpler.
* Modified ResourceLoader to lazy-initialise module objects, for a further performance advantage.
* Deleted ResourceLoader::getModules(), provided getModuleNames() instead. Although the startup module needs this functionality, it's slow to generate, so to avoid misuse, it's better to provide a foolproof fast interface and let the startup module do the slow thing itself.
* Modified ResourceLoader::register() to optionally accept an info array instead of an object.
* Added $wgResourceModules, allowing extensions to efficiently define their own resource loader modules. The trouble with hooks is that they contain code, and code is slow. We've been through all this before with i18n. Hooks are useful as a performance tool only if you call them very rarely.
* Moved ResourceLoader settings to their own section in DefaultSettings.php
* Added options to ResourceLoaderFileModule equivalent to the $localBasePath and $remoteBasePath parameters, to allow it to be instantiated via the new array style. Also added remoteExtPath, which allows modules to be registered before $wgExtensionAssetsPath is known.
* Added OutputPage::getResourceLoader(), mostly for debugging.
* The time saving at the moment is about 5ms per request with no extensions, which is significant already with 6 load.php requests for a cold cache page view. This is a much more scalable interface; the relative saving will grow as more extensions are added which use this interface, especially for non-APC installs.
Although the interface is backwards compatible, extension updates will follow in a subsequent commit.
2010-11-19 10:41:06 +00:00
|
|
|
|
2010-11-06 18:52:32 +00:00
|
|
|
/**
|
resourceloader: Move queue formatting out of OutputPage
HTML formatting of the queue was distributed over several OutputPage methods.
Each method demanding a snippet of HTML by calling makeResourceLoaderLink()
with a limited amount of information. As such, makeResourceLoaderLink() was
unable to provide the client with the proper state information.
Centralising it also allows it to better reduce duplication in HTML output
and maintain a more accurate state.
Problems fixed by centralising:
1. The 'user' module is special (due to per-user 'version' and 'user' params).
It is manually requested via script-src. To avoid a separate (and wrong)
request from something that requires it, we set state=loading directly.
However, because the module is in the bottom, the old HTML formatter could
only put state=loading in the bottom also. This sometimes caused a wrong
request to be fired for modules=user if something in the top queue
triggered a requirement for it.
2. Since a464d1d4 (T87871) we track states of page-style modules, with purpose
of allowing dependencies on style modules without risking duplicate loading
on pages where the styles are loaded already. This didn't work, because the
state information about page-style modules is output near the stylesheet,
which is after the script tag with mw.loader.load(). That runs first, and
mw.loader would still make a duplicate request before it learns the state.
Changes:
* Document reasons for style/script tag order in getHeadHtml (per 09537e83).
* Pass $type from getModuleStyles() to getAllowedModules(). This wasn't needed
before since a duplicate check in makeResourceLoaderLink() verified the
origin a second time.
* Declare explicit position 'top' on 'user.options' and 'user.tokens' module.
Previously, OutputPage hardcoded them in the top. The new formatter doesn't.
* Remove getHeadScripts().
* Remove getInlineHeadScripts().
* Remove getExternalHeadScripts().
* Remove buildCssLinks().
* Remove getScriptsForBottomQueue().
* Change where Skin::setupSkinUserCss() is called. This methods lets the skin
add modules to the queue. Previously it was called from buildCssLinks(),
via headElement(), via prepareQuickTemplate(), via OutputPage::output().
It's now in OutputPage::output() directly (slightly earlier). This is needed
because prepareQuickTemplate() calls bottomScripts() before headElement().
And bottomScript() would lazy-initialise the queue and lock it before
setupSkinUserCss() is called from headElement().
This makes execution order more predictable instead of being dependent on
the arbitrary order of data extraction in prepareQuickTemplate (which varies
from one skin to another).
* Compute isUserModulePreview() and isKnownEmpty() for the 'user' module early
on so. This avoids wrongful loading and fixes problem 1.
Effective changes in output:
* mw.loader.state() is now before mw.loader.load(). This fixes problem 2.
* mw.loader.state() now sets 'user.options' and 'user.tokens' to "loading".
* mw.loader.state() now sets 'user' (as "loading" or "ready"). Fixes problem 1.
* The <script async src> tag for 'startup' changed position (slightly).
Previously it was after all inline scripts and stylesheets. It's still after
all inline scripts and after most stylesheets, but before any user styles.
Since the queue is now formatted outside OutputPage, it can't inject the
meta-ResourceLoaderDynamicStyles tag and user-stylesheet hack in the middle
of existing output. This shouldn't have any noticable impact.
Bug: T87871
Change-Id: I605b8cd1e1fc009b4662a0edbc54d09dd65ee1df
2016-07-15 14:13:09 +00:00
|
|
|
* Explicily load or embed modules on a page.
|
2015-07-28 02:46:00 +00:00
|
|
|
*
|
2013-11-14 16:54:19 +00:00
|
|
|
* @param array|string $modules One or more module names
|
2013-03-11 17:15:01 +00:00
|
|
|
* @param string $only ResourceLoaderModule TYPE_ class constant
|
2015-07-28 02:46:00 +00:00
|
|
|
* @param array $extraQuery [optional] Array with extra query parameters for the request
|
resourceloader: Move queue formatting out of OutputPage
HTML formatting of the queue was distributed over several OutputPage methods.
Each method demanding a snippet of HTML by calling makeResourceLoaderLink()
with a limited amount of information. As such, makeResourceLoaderLink() was
unable to provide the client with the proper state information.
Centralising it also allows it to better reduce duplication in HTML output
and maintain a more accurate state.
Problems fixed by centralising:
1. The 'user' module is special (due to per-user 'version' and 'user' params).
It is manually requested via script-src. To avoid a separate (and wrong)
request from something that requires it, we set state=loading directly.
However, because the module is in the bottom, the old HTML formatter could
only put state=loading in the bottom also. This sometimes caused a wrong
request to be fired for modules=user if something in the top queue
triggered a requirement for it.
2. Since a464d1d4 (T87871) we track states of page-style modules, with purpose
of allowing dependencies on style modules without risking duplicate loading
on pages where the styles are loaded already. This didn't work, because the
state information about page-style modules is output near the stylesheet,
which is after the script tag with mw.loader.load(). That runs first, and
mw.loader would still make a duplicate request before it learns the state.
Changes:
* Document reasons for style/script tag order in getHeadHtml (per 09537e83).
* Pass $type from getModuleStyles() to getAllowedModules(). This wasn't needed
before since a duplicate check in makeResourceLoaderLink() verified the
origin a second time.
* Declare explicit position 'top' on 'user.options' and 'user.tokens' module.
Previously, OutputPage hardcoded them in the top. The new formatter doesn't.
* Remove getHeadScripts().
* Remove getInlineHeadScripts().
* Remove getExternalHeadScripts().
* Remove buildCssLinks().
* Remove getScriptsForBottomQueue().
* Change where Skin::setupSkinUserCss() is called. This methods lets the skin
add modules to the queue. Previously it was called from buildCssLinks(),
via headElement(), via prepareQuickTemplate(), via OutputPage::output().
It's now in OutputPage::output() directly (slightly earlier). This is needed
because prepareQuickTemplate() calls bottomScripts() before headElement().
And bottomScript() would lazy-initialise the queue and lock it before
setupSkinUserCss() is called from headElement().
This makes execution order more predictable instead of being dependent on
the arbitrary order of data extraction in prepareQuickTemplate (which varies
from one skin to another).
* Compute isUserModulePreview() and isKnownEmpty() for the 'user' module early
on so. This avoids wrongful loading and fixes problem 1.
Effective changes in output:
* mw.loader.state() is now before mw.loader.load(). This fixes problem 2.
* mw.loader.state() now sets 'user.options' and 'user.tokens' to "loading".
* mw.loader.state() now sets 'user' (as "loading" or "ready"). Fixes problem 1.
* The <script async src> tag for 'startup' changed position (slightly).
Previously it was after all inline scripts and stylesheets. It's still after
all inline scripts and after most stylesheets, but before any user styles.
Since the queue is now formatted outside OutputPage, it can't inject the
meta-ResourceLoaderDynamicStyles tag and user-stylesheet hack in the middle
of existing output. This shouldn't have any noticable impact.
Bug: T87871
Change-Id: I605b8cd1e1fc009b4662a0edbc54d09dd65ee1df
2016-07-15 14:13:09 +00:00
|
|
|
* @return string|WrappedStringList HTML
|
2015-07-28 02:46:00 +00:00
|
|
|
*/
|
2016-02-17 09:09:32 +00:00
|
|
|
public function makeResourceLoaderLink( $modules, $only, array $extraQuery = [] ) {
|
2016-08-16 22:25:08 +00:00
|
|
|
// Apply 'target' and 'origin' filters
|
|
|
|
|
$modules = $this->filterModules( (array)$modules, null, $only );
|
|
|
|
|
|
resourceloader: Move queue formatting out of OutputPage
HTML formatting of the queue was distributed over several OutputPage methods.
Each method demanding a snippet of HTML by calling makeResourceLoaderLink()
with a limited amount of information. As such, makeResourceLoaderLink() was
unable to provide the client with the proper state information.
Centralising it also allows it to better reduce duplication in HTML output
and maintain a more accurate state.
Problems fixed by centralising:
1. The 'user' module is special (due to per-user 'version' and 'user' params).
It is manually requested via script-src. To avoid a separate (and wrong)
request from something that requires it, we set state=loading directly.
However, because the module is in the bottom, the old HTML formatter could
only put state=loading in the bottom also. This sometimes caused a wrong
request to be fired for modules=user if something in the top queue
triggered a requirement for it.
2. Since a464d1d4 (T87871) we track states of page-style modules, with purpose
of allowing dependencies on style modules without risking duplicate loading
on pages where the styles are loaded already. This didn't work, because the
state information about page-style modules is output near the stylesheet,
which is after the script tag with mw.loader.load(). That runs first, and
mw.loader would still make a duplicate request before it learns the state.
Changes:
* Document reasons for style/script tag order in getHeadHtml (per 09537e83).
* Pass $type from getModuleStyles() to getAllowedModules(). This wasn't needed
before since a duplicate check in makeResourceLoaderLink() verified the
origin a second time.
* Declare explicit position 'top' on 'user.options' and 'user.tokens' module.
Previously, OutputPage hardcoded them in the top. The new formatter doesn't.
* Remove getHeadScripts().
* Remove getInlineHeadScripts().
* Remove getExternalHeadScripts().
* Remove buildCssLinks().
* Remove getScriptsForBottomQueue().
* Change where Skin::setupSkinUserCss() is called. This methods lets the skin
add modules to the queue. Previously it was called from buildCssLinks(),
via headElement(), via prepareQuickTemplate(), via OutputPage::output().
It's now in OutputPage::output() directly (slightly earlier). This is needed
because prepareQuickTemplate() calls bottomScripts() before headElement().
And bottomScript() would lazy-initialise the queue and lock it before
setupSkinUserCss() is called from headElement().
This makes execution order more predictable instead of being dependent on
the arbitrary order of data extraction in prepareQuickTemplate (which varies
from one skin to another).
* Compute isUserModulePreview() and isKnownEmpty() for the 'user' module early
on so. This avoids wrongful loading and fixes problem 1.
Effective changes in output:
* mw.loader.state() is now before mw.loader.load(). This fixes problem 2.
* mw.loader.state() now sets 'user.options' and 'user.tokens' to "loading".
* mw.loader.state() now sets 'user' (as "loading" or "ready"). Fixes problem 1.
* The <script async src> tag for 'startup' changed position (slightly).
Previously it was after all inline scripts and stylesheets. It's still after
all inline scripts and after most stylesheets, but before any user styles.
Since the queue is now formatted outside OutputPage, it can't inject the
meta-ResourceLoaderDynamicStyles tag and user-stylesheet hack in the middle
of existing output. This shouldn't have any noticable impact.
Bug: T87871
Change-Id: I605b8cd1e1fc009b4662a0edbc54d09dd65ee1df
2016-07-15 14:13:09 +00:00
|
|
|
return ResourceLoaderClientHtml::makeLoad(
|
|
|
|
|
$this->getRlClientContext(),
|
2016-08-16 22:25:08 +00:00
|
|
|
$modules,
|
resourceloader: Move queue formatting out of OutputPage
HTML formatting of the queue was distributed over several OutputPage methods.
Each method demanding a snippet of HTML by calling makeResourceLoaderLink()
with a limited amount of information. As such, makeResourceLoaderLink() was
unable to provide the client with the proper state information.
Centralising it also allows it to better reduce duplication in HTML output
and maintain a more accurate state.
Problems fixed by centralising:
1. The 'user' module is special (due to per-user 'version' and 'user' params).
It is manually requested via script-src. To avoid a separate (and wrong)
request from something that requires it, we set state=loading directly.
However, because the module is in the bottom, the old HTML formatter could
only put state=loading in the bottom also. This sometimes caused a wrong
request to be fired for modules=user if something in the top queue
triggered a requirement for it.
2. Since a464d1d4 (T87871) we track states of page-style modules, with purpose
of allowing dependencies on style modules without risking duplicate loading
on pages where the styles are loaded already. This didn't work, because the
state information about page-style modules is output near the stylesheet,
which is after the script tag with mw.loader.load(). That runs first, and
mw.loader would still make a duplicate request before it learns the state.
Changes:
* Document reasons for style/script tag order in getHeadHtml (per 09537e83).
* Pass $type from getModuleStyles() to getAllowedModules(). This wasn't needed
before since a duplicate check in makeResourceLoaderLink() verified the
origin a second time.
* Declare explicit position 'top' on 'user.options' and 'user.tokens' module.
Previously, OutputPage hardcoded them in the top. The new formatter doesn't.
* Remove getHeadScripts().
* Remove getInlineHeadScripts().
* Remove getExternalHeadScripts().
* Remove buildCssLinks().
* Remove getScriptsForBottomQueue().
* Change where Skin::setupSkinUserCss() is called. This methods lets the skin
add modules to the queue. Previously it was called from buildCssLinks(),
via headElement(), via prepareQuickTemplate(), via OutputPage::output().
It's now in OutputPage::output() directly (slightly earlier). This is needed
because prepareQuickTemplate() calls bottomScripts() before headElement().
And bottomScript() would lazy-initialise the queue and lock it before
setupSkinUserCss() is called from headElement().
This makes execution order more predictable instead of being dependent on
the arbitrary order of data extraction in prepareQuickTemplate (which varies
from one skin to another).
* Compute isUserModulePreview() and isKnownEmpty() for the 'user' module early
on so. This avoids wrongful loading and fixes problem 1.
Effective changes in output:
* mw.loader.state() is now before mw.loader.load(). This fixes problem 2.
* mw.loader.state() now sets 'user.options' and 'user.tokens' to "loading".
* mw.loader.state() now sets 'user' (as "loading" or "ready"). Fixes problem 1.
* The <script async src> tag for 'startup' changed position (slightly).
Previously it was after all inline scripts and stylesheets. It's still after
all inline scripts and after most stylesheets, but before any user styles.
Since the queue is now formatted outside OutputPage, it can't inject the
meta-ResourceLoaderDynamicStyles tag and user-stylesheet hack in the middle
of existing output. This shouldn't have any noticable impact.
Bug: T87871
Change-Id: I605b8cd1e1fc009b4662a0edbc54d09dd65ee1df
2016-07-15 14:13:09 +00:00
|
|
|
$only,
|
|
|
|
|
$extraQuery
|
|
|
|
|
);
|
2010-09-04 04:00:09 +00:00
|
|
|
}
|
2010-10-02 13:45:35 +00:00
|
|
|
|
2013-11-14 16:54:19 +00:00
|
|
|
/**
|
resourceloader: Move queue formatting out of OutputPage
HTML formatting of the queue was distributed over several OutputPage methods.
Each method demanding a snippet of HTML by calling makeResourceLoaderLink()
with a limited amount of information. As such, makeResourceLoaderLink() was
unable to provide the client with the proper state information.
Centralising it also allows it to better reduce duplication in HTML output
and maintain a more accurate state.
Problems fixed by centralising:
1. The 'user' module is special (due to per-user 'version' and 'user' params).
It is manually requested via script-src. To avoid a separate (and wrong)
request from something that requires it, we set state=loading directly.
However, because the module is in the bottom, the old HTML formatter could
only put state=loading in the bottom also. This sometimes caused a wrong
request to be fired for modules=user if something in the top queue
triggered a requirement for it.
2. Since a464d1d4 (T87871) we track states of page-style modules, with purpose
of allowing dependencies on style modules without risking duplicate loading
on pages where the styles are loaded already. This didn't work, because the
state information about page-style modules is output near the stylesheet,
which is after the script tag with mw.loader.load(). That runs first, and
mw.loader would still make a duplicate request before it learns the state.
Changes:
* Document reasons for style/script tag order in getHeadHtml (per 09537e83).
* Pass $type from getModuleStyles() to getAllowedModules(). This wasn't needed
before since a duplicate check in makeResourceLoaderLink() verified the
origin a second time.
* Declare explicit position 'top' on 'user.options' and 'user.tokens' module.
Previously, OutputPage hardcoded them in the top. The new formatter doesn't.
* Remove getHeadScripts().
* Remove getInlineHeadScripts().
* Remove getExternalHeadScripts().
* Remove buildCssLinks().
* Remove getScriptsForBottomQueue().
* Change where Skin::setupSkinUserCss() is called. This methods lets the skin
add modules to the queue. Previously it was called from buildCssLinks(),
via headElement(), via prepareQuickTemplate(), via OutputPage::output().
It's now in OutputPage::output() directly (slightly earlier). This is needed
because prepareQuickTemplate() calls bottomScripts() before headElement().
And bottomScript() would lazy-initialise the queue and lock it before
setupSkinUserCss() is called from headElement().
This makes execution order more predictable instead of being dependent on
the arbitrary order of data extraction in prepareQuickTemplate (which varies
from one skin to another).
* Compute isUserModulePreview() and isKnownEmpty() for the 'user' module early
on so. This avoids wrongful loading and fixes problem 1.
Effective changes in output:
* mw.loader.state() is now before mw.loader.load(). This fixes problem 2.
* mw.loader.state() now sets 'user.options' and 'user.tokens' to "loading".
* mw.loader.state() now sets 'user' (as "loading" or "ready"). Fixes problem 1.
* The <script async src> tag for 'startup' changed position (slightly).
Previously it was after all inline scripts and stylesheets. It's still after
all inline scripts and after most stylesheets, but before any user styles.
Since the queue is now formatted outside OutputPage, it can't inject the
meta-ResourceLoaderDynamicStyles tag and user-stylesheet hack in the middle
of existing output. This shouldn't have any noticable impact.
Bug: T87871
Change-Id: I605b8cd1e1fc009b4662a0edbc54d09dd65ee1df
2016-07-15 14:13:09 +00:00
|
|
|
* Combine WrappedString chunks and filter out empty ones
|
|
|
|
|
*
|
|
|
|
|
* @param array $chunks
|
2016-07-07 19:26:36 +00:00
|
|
|
* @return string|WrappedStringList HTML
|
2013-11-14 16:54:19 +00:00
|
|
|
*/
|
resourceloader: Move queue formatting out of OutputPage
HTML formatting of the queue was distributed over several OutputPage methods.
Each method demanding a snippet of HTML by calling makeResourceLoaderLink()
with a limited amount of information. As such, makeResourceLoaderLink() was
unable to provide the client with the proper state information.
Centralising it also allows it to better reduce duplication in HTML output
and maintain a more accurate state.
Problems fixed by centralising:
1. The 'user' module is special (due to per-user 'version' and 'user' params).
It is manually requested via script-src. To avoid a separate (and wrong)
request from something that requires it, we set state=loading directly.
However, because the module is in the bottom, the old HTML formatter could
only put state=loading in the bottom also. This sometimes caused a wrong
request to be fired for modules=user if something in the top queue
triggered a requirement for it.
2. Since a464d1d4 (T87871) we track states of page-style modules, with purpose
of allowing dependencies on style modules without risking duplicate loading
on pages where the styles are loaded already. This didn't work, because the
state information about page-style modules is output near the stylesheet,
which is after the script tag with mw.loader.load(). That runs first, and
mw.loader would still make a duplicate request before it learns the state.
Changes:
* Document reasons for style/script tag order in getHeadHtml (per 09537e83).
* Pass $type from getModuleStyles() to getAllowedModules(). This wasn't needed
before since a duplicate check in makeResourceLoaderLink() verified the
origin a second time.
* Declare explicit position 'top' on 'user.options' and 'user.tokens' module.
Previously, OutputPage hardcoded them in the top. The new formatter doesn't.
* Remove getHeadScripts().
* Remove getInlineHeadScripts().
* Remove getExternalHeadScripts().
* Remove buildCssLinks().
* Remove getScriptsForBottomQueue().
* Change where Skin::setupSkinUserCss() is called. This methods lets the skin
add modules to the queue. Previously it was called from buildCssLinks(),
via headElement(), via prepareQuickTemplate(), via OutputPage::output().
It's now in OutputPage::output() directly (slightly earlier). This is needed
because prepareQuickTemplate() calls bottomScripts() before headElement().
And bottomScript() would lazy-initialise the queue and lock it before
setupSkinUserCss() is called from headElement().
This makes execution order more predictable instead of being dependent on
the arbitrary order of data extraction in prepareQuickTemplate (which varies
from one skin to another).
* Compute isUserModulePreview() and isKnownEmpty() for the 'user' module early
on so. This avoids wrongful loading and fixes problem 1.
Effective changes in output:
* mw.loader.state() is now before mw.loader.load(). This fixes problem 2.
* mw.loader.state() now sets 'user.options' and 'user.tokens' to "loading".
* mw.loader.state() now sets 'user' (as "loading" or "ready"). Fixes problem 1.
* The <script async src> tag for 'startup' changed position (slightly).
Previously it was after all inline scripts and stylesheets. It's still after
all inline scripts and after most stylesheets, but before any user styles.
Since the queue is now formatted outside OutputPage, it can't inject the
meta-ResourceLoaderDynamicStyles tag and user-stylesheet hack in the middle
of existing output. This shouldn't have any noticable impact.
Bug: T87871
Change-Id: I605b8cd1e1fc009b4662a0edbc54d09dd65ee1df
2016-07-15 14:13:09 +00:00
|
|
|
protected static function combineWrappedStrings( array $chunks ) {
|
2015-07-31 00:13:04 +00:00
|
|
|
// Filter out empty values
|
resourceloader: Move queue formatting out of OutputPage
HTML formatting of the queue was distributed over several OutputPage methods.
Each method demanding a snippet of HTML by calling makeResourceLoaderLink()
with a limited amount of information. As such, makeResourceLoaderLink() was
unable to provide the client with the proper state information.
Centralising it also allows it to better reduce duplication in HTML output
and maintain a more accurate state.
Problems fixed by centralising:
1. The 'user' module is special (due to per-user 'version' and 'user' params).
It is manually requested via script-src. To avoid a separate (and wrong)
request from something that requires it, we set state=loading directly.
However, because the module is in the bottom, the old HTML formatter could
only put state=loading in the bottom also. This sometimes caused a wrong
request to be fired for modules=user if something in the top queue
triggered a requirement for it.
2. Since a464d1d4 (T87871) we track states of page-style modules, with purpose
of allowing dependencies on style modules without risking duplicate loading
on pages where the styles are loaded already. This didn't work, because the
state information about page-style modules is output near the stylesheet,
which is after the script tag with mw.loader.load(). That runs first, and
mw.loader would still make a duplicate request before it learns the state.
Changes:
* Document reasons for style/script tag order in getHeadHtml (per 09537e83).
* Pass $type from getModuleStyles() to getAllowedModules(). This wasn't needed
before since a duplicate check in makeResourceLoaderLink() verified the
origin a second time.
* Declare explicit position 'top' on 'user.options' and 'user.tokens' module.
Previously, OutputPage hardcoded them in the top. The new formatter doesn't.
* Remove getHeadScripts().
* Remove getInlineHeadScripts().
* Remove getExternalHeadScripts().
* Remove buildCssLinks().
* Remove getScriptsForBottomQueue().
* Change where Skin::setupSkinUserCss() is called. This methods lets the skin
add modules to the queue. Previously it was called from buildCssLinks(),
via headElement(), via prepareQuickTemplate(), via OutputPage::output().
It's now in OutputPage::output() directly (slightly earlier). This is needed
because prepareQuickTemplate() calls bottomScripts() before headElement().
And bottomScript() would lazy-initialise the queue and lock it before
setupSkinUserCss() is called from headElement().
This makes execution order more predictable instead of being dependent on
the arbitrary order of data extraction in prepareQuickTemplate (which varies
from one skin to another).
* Compute isUserModulePreview() and isKnownEmpty() for the 'user' module early
on so. This avoids wrongful loading and fixes problem 1.
Effective changes in output:
* mw.loader.state() is now before mw.loader.load(). This fixes problem 2.
* mw.loader.state() now sets 'user.options' and 'user.tokens' to "loading".
* mw.loader.state() now sets 'user' (as "loading" or "ready"). Fixes problem 1.
* The <script async src> tag for 'startup' changed position (slightly).
Previously it was after all inline scripts and stylesheets. It's still after
all inline scripts and after most stylesheets, but before any user styles.
Since the queue is now formatted outside OutputPage, it can't inject the
meta-ResourceLoaderDynamicStyles tag and user-stylesheet hack in the middle
of existing output. This shouldn't have any noticable impact.
Bug: T87871
Change-Id: I605b8cd1e1fc009b4662a0edbc54d09dd65ee1df
2016-07-15 14:13:09 +00:00
|
|
|
$chunks = array_filter( $chunks, 'strlen' );
|
|
|
|
|
return WrappedString::join( "\n", $chunks );
|
2013-11-14 16:54:19 +00:00
|
|
|
}
|
|
|
|
|
|
2016-08-19 02:04:21 +00:00
|
|
|
private function isUserJsPreview() {
|
resourceloader: Move queue formatting out of OutputPage
HTML formatting of the queue was distributed over several OutputPage methods.
Each method demanding a snippet of HTML by calling makeResourceLoaderLink()
with a limited amount of information. As such, makeResourceLoaderLink() was
unable to provide the client with the proper state information.
Centralising it also allows it to better reduce duplication in HTML output
and maintain a more accurate state.
Problems fixed by centralising:
1. The 'user' module is special (due to per-user 'version' and 'user' params).
It is manually requested via script-src. To avoid a separate (and wrong)
request from something that requires it, we set state=loading directly.
However, because the module is in the bottom, the old HTML formatter could
only put state=loading in the bottom also. This sometimes caused a wrong
request to be fired for modules=user if something in the top queue
triggered a requirement for it.
2. Since a464d1d4 (T87871) we track states of page-style modules, with purpose
of allowing dependencies on style modules without risking duplicate loading
on pages where the styles are loaded already. This didn't work, because the
state information about page-style modules is output near the stylesheet,
which is after the script tag with mw.loader.load(). That runs first, and
mw.loader would still make a duplicate request before it learns the state.
Changes:
* Document reasons for style/script tag order in getHeadHtml (per 09537e83).
* Pass $type from getModuleStyles() to getAllowedModules(). This wasn't needed
before since a duplicate check in makeResourceLoaderLink() verified the
origin a second time.
* Declare explicit position 'top' on 'user.options' and 'user.tokens' module.
Previously, OutputPage hardcoded them in the top. The new formatter doesn't.
* Remove getHeadScripts().
* Remove getInlineHeadScripts().
* Remove getExternalHeadScripts().
* Remove buildCssLinks().
* Remove getScriptsForBottomQueue().
* Change where Skin::setupSkinUserCss() is called. This methods lets the skin
add modules to the queue. Previously it was called from buildCssLinks(),
via headElement(), via prepareQuickTemplate(), via OutputPage::output().
It's now in OutputPage::output() directly (slightly earlier). This is needed
because prepareQuickTemplate() calls bottomScripts() before headElement().
And bottomScript() would lazy-initialise the queue and lock it before
setupSkinUserCss() is called from headElement().
This makes execution order more predictable instead of being dependent on
the arbitrary order of data extraction in prepareQuickTemplate (which varies
from one skin to another).
* Compute isUserModulePreview() and isKnownEmpty() for the 'user' module early
on so. This avoids wrongful loading and fixes problem 1.
Effective changes in output:
* mw.loader.state() is now before mw.loader.load(). This fixes problem 2.
* mw.loader.state() now sets 'user.options' and 'user.tokens' to "loading".
* mw.loader.state() now sets 'user' (as "loading" or "ready"). Fixes problem 1.
* The <script async src> tag for 'startup' changed position (slightly).
Previously it was after all inline scripts and stylesheets. It's still after
all inline scripts and after most stylesheets, but before any user styles.
Since the queue is now formatted outside OutputPage, it can't inject the
meta-ResourceLoaderDynamicStyles tag and user-stylesheet hack in the middle
of existing output. This shouldn't have any noticable impact.
Bug: T87871
Change-Id: I605b8cd1e1fc009b4662a0edbc54d09dd65ee1df
2016-07-15 14:13:09 +00:00
|
|
|
return $this->getConfig()->get( 'AllowUserJs' )
|
|
|
|
|
&& $this->getTitle()
|
|
|
|
|
&& $this->getTitle()->isJsSubpage()
|
|
|
|
|
&& $this->userCanPreview();
|
2015-08-13 21:30:31 +00:00
|
|
|
}
|
|
|
|
|
|
2017-05-12 22:20:02 +00:00
|
|
|
protected function isUserCssPreview() {
|
2016-08-19 02:04:21 +00:00
|
|
|
return $this->getConfig()->get( 'AllowUserCss' )
|
|
|
|
|
&& $this->getTitle()
|
|
|
|
|
&& $this->getTitle()->isCssSubpage()
|
|
|
|
|
&& $this->userCanPreview();
|
|
|
|
|
}
|
|
|
|
|
|
2015-08-13 21:30:31 +00:00
|
|
|
/**
|
resourceloader: Move queue formatting out of OutputPage
HTML formatting of the queue was distributed over several OutputPage methods.
Each method demanding a snippet of HTML by calling makeResourceLoaderLink()
with a limited amount of information. As such, makeResourceLoaderLink() was
unable to provide the client with the proper state information.
Centralising it also allows it to better reduce duplication in HTML output
and maintain a more accurate state.
Problems fixed by centralising:
1. The 'user' module is special (due to per-user 'version' and 'user' params).
It is manually requested via script-src. To avoid a separate (and wrong)
request from something that requires it, we set state=loading directly.
However, because the module is in the bottom, the old HTML formatter could
only put state=loading in the bottom also. This sometimes caused a wrong
request to be fired for modules=user if something in the top queue
triggered a requirement for it.
2. Since a464d1d4 (T87871) we track states of page-style modules, with purpose
of allowing dependencies on style modules without risking duplicate loading
on pages where the styles are loaded already. This didn't work, because the
state information about page-style modules is output near the stylesheet,
which is after the script tag with mw.loader.load(). That runs first, and
mw.loader would still make a duplicate request before it learns the state.
Changes:
* Document reasons for style/script tag order in getHeadHtml (per 09537e83).
* Pass $type from getModuleStyles() to getAllowedModules(). This wasn't needed
before since a duplicate check in makeResourceLoaderLink() verified the
origin a second time.
* Declare explicit position 'top' on 'user.options' and 'user.tokens' module.
Previously, OutputPage hardcoded them in the top. The new formatter doesn't.
* Remove getHeadScripts().
* Remove getInlineHeadScripts().
* Remove getExternalHeadScripts().
* Remove buildCssLinks().
* Remove getScriptsForBottomQueue().
* Change where Skin::setupSkinUserCss() is called. This methods lets the skin
add modules to the queue. Previously it was called from buildCssLinks(),
via headElement(), via prepareQuickTemplate(), via OutputPage::output().
It's now in OutputPage::output() directly (slightly earlier). This is needed
because prepareQuickTemplate() calls bottomScripts() before headElement().
And bottomScript() would lazy-initialise the queue and lock it before
setupSkinUserCss() is called from headElement().
This makes execution order more predictable instead of being dependent on
the arbitrary order of data extraction in prepareQuickTemplate (which varies
from one skin to another).
* Compute isUserModulePreview() and isKnownEmpty() for the 'user' module early
on so. This avoids wrongful loading and fixes problem 1.
Effective changes in output:
* mw.loader.state() is now before mw.loader.load(). This fixes problem 2.
* mw.loader.state() now sets 'user.options' and 'user.tokens' to "loading".
* mw.loader.state() now sets 'user' (as "loading" or "ready"). Fixes problem 1.
* The <script async src> tag for 'startup' changed position (slightly).
Previously it was after all inline scripts and stylesheets. It's still after
all inline scripts and after most stylesheets, but before any user styles.
Since the queue is now formatted outside OutputPage, it can't inject the
meta-ResourceLoaderDynamicStyles tag and user-stylesheet hack in the middle
of existing output. This shouldn't have any noticable impact.
Bug: T87871
Change-Id: I605b8cd1e1fc009b4662a0edbc54d09dd65ee1df
2016-07-15 14:13:09 +00:00
|
|
|
* JS stuff to put at the bottom of the `<body>`. These are modules with position 'bottom',
|
|
|
|
|
* legacy scripts ($this->mScripts), and user JS.
|
2015-08-13 21:30:31 +00:00
|
|
|
*
|
2016-07-07 19:26:36 +00:00
|
|
|
* @return string|WrappedStringList HTML
|
2015-08-13 21:30:31 +00:00
|
|
|
*/
|
resourceloader: Move queue formatting out of OutputPage
HTML formatting of the queue was distributed over several OutputPage methods.
Each method demanding a snippet of HTML by calling makeResourceLoaderLink()
with a limited amount of information. As such, makeResourceLoaderLink() was
unable to provide the client with the proper state information.
Centralising it also allows it to better reduce duplication in HTML output
and maintain a more accurate state.
Problems fixed by centralising:
1. The 'user' module is special (due to per-user 'version' and 'user' params).
It is manually requested via script-src. To avoid a separate (and wrong)
request from something that requires it, we set state=loading directly.
However, because the module is in the bottom, the old HTML formatter could
only put state=loading in the bottom also. This sometimes caused a wrong
request to be fired for modules=user if something in the top queue
triggered a requirement for it.
2. Since a464d1d4 (T87871) we track states of page-style modules, with purpose
of allowing dependencies on style modules without risking duplicate loading
on pages where the styles are loaded already. This didn't work, because the
state information about page-style modules is output near the stylesheet,
which is after the script tag with mw.loader.load(). That runs first, and
mw.loader would still make a duplicate request before it learns the state.
Changes:
* Document reasons for style/script tag order in getHeadHtml (per 09537e83).
* Pass $type from getModuleStyles() to getAllowedModules(). This wasn't needed
before since a duplicate check in makeResourceLoaderLink() verified the
origin a second time.
* Declare explicit position 'top' on 'user.options' and 'user.tokens' module.
Previously, OutputPage hardcoded them in the top. The new formatter doesn't.
* Remove getHeadScripts().
* Remove getInlineHeadScripts().
* Remove getExternalHeadScripts().
* Remove buildCssLinks().
* Remove getScriptsForBottomQueue().
* Change where Skin::setupSkinUserCss() is called. This methods lets the skin
add modules to the queue. Previously it was called from buildCssLinks(),
via headElement(), via prepareQuickTemplate(), via OutputPage::output().
It's now in OutputPage::output() directly (slightly earlier). This is needed
because prepareQuickTemplate() calls bottomScripts() before headElement().
And bottomScript() would lazy-initialise the queue and lock it before
setupSkinUserCss() is called from headElement().
This makes execution order more predictable instead of being dependent on
the arbitrary order of data extraction in prepareQuickTemplate (which varies
from one skin to another).
* Compute isUserModulePreview() and isKnownEmpty() for the 'user' module early
on so. This avoids wrongful loading and fixes problem 1.
Effective changes in output:
* mw.loader.state() is now before mw.loader.load(). This fixes problem 2.
* mw.loader.state() now sets 'user.options' and 'user.tokens' to "loading".
* mw.loader.state() now sets 'user' (as "loading" or "ready"). Fixes problem 1.
* The <script async src> tag for 'startup' changed position (slightly).
Previously it was after all inline scripts and stylesheets. It's still after
all inline scripts and after most stylesheets, but before any user styles.
Since the queue is now formatted outside OutputPage, it can't inject the
meta-ResourceLoaderDynamicStyles tag and user-stylesheet hack in the middle
of existing output. This shouldn't have any noticable impact.
Bug: T87871
Change-Id: I605b8cd1e1fc009b4662a0edbc54d09dd65ee1df
2016-07-15 14:13:09 +00:00
|
|
|
public function getBottomScripts() {
|
|
|
|
|
$chunks = [];
|
|
|
|
|
$chunks[] = $this->getRlClient()->getBodyHtml();
|
|
|
|
|
|
|
|
|
|
// Legacy non-ResourceLoader scripts
|
|
|
|
|
$chunks[] = $this->mScripts;
|
|
|
|
|
|
|
|
|
|
// Exempt 'user' module
|
|
|
|
|
// - May need excludepages for live preview. (T28283)
|
|
|
|
|
// - Must use TYPE_COMBINED so its response is handled by mw.loader.implement() which
|
|
|
|
|
// ensures execution is scheduled after the "site" module.
|
|
|
|
|
// - Don't load if module state is already resolved as "ready".
|
|
|
|
|
if ( $this->rlUserModuleState === 'loading' ) {
|
2016-08-19 02:04:21 +00:00
|
|
|
if ( $this->isUserJsPreview() ) {
|
resourceloader: Move queue formatting out of OutputPage
HTML formatting of the queue was distributed over several OutputPage methods.
Each method demanding a snippet of HTML by calling makeResourceLoaderLink()
with a limited amount of information. As such, makeResourceLoaderLink() was
unable to provide the client with the proper state information.
Centralising it also allows it to better reduce duplication in HTML output
and maintain a more accurate state.
Problems fixed by centralising:
1. The 'user' module is special (due to per-user 'version' and 'user' params).
It is manually requested via script-src. To avoid a separate (and wrong)
request from something that requires it, we set state=loading directly.
However, because the module is in the bottom, the old HTML formatter could
only put state=loading in the bottom also. This sometimes caused a wrong
request to be fired for modules=user if something in the top queue
triggered a requirement for it.
2. Since a464d1d4 (T87871) we track states of page-style modules, with purpose
of allowing dependencies on style modules without risking duplicate loading
on pages where the styles are loaded already. This didn't work, because the
state information about page-style modules is output near the stylesheet,
which is after the script tag with mw.loader.load(). That runs first, and
mw.loader would still make a duplicate request before it learns the state.
Changes:
* Document reasons for style/script tag order in getHeadHtml (per 09537e83).
* Pass $type from getModuleStyles() to getAllowedModules(). This wasn't needed
before since a duplicate check in makeResourceLoaderLink() verified the
origin a second time.
* Declare explicit position 'top' on 'user.options' and 'user.tokens' module.
Previously, OutputPage hardcoded them in the top. The new formatter doesn't.
* Remove getHeadScripts().
* Remove getInlineHeadScripts().
* Remove getExternalHeadScripts().
* Remove buildCssLinks().
* Remove getScriptsForBottomQueue().
* Change where Skin::setupSkinUserCss() is called. This methods lets the skin
add modules to the queue. Previously it was called from buildCssLinks(),
via headElement(), via prepareQuickTemplate(), via OutputPage::output().
It's now in OutputPage::output() directly (slightly earlier). This is needed
because prepareQuickTemplate() calls bottomScripts() before headElement().
And bottomScript() would lazy-initialise the queue and lock it before
setupSkinUserCss() is called from headElement().
This makes execution order more predictable instead of being dependent on
the arbitrary order of data extraction in prepareQuickTemplate (which varies
from one skin to another).
* Compute isUserModulePreview() and isKnownEmpty() for the 'user' module early
on so. This avoids wrongful loading and fixes problem 1.
Effective changes in output:
* mw.loader.state() is now before mw.loader.load(). This fixes problem 2.
* mw.loader.state() now sets 'user.options' and 'user.tokens' to "loading".
* mw.loader.state() now sets 'user' (as "loading" or "ready"). Fixes problem 1.
* The <script async src> tag for 'startup' changed position (slightly).
Previously it was after all inline scripts and stylesheets. It's still after
all inline scripts and after most stylesheets, but before any user styles.
Since the queue is now formatted outside OutputPage, it can't inject the
meta-ResourceLoaderDynamicStyles tag and user-stylesheet hack in the middle
of existing output. This shouldn't have any noticable impact.
Bug: T87871
Change-Id: I605b8cd1e1fc009b4662a0edbc54d09dd65ee1df
2016-07-15 14:13:09 +00:00
|
|
|
$chunks[] = $this->makeResourceLoaderLink( 'user', ResourceLoaderModule::TYPE_COMBINED,
|
|
|
|
|
[ 'excludepage' => $this->getTitle()->getPrefixedDBkey() ]
|
|
|
|
|
);
|
|
|
|
|
$chunks[] = ResourceLoader::makeInlineScript(
|
|
|
|
|
Xml::encodeJsCall( 'mw.loader.using', [
|
|
|
|
|
[ 'user', 'site' ],
|
|
|
|
|
new XmlJsCode(
|
|
|
|
|
'function () {'
|
|
|
|
|
. Xml::encodeJsCall( '$.globalEval', [
|
|
|
|
|
$this->getRequest()->getText( 'wpTextbox1' )
|
|
|
|
|
] )
|
|
|
|
|
. '}'
|
|
|
|
|
)
|
|
|
|
|
] )
|
|
|
|
|
);
|
|
|
|
|
// FIXME: If the user is previewing, say, ./vector.js, his ./common.js will be loaded
|
|
|
|
|
// asynchronously and may arrive *after* the inline script here. So the previewed code
|
|
|
|
|
// may execute before ./common.js runs. Normally, ./common.js runs before ./vector.js.
|
|
|
|
|
// Similarly, when previewing ./common.js and the user module does arrive first,
|
|
|
|
|
// it will arrive without common.js and the inline script runs after.
|
|
|
|
|
// Thus running common after the excluded subpage.
|
|
|
|
|
} else {
|
|
|
|
|
// Load normally
|
|
|
|
|
$chunks[] = $this->makeResourceLoaderLink( 'user', ResourceLoaderModule::TYPE_COMBINED );
|
|
|
|
|
}
|
2015-03-21 05:14:02 +00:00
|
|
|
}
|
|
|
|
|
|
2016-11-10 20:29:27 +00:00
|
|
|
if ( $this->limitReportJSData ) {
|
|
|
|
|
$chunks[] = ResourceLoader::makeInlineScript(
|
|
|
|
|
ResourceLoader::makeConfigSetScript(
|
|
|
|
|
[ 'wgPageParseReport' => $this->limitReportJSData ]
|
|
|
|
|
)
|
|
|
|
|
);
|
|
|
|
|
}
|
|
|
|
|
|
resourceloader: Move queue formatting out of OutputPage
HTML formatting of the queue was distributed over several OutputPage methods.
Each method demanding a snippet of HTML by calling makeResourceLoaderLink()
with a limited amount of information. As such, makeResourceLoaderLink() was
unable to provide the client with the proper state information.
Centralising it also allows it to better reduce duplication in HTML output
and maintain a more accurate state.
Problems fixed by centralising:
1. The 'user' module is special (due to per-user 'version' and 'user' params).
It is manually requested via script-src. To avoid a separate (and wrong)
request from something that requires it, we set state=loading directly.
However, because the module is in the bottom, the old HTML formatter could
only put state=loading in the bottom also. This sometimes caused a wrong
request to be fired for modules=user if something in the top queue
triggered a requirement for it.
2. Since a464d1d4 (T87871) we track states of page-style modules, with purpose
of allowing dependencies on style modules without risking duplicate loading
on pages where the styles are loaded already. This didn't work, because the
state information about page-style modules is output near the stylesheet,
which is after the script tag with mw.loader.load(). That runs first, and
mw.loader would still make a duplicate request before it learns the state.
Changes:
* Document reasons for style/script tag order in getHeadHtml (per 09537e83).
* Pass $type from getModuleStyles() to getAllowedModules(). This wasn't needed
before since a duplicate check in makeResourceLoaderLink() verified the
origin a second time.
* Declare explicit position 'top' on 'user.options' and 'user.tokens' module.
Previously, OutputPage hardcoded them in the top. The new formatter doesn't.
* Remove getHeadScripts().
* Remove getInlineHeadScripts().
* Remove getExternalHeadScripts().
* Remove buildCssLinks().
* Remove getScriptsForBottomQueue().
* Change where Skin::setupSkinUserCss() is called. This methods lets the skin
add modules to the queue. Previously it was called from buildCssLinks(),
via headElement(), via prepareQuickTemplate(), via OutputPage::output().
It's now in OutputPage::output() directly (slightly earlier). This is needed
because prepareQuickTemplate() calls bottomScripts() before headElement().
And bottomScript() would lazy-initialise the queue and lock it before
setupSkinUserCss() is called from headElement().
This makes execution order more predictable instead of being dependent on
the arbitrary order of data extraction in prepareQuickTemplate (which varies
from one skin to another).
* Compute isUserModulePreview() and isKnownEmpty() for the 'user' module early
on so. This avoids wrongful loading and fixes problem 1.
Effective changes in output:
* mw.loader.state() is now before mw.loader.load(). This fixes problem 2.
* mw.loader.state() now sets 'user.options' and 'user.tokens' to "loading".
* mw.loader.state() now sets 'user' (as "loading" or "ready"). Fixes problem 1.
* The <script async src> tag for 'startup' changed position (slightly).
Previously it was after all inline scripts and stylesheets. It's still after
all inline scripts and after most stylesheets, but before any user styles.
Since the queue is now formatted outside OutputPage, it can't inject the
meta-ResourceLoaderDynamicStyles tag and user-stylesheet hack in the middle
of existing output. This shouldn't have any noticable impact.
Bug: T87871
Change-Id: I605b8cd1e1fc009b4662a0edbc54d09dd65ee1df
2016-07-15 14:13:09 +00:00
|
|
|
return self::combineWrappedStrings( $chunks );
|
ResourceLoader: Add an experimental option to move the main module loading queue (the bottom queue) from the bottom of the <body> up into the <head> , while still being loaded asynchronously. This makes them load earlier, which should make the page load faster. This is the product of a long discussion on bug 27488
* Added a "blocking" state to mw.loader . When loading scripts while the document is not ready, the loader will use document.write() if blocking is true, and append to the <body> or the <head> if blocking is false. If the document is ready, the loader will always append to the <body>
* Enable blocking mode while loading the top queue, and disable it after. This ensures that modules in the top queue are still loaded in a blocking way as they were before
* If $wgResourceLoaderExperimentalAsyncLoading is true, the bottom queue is also loaded in the head, but with blocking mode disabled. Otherwise, it's loaded at the bottom of the <body> as before
* scripts-only and messages-only requests need special treatment:
** in the top queue, they can continue to use <script src="..."> tags because they are blocking
** if the bottom queue is at the bottom of the <body> (experimental async loading disabled), they can continue to use <script src="..."> tags as before
** if the bottom queue is in the <head> (experimental async loading enabled), they cannot use <script src="..."> tags, because those would block. Instead, call mw.loader.load() on the load.php URL
2012-01-05 23:32:41 +00:00
|
|
|
}
|
|
|
|
|
|
2014-01-19 15:39:46 +00:00
|
|
|
/**
|
|
|
|
|
* Get the javascript config vars to include on this page
|
|
|
|
|
*
|
2014-04-10 18:50:10 +00:00
|
|
|
* @return array Array of javascript config vars
|
2014-01-19 15:39:46 +00:00
|
|
|
* @since 1.23
|
|
|
|
|
*/
|
|
|
|
|
public function getJsConfigVars() {
|
|
|
|
|
return $this->mJsConfigVars;
|
|
|
|
|
}
|
|
|
|
|
|
2011-02-16 18:25:44 +00:00
|
|
|
/**
|
2014-04-10 18:50:10 +00:00
|
|
|
* Add one or more variables to be set in mw.config in JavaScript
|
2011-04-23 19:28:35 +00:00
|
|
|
*
|
2014-04-10 18:50:10 +00:00
|
|
|
* @param string|array $keys Key or array of key/value pairs
|
|
|
|
|
* @param mixed $value [optional] Value of the configuration variable
|
2011-09-28 22:08:08 +00:00
|
|
|
*/
|
2011-12-31 21:25:00 +00:00
|
|
|
public function addJsConfigVars( $keys, $value = null ) {
|
2011-09-28 22:08:08 +00:00
|
|
|
if ( is_array( $keys ) ) {
|
|
|
|
|
foreach ( $keys as $key => $value ) {
|
|
|
|
|
$this->mJsConfigVars[$key] = $value;
|
|
|
|
|
}
|
|
|
|
|
return;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
$this->mJsConfigVars[$keys] = $value;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Get an array containing the variables to be set in mw.config in JavaScript.
|
|
|
|
|
*
|
2013-02-23 10:42:05 +00:00
|
|
|
* Do not add things here which can be evaluated in ResourceLoaderStartUpModule
|
2011-10-03 14:59:56 +00:00
|
|
|
* - in other words, page-independent/site-wide variables (without state).
|
2011-09-28 22:08:08 +00:00
|
|
|
* You will only be adding bloat to the html page and causing page caches to
|
2011-02-16 18:25:44 +00:00
|
|
|
* have to be purged on configuration changes.
|
2011-11-29 21:04:20 +00:00
|
|
|
* @return array
|
2011-02-16 18:25:44 +00:00
|
|
|
*/
|
2014-12-02 21:48:21 +00:00
|
|
|
public function getJSVars() {
|
2012-10-09 09:29:48 +00:00
|
|
|
global $wgContLang;
|
2011-02-16 18:25:44 +00:00
|
|
|
|
2013-09-26 05:03:16 +00:00
|
|
|
$curRevisionId = 0;
|
|
|
|
|
$articleId = 0;
|
2017-02-20 22:44:19 +00:00
|
|
|
$canonicalSpecialPageName = false; # T23115
|
2012-01-29 20:35:32 +00:00
|
|
|
|
2011-02-16 18:25:44 +00:00
|
|
|
$title = $this->getTitle();
|
|
|
|
|
$ns = $title->getNamespace();
|
2014-05-11 01:54:15 +00:00
|
|
|
$canonicalNamespace = MWNamespace::exists( $ns )
|
|
|
|
|
? MWNamespace::getCanonicalName( $ns )
|
|
|
|
|
: $title->getNsText();
|
2012-01-29 20:35:32 +00:00
|
|
|
|
2013-10-29 20:49:17 +00:00
|
|
|
$sk = $this->getSkin();
|
2012-03-13 17:57:54 +00:00
|
|
|
// Get the relevant title so that AJAX features can use the correct page name
|
2017-02-20 22:44:19 +00:00
|
|
|
// when making API requests from certain special pages (T36972).
|
2013-10-29 20:49:17 +00:00
|
|
|
$relevantTitle = $sk->getRelevantTitle();
|
|
|
|
|
$relevantUser = $sk->getRelevantUser();
|
2012-03-13 17:57:54 +00:00
|
|
|
|
2011-02-25 11:48:14 +00:00
|
|
|
if ( $ns == NS_SPECIAL ) {
|
2014-05-11 01:54:15 +00:00
|
|
|
list( $canonicalSpecialPageName, /*...*/ ) =
|
|
|
|
|
SpecialPageFactory::resolveAlias( $title->getDBkey() );
|
2012-01-29 20:35:32 +00:00
|
|
|
} elseif ( $this->canUseWikiPage() ) {
|
|
|
|
|
$wikiPage = $this->getWikiPage();
|
2013-09-26 05:03:16 +00:00
|
|
|
$curRevisionId = $wikiPage->getLatest();
|
|
|
|
|
$articleId = $wikiPage->getId();
|
2011-02-25 11:48:14 +00:00
|
|
|
}
|
2011-02-16 18:25:44 +00:00
|
|
|
|
2016-03-08 23:44:18 +00:00
|
|
|
$lang = $title->getPageViewLanguage();
|
2011-11-28 20:53:26 +00:00
|
|
|
|
|
|
|
|
// Pre-process information
|
|
|
|
|
$separatorTransTable = $lang->separatorTransformTable();
|
2016-02-17 09:09:32 +00:00
|
|
|
$separatorTransTable = $separatorTransTable ? $separatorTransTable : [];
|
|
|
|
|
$compactSeparatorTransTable = [
|
2011-11-28 20:53:26 +00:00
|
|
|
implode( "\t", array_keys( $separatorTransTable ) ),
|
|
|
|
|
implode( "\t", $separatorTransTable ),
|
2016-02-17 09:09:32 +00:00
|
|
|
];
|
2011-11-28 20:53:26 +00:00
|
|
|
$digitTransTable = $lang->digitTransformTable();
|
2016-02-17 09:09:32 +00:00
|
|
|
$digitTransTable = $digitTransTable ? $digitTransTable : [];
|
|
|
|
|
$compactDigitTransTable = [
|
2011-11-28 20:53:26 +00:00
|
|
|
implode( "\t", array_keys( $digitTransTable ) ),
|
|
|
|
|
implode( "\t", $digitTransTable ),
|
2016-02-17 09:09:32 +00:00
|
|
|
];
|
2011-11-28 20:53:26 +00:00
|
|
|
|
2013-01-22 22:44:22 +00:00
|
|
|
$user = $this->getUser();
|
|
|
|
|
|
2016-02-17 09:09:32 +00:00
|
|
|
$vars = [
|
2013-09-26 05:03:16 +00:00
|
|
|
'wgCanonicalNamespace' => $canonicalNamespace,
|
|
|
|
|
'wgCanonicalSpecialPageName' => $canonicalSpecialPageName,
|
2011-02-16 18:25:44 +00:00
|
|
|
'wgNamespaceNumber' => $title->getNamespace(),
|
2013-03-09 20:14:22 +00:00
|
|
|
'wgPageName' => $title->getPrefixedDBkey(),
|
2011-02-16 18:25:44 +00:00
|
|
|
'wgTitle' => $title->getText(),
|
2013-09-26 05:03:16 +00:00
|
|
|
'wgCurRevisionId' => $curRevisionId,
|
2013-08-26 18:52:23 +00:00
|
|
|
'wgRevisionId' => (int)$this->getRevisionId(),
|
2013-09-26 05:03:16 +00:00
|
|
|
'wgArticleId' => $articleId,
|
2011-02-16 18:25:44 +00:00
|
|
|
'wgIsArticle' => $this->isArticle(),
|
2013-07-23 19:11:17 +00:00
|
|
|
'wgIsRedirect' => $title->isRedirect(),
|
2012-01-21 06:57:34 +00:00
|
|
|
'wgAction' => Action::getActionName( $this->getContext() ),
|
2013-01-22 22:44:22 +00:00
|
|
|
'wgUserName' => $user->isAnon() ? null : $user->getName(),
|
|
|
|
|
'wgUserGroups' => $user->getEffectiveGroups(),
|
2011-02-16 18:25:44 +00:00
|
|
|
'wgCategories' => $this->getCategories(),
|
|
|
|
|
'wgBreakFrames' => $this->getFrameOptions() == 'DENY',
|
2011-11-28 20:53:26 +00:00
|
|
|
'wgPageContentLanguage' => $lang->getCode(),
|
2013-05-07 19:59:40 +00:00
|
|
|
'wgPageContentModel' => $title->getContentModel(),
|
2011-11-28 20:53:26 +00:00
|
|
|
'wgSeparatorTransformTable' => $compactSeparatorTransTable,
|
|
|
|
|
'wgDigitTransformTable' => $compactDigitTransTable,
|
2012-07-04 22:00:44 +00:00
|
|
|
'wgDefaultDateFormat' => $lang->getDefaultDateFormat(),
|
|
|
|
|
'wgMonthNames' => $lang->getMonthNamesArray(),
|
|
|
|
|
'wgMonthNamesShort' => $lang->getMonthAbbreviationsArray(),
|
2013-03-09 20:14:22 +00:00
|
|
|
'wgRelevantPageName' => $relevantTitle->getPrefixedDBkey(),
|
2016-03-19 00:08:06 +00:00
|
|
|
'wgRelevantArticleId' => $relevantTitle->getArticleID(),
|
Provide a unique request identifier
When MediaWiki encounters an unhandled exception, the error message it produces
includes a randomly-generated token, which allows the exception details to be
looked up in the error logs. This is useful but narrow: would it not be useful
to have the ability to retrieve all log records associated with a particular
request, rather than just exception details? (Hint: yes.)
So: introduce the notion of a request-global unique ID, retrievable via
WebRequest::getRequestId(). When MediaWiki is behind Apache + mod_unique_id
(which provides the same facility) or some other software which sets a
UNIQUE_ID envvar, the value of that envvar is used as the request ID.
Otherwise, it is a randomly-generated 24-character string.
The request ID supplants exception-specific IDs; MWExceptionHandler::getLogId()
is deprecated, accordingly. The request ID is also added as an annotation to
all Monolog-processed log records, and is exposed client-side as 'wgRequestId'.
This allows developers to associate a page view with log records even when the
page view does not result in an unhandled exception. (For the WMF, I also
intend to add it as an annotation to profiling data).
The request ID is not a tracking token; it does not persist, and it is
associated with a backend request, not with a particular user or a particular
session. Like the data in the NewPP report, the request ID is designed to be
cacheable, so that if, for example, a developer notices something weird in the
HTML, s/he can associate the output with a backend request regardless of
whether the response was served from the cache or directly from the backend.
Some prior art:
* https://httpd.apache.org/docs/2.4/mod/mod_unique_id.html
* http://api.rubyonrails.org/classes/ActionDispatch/RequestId.html
* https://github.com/dabapps/django-log-request-id
* https://packagist.org/packages/php-middleware/request-id
* https://github.com/rhyselsmore/flask-request-id
Change-Id: Iaf90c20c330e0470b9b98627a0228cadefd301d1
2016-03-25 01:43:23 +00:00
|
|
|
'wgRequestId' => WebRequest::getRequestId(),
|
2016-02-17 09:09:32 +00:00
|
|
|
];
|
2014-05-11 01:54:15 +00:00
|
|
|
|
2013-01-22 22:44:22 +00:00
|
|
|
if ( $user->isLoggedIn() ) {
|
|
|
|
|
$vars['wgUserId'] = $user->getId();
|
|
|
|
|
$vars['wgUserEditCount'] = $user->getEditCount();
|
2016-09-23 23:59:56 +00:00
|
|
|
$userReg = $user->getRegistration();
|
|
|
|
|
$vars['wgUserRegistration'] = $userReg ? wfTimestamp( TS_UNIX, $userReg ) * 1000 : null;
|
2013-05-05 01:08:58 +00:00
|
|
|
// Get the revision ID of the oldest new message on the user's talk
|
|
|
|
|
// page. This can be used for constructing new message alerts on
|
|
|
|
|
// the client side.
|
|
|
|
|
$vars['wgUserNewMsgRevisionId'] = $user->getNewMessageRevisionId();
|
2013-01-22 22:44:22 +00:00
|
|
|
}
|
2014-05-11 01:54:15 +00:00
|
|
|
|
2012-03-06 11:11:01 +00:00
|
|
|
if ( $wgContLang->hasVariants() ) {
|
|
|
|
|
$vars['wgUserVariant'] = $wgContLang->getPreferredVariant();
|
2012-10-26 15:42:13 +00:00
|
|
|
}
|
2013-05-23 04:31:11 +00:00
|
|
|
// Same test as SkinTemplate
|
2014-05-11 01:54:15 +00:00
|
|
|
$vars['wgIsProbablyEditable'] = $title->quickUserCan( 'edit', $user )
|
|
|
|
|
&& ( $title->exists() || $title->quickUserCan( 'create', $user ) );
|
|
|
|
|
|
2017-05-15 10:12:44 +00:00
|
|
|
$vars['wgRelevantPageIsProbablyEditable'] = $relevantTitle
|
|
|
|
|
&& $relevantTitle->quickUserCan( 'edit', $user )
|
|
|
|
|
&& ( $relevantTitle->exists() || $relevantTitle->quickUserCan( 'create', $user ) );
|
|
|
|
|
|
2011-02-16 18:25:44 +00:00
|
|
|
foreach ( $title->getRestrictionTypes() as $type ) {
|
|
|
|
|
$vars['wgRestriction' . ucfirst( $type )] = $title->getRestrictions( $type );
|
|
|
|
|
}
|
2014-05-11 01:54:15 +00:00
|
|
|
|
2011-06-14 23:29:45 +00:00
|
|
|
if ( $title->isMainPage() ) {
|
2011-06-15 01:11:16 +00:00
|
|
|
$vars['wgIsMainPage'] = true;
|
2011-11-30 12:43:10 +00:00
|
|
|
}
|
2014-05-11 01:54:15 +00:00
|
|
|
|
2011-11-30 12:43:10 +00:00
|
|
|
if ( $this->mRedirectedFrom ) {
|
2013-03-09 20:14:22 +00:00
|
|
|
$vars['wgRedirectedFrom'] = $this->mRedirectedFrom->getPrefixedDBkey();
|
2011-06-14 23:29:45 +00:00
|
|
|
}
|
2014-05-11 01:54:15 +00:00
|
|
|
|
2013-10-29 20:49:17 +00:00
|
|
|
if ( $relevantUser ) {
|
|
|
|
|
$vars['wgRelevantUserName'] = $relevantUser->getName();
|
|
|
|
|
}
|
2011-04-23 19:28:35 +00:00
|
|
|
|
2011-09-28 22:08:08 +00:00
|
|
|
// Allow extensions to add their custom variables to the mw.config map.
|
|
|
|
|
// Use the 'ResourceLoaderGetConfigVars' hook if the variable is not
|
|
|
|
|
// page-dependant but site-wide (without state).
|
|
|
|
|
// Alternatively, you may want to use OutputPage->addJsConfigVars() instead.
|
2016-02-17 09:09:32 +00:00
|
|
|
Hooks::run( 'MakeGlobalVariablesScript', [ &$vars, $this ] );
|
2011-04-23 19:28:35 +00:00
|
|
|
|
2011-09-28 22:08:08 +00:00
|
|
|
// Merge in variables from addJsConfigVars last
|
2014-01-19 15:39:46 +00:00
|
|
|
return array_merge( $vars, $this->getJsConfigVars() );
|
2011-02-16 18:25:44 +00:00
|
|
|
}
|
|
|
|
|
|
2010-01-29 21:32:45 +00:00
|
|
|
/**
|
2011-07-22 10:45:07 +00:00
|
|
|
* 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() {
|
2015-10-08 06:04:59 +00:00
|
|
|
$request = $this->getRequest();
|
2015-11-15 01:28:25 +00:00
|
|
|
if (
|
|
|
|
|
$request->getVal( 'action' ) !== 'submit' ||
|
|
|
|
|
!$request->getCheck( 'wpPreview' ) ||
|
|
|
|
|
!$request->wasPosted()
|
|
|
|
|
) {
|
2015-10-08 06:04:59 +00:00
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
$user = $this->getUser();
|
2016-08-19 20:53:52 +00:00
|
|
|
|
2016-08-23 07:12:35 +00:00
|
|
|
if ( !$user->isLoggedIn() ) {
|
2016-08-19 20:53:52 +00:00
|
|
|
// Anons have predictable edit tokens
|
|
|
|
|
return false;
|
|
|
|
|
}
|
2015-10-08 06:04:59 +00:00
|
|
|
if ( !$user->matchEditToken( $request->getVal( 'wpEditToken' ) ) ) {
|
2011-07-22 10:45:07 +00:00
|
|
|
return false;
|
|
|
|
|
}
|
2015-10-08 06:04:59 +00:00
|
|
|
|
|
|
|
|
$title = $this->getTitle();
|
|
|
|
|
if ( !$title->isJsSubpage() && !$title->isCssSubpage() ) {
|
2011-07-22 10:45:07 +00:00
|
|
|
return false;
|
|
|
|
|
}
|
2015-10-08 06:04:59 +00:00
|
|
|
if ( !$title->isSubpageOf( $user->getUserPage() ) ) {
|
2015-01-05 21:31:26 +00:00
|
|
|
// Don't execute another user's CSS or JS on preview (T85855)
|
|
|
|
|
return false;
|
|
|
|
|
}
|
2011-07-22 10:45:07 +00:00
|
|
|
|
2015-10-08 06:04:59 +00:00
|
|
|
$errors = $title->getUserPermissionsErrors( 'edit', $user );
|
|
|
|
|
if ( count( $errors ) !== 0 ) {
|
|
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return true;
|
2011-07-22 10:45:07 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
2014-07-24 17:42:24 +00:00
|
|
|
* @return array Array in format "link name or number => 'link html'".
|
2010-01-29 21:32:45 +00:00
|
|
|
*/
|
2013-05-11 09:31:30 +00:00
|
|
|
public function getHeadLinksArray() {
|
2014-08-23 08:52:41 +00:00
|
|
|
global $wgVersion;
|
2009-07-07 21:49:45 +00:00
|
|
|
|
2016-02-17 09:09:32 +00:00
|
|
|
$tags = [];
|
2014-08-23 08:52:41 +00:00
|
|
|
$config = $this->getConfig();
|
2009-07-07 21:49:45 +00:00
|
|
|
|
2012-12-31 01:11:43 +00:00
|
|
|
$canonicalUrl = $this->mCanonicalUrl;
|
|
|
|
|
|
2016-02-17 09:09:32 +00:00
|
|
|
$tags['meta-generator'] = Html::element( 'meta', [
|
2011-04-02 18:38:42 +00:00
|
|
|
'name' => 'generator',
|
2011-05-15 13:21:16 +00:00
|
|
|
'content' => "MediaWiki $wgVersion",
|
2016-02-17 09:09:32 +00:00
|
|
|
] );
|
here it is ... the upload-api, script-server, js2 (javascript phase2) branch merge 1st attempt.
Here is a short overview of changes and associated default configuration variables (most everything is off by default) also see ~soon to be updated~: http://www.mediawiki.org/wiki/Media_Projects_Overview
= Upload Improvements =
==Upload API ==
* Based on the early work of Bryan Tong and others it adds the upload option to the api.
* We rewrite Special:Upload page to include use the new refactoring
* Added in token checks in both the SpecialUpload.php page so avoids DOS / xss copy-by-url JavaScript based cross site POST file submissions
== Copy by URL==
$wgAllowCopyUploads = false;
* http class rewrite includes a new http background download see: includes/HttpFunctions.php
* spins off a php process that calls: maintenance/http_session_download.php
* pushes updates to the session and gives the user a progress bar on http copy uploads from other server progress (using js2 upload interface) (if not using the js2 upload interface it does the request in-place but the download is limited to the php ini timeout time)
== Firefogg ==
* Firefogg enables resumable upload by chunks
* progress indicators and conditional invokation (js2 system)
* and of-course client side transcoding.
= Script Server =
$wgEnableScriptLoader = false;
* off by default if $wgEnableScriptLoader is turned on script files are grouped, gziped, cached etc.
for more info see: http://www.mediawiki.org/wiki/Extension:ScriptLoader
* Includes some early skin js include fixes (skin/script system still lots of love)
* Includes a "javascript class autoloader" this is packaged into mwEmbed so that the mwEmbed library can work in stand alone mode (while retaining localization and script serving) (one such application is the make page for firefogg.org : http://www.firefogg.org/make/index.html )
* The file that contains the autojavascript loading classes is: js2/php/jsAutoloadLocalClasses.php
* One can use this auto class loading dependency system with extensions and add-ons but I need to better document that.
= js2 system / mwEmbed=
$wgEnableJS2system = false
* includes initial rewrite towards more jquery based javascript code
* especially for the Special:Upload page.
* Also the edit page include support for the "add-media-wizard"
* includes dependency loader for javascript that optionally takes advantage of the script-loader
* remote embedding of javascript interfaces (like embedding video, or commons media searching)
* $wgDebugJavaScript = false; .. .this variable lets you always get "always fresh javascript". When used with the script-loader it does not minify the script-loader output.
= mwEmbed =
* Will commit a separate patch to oggHandler that conditionally outputs <video tag> to use the new javascript video player.
** mv_embed player includes: play-head, volume control, remote embedding, oggz-chop support across plugins.
* add-media-wizard adds easy inserts of media to pages (with import)
== jQuery==
* we include a base install of jQuery, jQuery ui and some plugins.
* all the javascript classes are in the scriptloader so its easy to load any set of jquery ui components that you may need using the script-server. You get a callback so you can then execute js with dependencies loaded.
== other stuff ==
there is a bit more code in js2 that pertains to sequence editing, timed text display and basic image editing. We include a base import of pixastic-lib & pixastic-editor... will work with the pixastic developer to try and ensure upstream compatibility on our usage of the library for in-browser photo and sequence manipulation.
2009-07-14 23:52:14 +00:00
|
|
|
|
2015-01-20 23:41:41 +00:00
|
|
|
if ( $config->get( 'ReferrerPolicy' ) !== false ) {
|
2016-02-17 09:09:32 +00:00
|
|
|
$tags['meta-referrer'] = Html::element( 'meta', [
|
2015-01-20 23:41:41 +00:00
|
|
|
'name' => 'referrer',
|
|
|
|
|
'content' => $config->get( 'ReferrerPolicy' )
|
2016-02-17 09:09:32 +00:00
|
|
|
] );
|
2015-01-20 23:41:41 +00:00
|
|
|
}
|
|
|
|
|
|
2008-07-23 19:05:43 +00:00
|
|
|
$p = "{$this->mIndexPolicy},{$this->mFollowPolicy}";
|
2013-04-17 14:52:47 +00:00
|
|
|
if ( $p !== 'index,follow' ) {
|
2008-07-02 22:52:22 +00:00
|
|
|
// http://www.robotstxt.org/wc/meta-user.html
|
|
|
|
|
// Only show if it's different from the default robots policy
|
2016-02-17 09:09:32 +00:00
|
|
|
$tags['meta-robots'] = Html::element( 'meta', [
|
2011-04-02 18:38:42 +00:00
|
|
|
'name' => 'robots',
|
|
|
|
|
'content' => $p,
|
2016-02-17 09:09:32 +00:00
|
|
|
] );
|
2008-07-02 22:52:22 +00:00
|
|
|
}
|
|
|
|
|
|
2003-04-14 23:10:40 +00:00
|
|
|
foreach ( $this->mMetatags as $tag ) {
|
2017-01-24 12:01:47 +00:00
|
|
|
if ( strncasecmp( $tag[0], 'http:', 5 ) === 0 ) {
|
2012-02-20 22:48:43 +00:00
|
|
|
$a = 'http-equiv';
|
|
|
|
|
$tag[0] = substr( $tag[0], 5 );
|
2017-01-24 12:01:47 +00:00
|
|
|
} elseif ( strncasecmp( $tag[0], 'og:', 3 ) === 0 ) {
|
|
|
|
|
$a = 'property';
|
2012-02-20 22:48:43 +00:00
|
|
|
} else {
|
|
|
|
|
$a = 'name';
|
2003-04-14 23:10:40 +00:00
|
|
|
}
|
2012-04-24 17:25:06 +00:00
|
|
|
$tagName = "meta-{$tag[0]}";
|
|
|
|
|
if ( isset( $tags[$tagName] ) ) {
|
|
|
|
|
$tagName .= $tag[1];
|
|
|
|
|
}
|
|
|
|
|
$tags[$tagName] = Html::element( 'meta',
|
2016-02-17 09:09:32 +00:00
|
|
|
[
|
2008-07-02 22:52:22 +00:00
|
|
|
$a => $tag[0],
|
2010-05-22 12:18:22 +00:00
|
|
|
'content' => $tag[1]
|
2016-02-17 09:09:32 +00:00
|
|
|
]
|
2010-05-22 12:18:22 +00:00
|
|
|
);
|
2003-04-14 23:10:40 +00:00
|
|
|
}
|
2011-04-02 18:38:42 +00:00
|
|
|
|
2003-04-14 23:10:40 +00:00
|
|
|
foreach ( $this->mLinktags as $tag ) {
|
2009-09-18 20:10:25 +00:00
|
|
|
$tags[] = Html::element( 'link', $tag );
|
2003-04-14 23:10:40 +00:00
|
|
|
}
|
2008-04-14 07:45:50 +00:00
|
|
|
|
2011-04-02 18:38:42 +00:00
|
|
|
# Universal edit button
|
2014-08-23 08:52:41 +00:00
|
|
|
if ( $config->get( 'UniversalEditButton' ) && $this->isArticleRelated() ) {
|
2011-11-07 13:51:40 +00:00
|
|
|
$user = $this->getUser();
|
|
|
|
|
if ( $this->getTitle()->quickUserCan( 'edit', $user )
|
2015-09-27 07:58:17 +00:00
|
|
|
&& ( $this->getTitle()->exists() ||
|
|
|
|
|
$this->getTitle()->quickUserCan( 'create', $user ) )
|
|
|
|
|
) {
|
2011-04-02 18:38:42 +00:00
|
|
|
// Original UniversalEditButton
|
2011-10-23 08:13:52 +00:00
|
|
|
$msg = $this->msg( 'edit' )->text();
|
2016-02-17 09:09:32 +00:00
|
|
|
$tags['universal-edit-button'] = Html::element( 'link', [
|
2011-04-02 18:38:42 +00:00
|
|
|
'rel' => 'alternate',
|
|
|
|
|
'type' => 'application/x-wiki',
|
|
|
|
|
'title' => $msg,
|
2014-05-18 20:54:46 +00:00
|
|
|
'href' => $this->getTitle()->getEditURL(),
|
2016-02-17 09:09:32 +00:00
|
|
|
] );
|
2011-04-02 18:38:42 +00:00
|
|
|
// Alternate edit link
|
2016-02-17 09:09:32 +00:00
|
|
|
$tags['alternative-edit'] = Html::element( 'link', [
|
2011-04-02 18:38:42 +00:00
|
|
|
'rel' => 'edit',
|
|
|
|
|
'title' => $msg,
|
2014-05-18 20:54:46 +00:00
|
|
|
'href' => $this->getTitle()->getEditURL(),
|
2016-02-17 09:09:32 +00:00
|
|
|
] );
|
2011-04-02 18:38:42 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
# Generally the order of the favicon and apple-touch-icon links
|
|
|
|
|
# should not matter, but Konqueror (3.5.9 at least) incorrectly
|
|
|
|
|
# uses whichever one appears later in the HTML source. Make sure
|
|
|
|
|
# apple-touch-icon is specified first to avoid this.
|
2014-08-23 08:52:41 +00:00
|
|
|
if ( $config->get( 'AppleTouchIcon' ) !== false ) {
|
2016-02-17 09:09:32 +00:00
|
|
|
$tags['apple-touch-icon'] = Html::element( 'link', [
|
2014-05-11 01:54:15 +00:00
|
|
|
'rel' => 'apple-touch-icon',
|
2014-08-23 08:52:41 +00:00
|
|
|
'href' => $config->get( 'AppleTouchIcon' )
|
2016-02-17 09:09:32 +00:00
|
|
|
] );
|
2011-04-02 18:38:42 +00:00
|
|
|
}
|
|
|
|
|
|
2014-08-23 08:52:41 +00:00
|
|
|
if ( $config->get( 'Favicon' ) !== false ) {
|
2016-02-17 09:09:32 +00:00
|
|
|
$tags['favicon'] = Html::element( 'link', [
|
2014-05-11 01:54:15 +00:00
|
|
|
'rel' => 'shortcut icon',
|
2014-08-23 08:52:41 +00:00
|
|
|
'href' => $config->get( 'Favicon' )
|
2016-02-17 09:09:32 +00:00
|
|
|
] );
|
2011-04-02 18:38:42 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
# OpenSearch description link
|
2016-02-17 09:09:32 +00:00
|
|
|
$tags['opensearch'] = Html::element( 'link', [
|
2011-04-02 18:38:42 +00:00
|
|
|
'rel' => 'search',
|
|
|
|
|
'type' => 'application/opensearchdescription+xml',
|
|
|
|
|
'href' => wfScript( 'opensearch_desc' ),
|
2011-10-23 08:13:52 +00:00
|
|
|
'title' => $this->msg( 'opensearch-desc' )->inContentLanguage()->text(),
|
2016-02-17 09:09:32 +00:00
|
|
|
] );
|
2011-04-02 18:38:42 +00:00
|
|
|
|
2014-08-23 08:52:41 +00:00
|
|
|
if ( $config->get( 'EnableAPI' ) ) {
|
2011-04-02 18:38:42 +00:00
|
|
|
# Real Simple Discovery link, provides auto-discovery information
|
|
|
|
|
# for the MediaWiki API (and potentially additional custom API
|
|
|
|
|
# support such as WordPress or Twitter-compatible APIs for a
|
|
|
|
|
# blogging extension, etc)
|
2016-02-17 09:09:32 +00:00
|
|
|
$tags['rsd'] = Html::element( 'link', [
|
2011-04-02 18:38:42 +00:00
|
|
|
'rel' => 'EditURI',
|
|
|
|
|
'type' => 'application/rsd+xml',
|
2015-09-27 07:58:17 +00:00
|
|
|
// Output a protocol-relative URL here if $wgServer is protocol-relative.
|
|
|
|
|
// Whether RSD accepts relative or protocol-relative URLs is completely
|
|
|
|
|
// undocumented, though.
|
2014-05-11 01:54:15 +00:00
|
|
|
'href' => wfExpandUrl( wfAppendQuery(
|
|
|
|
|
wfScript( 'api' ),
|
2016-02-17 09:09:32 +00:00
|
|
|
[ 'action' => 'rsd' ] ),
|
2014-05-11 01:54:15 +00:00
|
|
|
PROTO_RELATIVE
|
|
|
|
|
),
|
2016-02-17 09:09:32 +00:00
|
|
|
] );
|
2011-04-02 18:38:42 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
# Language variants
|
2014-08-15 08:08:46 +00:00
|
|
|
if ( !$config->get( 'DisableLangConversion' ) ) {
|
2011-11-05 20:25:00 +00:00
|
|
|
$lang = $this->getTitle()->getPageLanguage();
|
|
|
|
|
if ( $lang->hasVariants() ) {
|
2014-08-15 08:08:46 +00:00
|
|
|
$variants = $lang->getVariants();
|
2015-07-23 10:53:31 +00:00
|
|
|
foreach ( $variants as $variant ) {
|
2016-02-17 09:09:32 +00:00
|
|
|
$tags["variant-$variant"] = Html::element( 'link', [
|
2014-08-15 08:08:46 +00:00
|
|
|
'rel' => 'alternate',
|
2015-07-23 10:53:31 +00:00
|
|
|
'hreflang' => wfBCP47( $variant ),
|
2015-09-27 07:58:17 +00:00
|
|
|
'href' => $this->getTitle()->getLocalURL(
|
2016-02-17 09:09:32 +00:00
|
|
|
[ 'variant' => $variant ] )
|
|
|
|
|
]
|
2014-08-15 08:08:46 +00:00
|
|
|
);
|
2011-04-02 18:38:42 +00:00
|
|
|
}
|
2015-07-07 10:32:03 +00:00
|
|
|
# x-default link per https://support.google.com/webmasters/answer/189077?hl=en
|
2016-02-17 09:09:32 +00:00
|
|
|
$tags["variant-x-default"] = Html::element( 'link', [
|
2015-07-07 10:32:03 +00:00
|
|
|
'rel' => 'alternate',
|
|
|
|
|
'hreflang' => 'x-default',
|
2016-02-17 09:09:32 +00:00
|
|
|
'href' => $this->getTitle()->getLocalURL() ] );
|
2011-04-02 18:38:42 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
# Copyright
|
2015-06-08 13:39:06 +00:00
|
|
|
if ( $this->copyrightUrl !== null ) {
|
|
|
|
|
$copyright = $this->copyrightUrl;
|
|
|
|
|
} else {
|
|
|
|
|
$copyright = '';
|
|
|
|
|
if ( $config->get( 'RightsPage' ) ) {
|
|
|
|
|
$copy = Title::newFromText( $config->get( 'RightsPage' ) );
|
2011-04-02 18:38:42 +00:00
|
|
|
|
2015-06-08 13:39:06 +00:00
|
|
|
if ( $copy ) {
|
|
|
|
|
$copyright = $copy->getLocalURL();
|
|
|
|
|
}
|
2011-04-02 18:38:42 +00:00
|
|
|
}
|
|
|
|
|
|
2015-06-08 13:39:06 +00:00
|
|
|
if ( !$copyright && $config->get( 'RightsUrl' ) ) {
|
|
|
|
|
$copyright = $config->get( 'RightsUrl' );
|
|
|
|
|
}
|
2011-04-02 18:38:42 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if ( $copyright ) {
|
2016-02-17 09:09:32 +00:00
|
|
|
$tags['copyright'] = Html::element( 'link', [
|
2017-06-07 12:11:08 +00:00
|
|
|
'rel' => 'license',
|
2016-02-17 09:09:32 +00:00
|
|
|
'href' => $copyright ]
|
2011-04-02 18:38:42 +00:00
|
|
|
);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
# Feeds
|
2014-08-23 08:52:41 +00:00
|
|
|
if ( $config->get( 'Feed' ) ) {
|
2016-02-17 09:09:32 +00:00
|
|
|
$feedLinks = [];
|
2015-12-18 19:09:34 +00:00
|
|
|
|
2013-04-17 14:52:47 +00:00
|
|
|
foreach ( $this->getSyndicationLinks() as $format => $link ) {
|
2011-05-26 16:11:47 +00:00
|
|
|
# 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.
|
2008-04-14 07:45:50 +00:00
|
|
|
|
2015-12-18 19:09:34 +00:00
|
|
|
$feedLinks[] = $this->feedLink(
|
2008-02-22 12:33:51 +00:00
|
|
|
$format,
|
|
|
|
|
$link,
|
2010-01-13 21:29:47 +00:00
|
|
|
# Used messages: 'page-rss-feed' and 'page-atom-feed' (for an easier grep)
|
2015-09-27 07:58:17 +00:00
|
|
|
$this->msg(
|
|
|
|
|
"page-{$format}-feed", $this->getTitle()->getPrefixedText()
|
|
|
|
|
)->text()
|
2010-05-22 12:18:22 +00:00
|
|
|
);
|
2008-02-22 12:33:51 +00:00
|
|
|
}
|
2008-04-14 07:45:50 +00:00
|
|
|
|
here it is ... the upload-api, script-server, js2 (javascript phase2) branch merge 1st attempt.
Here is a short overview of changes and associated default configuration variables (most everything is off by default) also see ~soon to be updated~: http://www.mediawiki.org/wiki/Media_Projects_Overview
= Upload Improvements =
==Upload API ==
* Based on the early work of Bryan Tong and others it adds the upload option to the api.
* We rewrite Special:Upload page to include use the new refactoring
* Added in token checks in both the SpecialUpload.php page so avoids DOS / xss copy-by-url JavaScript based cross site POST file submissions
== Copy by URL==
$wgAllowCopyUploads = false;
* http class rewrite includes a new http background download see: includes/HttpFunctions.php
* spins off a php process that calls: maintenance/http_session_download.php
* pushes updates to the session and gives the user a progress bar on http copy uploads from other server progress (using js2 upload interface) (if not using the js2 upload interface it does the request in-place but the download is limited to the php ini timeout time)
== Firefogg ==
* Firefogg enables resumable upload by chunks
* progress indicators and conditional invokation (js2 system)
* and of-course client side transcoding.
= Script Server =
$wgEnableScriptLoader = false;
* off by default if $wgEnableScriptLoader is turned on script files are grouped, gziped, cached etc.
for more info see: http://www.mediawiki.org/wiki/Extension:ScriptLoader
* Includes some early skin js include fixes (skin/script system still lots of love)
* Includes a "javascript class autoloader" this is packaged into mwEmbed so that the mwEmbed library can work in stand alone mode (while retaining localization and script serving) (one such application is the make page for firefogg.org : http://www.firefogg.org/make/index.html )
* The file that contains the autojavascript loading classes is: js2/php/jsAutoloadLocalClasses.php
* One can use this auto class loading dependency system with extensions and add-ons but I need to better document that.
= js2 system / mwEmbed=
$wgEnableJS2system = false
* includes initial rewrite towards more jquery based javascript code
* especially for the Special:Upload page.
* Also the edit page include support for the "add-media-wizard"
* includes dependency loader for javascript that optionally takes advantage of the script-loader
* remote embedding of javascript interfaces (like embedding video, or commons media searching)
* $wgDebugJavaScript = false; .. .this variable lets you always get "always fresh javascript". When used with the script-loader it does not minify the script-loader output.
= mwEmbed =
* Will commit a separate patch to oggHandler that conditionally outputs <video tag> to use the new javascript video player.
** mv_embed player includes: play-head, volume control, remote embedding, oggz-chop support across plugins.
* add-media-wizard adds easy inserts of media to pages (with import)
== jQuery==
* we include a base install of jQuery, jQuery ui and some plugins.
* all the javascript classes are in the scriptloader so its easy to load any set of jquery ui components that you may need using the script-server. You get a callback so you can then execute js with dependencies loaded.
== other stuff ==
there is a bit more code in js2 that pertains to sequence editing, timed text display and basic image editing. We include a base import of pixastic-lib & pixastic-editor... will work with the pixastic developer to try and ensure upstream compatibility on our usage of the library for in-browser photo and sequence manipulation.
2009-07-14 23:52:14 +00:00
|
|
|
# Recent changes feed should appear on every page (except recentchanges,
|
|
|
|
|
# that would be redundant). Put it after the per-page feed to avoid
|
|
|
|
|
# changing existing behavior. It's still available, probably via a
|
2008-08-08 01:41:14 +00:00
|
|
|
# menu in your browser. Some sites might have a different feed they'd
|
|
|
|
|
# like to promote instead of the RC feed (maybe like a "Recent New Articles"
|
|
|
|
|
# or "Breaking news" one). For this, we see if $wgOverrideSiteFeed is defined.
|
|
|
|
|
# If so, use it instead.
|
2014-08-23 08:52:41 +00:00
|
|
|
$sitename = $config->get( 'Sitename' );
|
|
|
|
|
if ( $config->get( 'OverrideSiteFeed' ) ) {
|
|
|
|
|
foreach ( $config->get( 'OverrideSiteFeed' ) as $type => $feedUrl ) {
|
2011-09-07 19:14:06 +00:00
|
|
|
// Note, this->feedLink escapes the url.
|
2015-12-18 19:09:34 +00:00
|
|
|
$feedLinks[] = $this->feedLink(
|
2008-08-08 01:41:14 +00:00
|
|
|
$type,
|
2011-09-07 19:14:06 +00:00
|
|
|
$feedUrl,
|
2014-08-23 08:52:41 +00:00
|
|
|
$this->msg( "site-{$type}-feed", $sitename )->text()
|
2010-05-22 12:18:22 +00:00
|
|
|
);
|
2008-08-08 01:41:14 +00:00
|
|
|
}
|
2011-11-05 20:25:00 +00:00
|
|
|
} elseif ( !$this->getTitle()->isSpecial( 'Recentchanges' ) ) {
|
2011-12-20 09:12:20 +00:00
|
|
|
$rctitle = SpecialPage::getTitleFor( 'Recentchanges' );
|
2014-08-23 08:52:41 +00:00
|
|
|
foreach ( $config->get( 'AdvertisedFeedTypes' ) as $format ) {
|
2015-12-18 19:09:34 +00:00
|
|
|
$feedLinks[] = $this->feedLink(
|
2008-09-16 03:58:18 +00:00
|
|
|
$format,
|
2016-02-17 09:09:32 +00:00
|
|
|
$rctitle->getLocalURL( [ 'feed' => $format ] ),
|
2014-05-11 01:54:15 +00:00
|
|
|
# For grep: 'site-rss-feed', 'site-atom-feed'
|
2014-08-23 08:52:41 +00:00
|
|
|
$this->msg( "site-{$format}-feed", $sitename )->text()
|
2010-05-22 12:18:22 +00:00
|
|
|
);
|
2008-09-16 03:58:18 +00:00
|
|
|
}
|
2008-06-12 00:51:04 +00:00
|
|
|
}
|
2015-12-18 19:09:34 +00:00
|
|
|
|
|
|
|
|
# Allow extensions to change the list pf feeds. This hook is primarily for changing,
|
|
|
|
|
# manipulating or removing existing feed tags. If you want to add new feeds, you should
|
|
|
|
|
# use OutputPage::addFeedLink() instead.
|
2016-02-17 09:09:32 +00:00
|
|
|
Hooks::run( 'AfterBuildFeedLinks', [ &$feedLinks ] );
|
2015-12-18 19:09:34 +00:00
|
|
|
|
|
|
|
|
$tags += $feedLinks;
|
2004-03-19 08:05:36 +00:00
|
|
|
}
|
2012-12-31 01:11:43 +00:00
|
|
|
|
|
|
|
|
# Canonical URL
|
2014-08-23 08:52:41 +00:00
|
|
|
if ( $config->get( 'EnableCanonicalServerLink' ) ) {
|
2012-12-31 01:11:43 +00:00
|
|
|
if ( $canonicalUrl !== false ) {
|
|
|
|
|
$canonicalUrl = wfExpandUrl( $canonicalUrl, PROTO_CANONICAL );
|
|
|
|
|
} else {
|
Construct clean canonical URLs for wiki pages, ignoring request URL
Canonical URLs allow webmasters to indicate the preferred URL form for
accessing some content that can be reached via a multitude of URL patterns.
It is usually (but not always) distinct from the request URL, which may
feature things like aliases and session-specific query parameters.
We currently derive canonical URLs from request URLs, which is backwards:
it is the web application, not the client, that ought to know the canonical
way to refer to some content.
This patch ensures MediaWiki derives a clean canonical URL for all wiki
pages from the request context's title object and action.
For some assurance that this is the correct approach, see:
http://googlewebmastercentral.blogspot.com/2009/02/specify-your-canonical.html
This Google blog post identifies Wikia as exemplary in its usage of canonical
URLs. Wikia disregards things like the requested revision ID (oldid=NNN) when
constructing the canonical URL. See, for example:
http://fallout.wikia.com/wiki/Aqua_Pura_delivery_program?oldid=2171222
Wikia goes as far as canonicalizing the action=history to the page view URL.
I think that this is incorrect, because the history and info actions are not
views of the page content, but rather its associated metadata.
This affects all requests where "setArticleRelated" is true. This is typically
all urls that show content (title query, curid, oldid, diff), and all actions
thereof (edit, delete, purge, info, history etc.). It does not apply to
File pages and Special pages.
Bug: T67402
Change-Id: I1549ca056637981a0d751020c634b9fab387f7bc
2015-06-22 04:26:22 +00:00
|
|
|
if ( $this->isArticleRelated() ) {
|
|
|
|
|
// This affects all requests where "setArticleRelated" is true. This is
|
|
|
|
|
// typically all requests that show content (query title, curid, oldid, diff),
|
|
|
|
|
// and all wikipage actions (edit, delete, purge, info, history etc.).
|
|
|
|
|
// It does not apply to File pages and Special pages.
|
|
|
|
|
// 'history' and 'info' actions address page metadata rather than the page
|
|
|
|
|
// content itself, so they may not be canonicalized to the view page url.
|
|
|
|
|
// TODO: this ought to be better encapsulated in the Action class.
|
|
|
|
|
$action = Action::getActionName( $this->getContext() );
|
2016-02-17 09:09:32 +00:00
|
|
|
if ( in_array( $action, [ 'history', 'info' ] ) ) {
|
Construct clean canonical URLs for wiki pages, ignoring request URL
Canonical URLs allow webmasters to indicate the preferred URL form for
accessing some content that can be reached via a multitude of URL patterns.
It is usually (but not always) distinct from the request URL, which may
feature things like aliases and session-specific query parameters.
We currently derive canonical URLs from request URLs, which is backwards:
it is the web application, not the client, that ought to know the canonical
way to refer to some content.
This patch ensures MediaWiki derives a clean canonical URL for all wiki
pages from the request context's title object and action.
For some assurance that this is the correct approach, see:
http://googlewebmastercentral.blogspot.com/2009/02/specify-your-canonical.html
This Google blog post identifies Wikia as exemplary in its usage of canonical
URLs. Wikia disregards things like the requested revision ID (oldid=NNN) when
constructing the canonical URL. See, for example:
http://fallout.wikia.com/wiki/Aqua_Pura_delivery_program?oldid=2171222
Wikia goes as far as canonicalizing the action=history to the page view URL.
I think that this is incorrect, because the history and info actions are not
views of the page content, but rather its associated metadata.
This affects all requests where "setArticleRelated" is true. This is typically
all urls that show content (title query, curid, oldid, diff), and all actions
thereof (edit, delete, purge, info, history etc.). It does not apply to
File pages and Special pages.
Bug: T67402
Change-Id: I1549ca056637981a0d751020c634b9fab387f7bc
2015-06-22 04:26:22 +00:00
|
|
|
$query = "action={$action}";
|
|
|
|
|
} else {
|
|
|
|
|
$query = '';
|
|
|
|
|
}
|
|
|
|
|
$canonicalUrl = $this->getTitle()->getCanonicalURL( $query );
|
|
|
|
|
} else {
|
|
|
|
|
$reqUrl = $this->getRequest()->getRequestURL();
|
|
|
|
|
$canonicalUrl = wfExpandUrl( $reqUrl, PROTO_CANONICAL );
|
|
|
|
|
}
|
2012-12-31 01:11:43 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
if ( $canonicalUrl !== false ) {
|
2016-02-17 09:09:32 +00:00
|
|
|
$tags[] = Html::element( 'link', [
|
2012-12-31 01:11:43 +00:00
|
|
|
'rel' => 'canonical',
|
|
|
|
|
'href' => $canonicalUrl
|
2016-02-17 09:09:32 +00:00
|
|
|
] );
|
2012-12-31 01:11:43 +00:00
|
|
|
}
|
|
|
|
|
|
2012-04-24 17:25:06 +00:00
|
|
|
return $tags;
|
|
|
|
|
}
|
|
|
|
|
|
2008-01-12 00:13:53 +00:00
|
|
|
/**
|
2012-07-10 12:48:06 +00:00
|
|
|
* Generate a "<link rel/>" for a feed.
|
2010-01-29 21:32:45 +00:00
|
|
|
*
|
2014-04-08 15:29:17 +00:00
|
|
|
* @param string $type Feed type
|
2013-03-11 17:15:01 +00:00
|
|
|
* @param string $url URL to the feed
|
2014-04-08 15:29:17 +00:00
|
|
|
* @param string $text Value of the "title" attribute
|
|
|
|
|
* @return string HTML fragment
|
2007-09-24 18:25:56 +00:00
|
|
|
*/
|
|
|
|
|
private function feedLink( $type, $url, $text ) {
|
2016-02-17 09:09:32 +00:00
|
|
|
return Html::element( 'link', [
|
2007-09-24 18:25:56 +00:00
|
|
|
'rel' => 'alternate',
|
|
|
|
|
'type' => "application/$type+xml",
|
|
|
|
|
'title' => $text,
|
2016-02-17 09:09:32 +00:00
|
|
|
'href' => $url ]
|
2010-05-22 12:18:22 +00:00
|
|
|
);
|
2007-09-24 18:25:56 +00:00
|
|
|
}
|
2005-07-01 00:03:31 +00:00
|
|
|
|
2008-08-21 14:09:57 +00:00
|
|
|
/**
|
|
|
|
|
* Add a local or specified stylesheet, with the given media options.
|
2015-10-31 15:16:58 +00:00
|
|
|
* Internal use only. Use OutputPage::addModuleStyles() if possible.
|
2008-08-21 14:09:57 +00:00
|
|
|
*
|
2013-03-11 17:15:01 +00:00
|
|
|
* @param string $style URL to the file
|
2014-07-24 17:42:24 +00:00
|
|
|
* @param string $media To specify a media type, 'screen', 'printable', 'handheld' or any.
|
|
|
|
|
* @param string $condition For IE conditional comments, specifying an IE version
|
|
|
|
|
* @param string $dir Set to 'rtl' or 'ltr' for direction-specific sheets
|
2008-08-21 14:09:57 +00:00
|
|
|
*/
|
2010-05-22 12:18:22 +00:00
|
|
|
public function addStyle( $style, $media = '', $condition = '', $dir = '' ) {
|
2016-02-17 09:09:32 +00:00
|
|
|
$options = [];
|
2013-04-17 14:52:47 +00:00
|
|
|
if ( $media ) {
|
2008-08-21 14:09:57 +00:00
|
|
|
$options['media'] = $media;
|
2010-05-22 12:18:22 +00:00
|
|
|
}
|
2013-04-17 14:52:47 +00:00
|
|
|
if ( $condition ) {
|
2008-08-21 14:09:57 +00:00
|
|
|
$options['condition'] = $condition;
|
2010-05-22 12:18:22 +00:00
|
|
|
}
|
2013-04-17 14:52:47 +00:00
|
|
|
if ( $dir ) {
|
2008-08-21 14:09:57 +00:00
|
|
|
$options['dir'] = $dir;
|
2010-05-22 12:18:22 +00:00
|
|
|
}
|
2008-08-21 14:09:57 +00:00
|
|
|
$this->styles[$style] = $options;
|
|
|
|
|
}
|
2009-07-15 00:55:58 +00:00
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Adds inline CSS styles
|
2015-10-31 15:16:58 +00:00
|
|
|
* Internal use only. Use OutputPage::addModuleStyles() if possible.
|
|
|
|
|
*
|
2014-04-08 15:29:17 +00:00
|
|
|
* @param mixed $style_css Inline CSS
|
2013-03-11 17:15:01 +00:00
|
|
|
* @param string $flip Set to 'flip' to flip the CSS if needed
|
2009-07-15 00:55:58 +00:00
|
|
|
*/
|
2011-09-11 21:07:17 +00:00
|
|
|
public function addInlineStyle( $style_css, $flip = 'noflip' ) {
|
2013-04-17 14:52:47 +00:00
|
|
|
if ( $flip === 'flip' && $this->getLanguage()->isRTL() ) {
|
2011-09-04 21:50:02 +00:00
|
|
|
# If wanted, and the interface is right-to-left, flip the CSS
|
|
|
|
|
$style_css = CSSJanus::transform( $style_css, true, false );
|
|
|
|
|
}
|
2016-02-18 16:33:15 +00:00
|
|
|
$this->mInlineStyles .= Html::inlineStyle( $style_css );
|
here it is ... the upload-api, script-server, js2 (javascript phase2) branch merge 1st attempt.
Here is a short overview of changes and associated default configuration variables (most everything is off by default) also see ~soon to be updated~: http://www.mediawiki.org/wiki/Media_Projects_Overview
= Upload Improvements =
==Upload API ==
* Based on the early work of Bryan Tong and others it adds the upload option to the api.
* We rewrite Special:Upload page to include use the new refactoring
* Added in token checks in both the SpecialUpload.php page so avoids DOS / xss copy-by-url JavaScript based cross site POST file submissions
== Copy by URL==
$wgAllowCopyUploads = false;
* http class rewrite includes a new http background download see: includes/HttpFunctions.php
* spins off a php process that calls: maintenance/http_session_download.php
* pushes updates to the session and gives the user a progress bar on http copy uploads from other server progress (using js2 upload interface) (if not using the js2 upload interface it does the request in-place but the download is limited to the php ini timeout time)
== Firefogg ==
* Firefogg enables resumable upload by chunks
* progress indicators and conditional invokation (js2 system)
* and of-course client side transcoding.
= Script Server =
$wgEnableScriptLoader = false;
* off by default if $wgEnableScriptLoader is turned on script files are grouped, gziped, cached etc.
for more info see: http://www.mediawiki.org/wiki/Extension:ScriptLoader
* Includes some early skin js include fixes (skin/script system still lots of love)
* Includes a "javascript class autoloader" this is packaged into mwEmbed so that the mwEmbed library can work in stand alone mode (while retaining localization and script serving) (one such application is the make page for firefogg.org : http://www.firefogg.org/make/index.html )
* The file that contains the autojavascript loading classes is: js2/php/jsAutoloadLocalClasses.php
* One can use this auto class loading dependency system with extensions and add-ons but I need to better document that.
= js2 system / mwEmbed=
$wgEnableJS2system = false
* includes initial rewrite towards more jquery based javascript code
* especially for the Special:Upload page.
* Also the edit page include support for the "add-media-wizard"
* includes dependency loader for javascript that optionally takes advantage of the script-loader
* remote embedding of javascript interfaces (like embedding video, or commons media searching)
* $wgDebugJavaScript = false; .. .this variable lets you always get "always fresh javascript". When used with the script-loader it does not minify the script-loader output.
= mwEmbed =
* Will commit a separate patch to oggHandler that conditionally outputs <video tag> to use the new javascript video player.
** mv_embed player includes: play-head, volume control, remote embedding, oggz-chop support across plugins.
* add-media-wizard adds easy inserts of media to pages (with import)
== jQuery==
* we include a base install of jQuery, jQuery ui and some plugins.
* all the javascript classes are in the scriptloader so its easy to load any set of jquery ui components that you may need using the script-server. You get a callback so you can then execute js with dependencies loaded.
== other stuff ==
there is a bit more code in js2 that pertains to sequence editing, timed text display and basic image editing. We include a base import of pixastic-lib & pixastic-editor... will work with the pixastic developer to try and ensure upstream compatibility on our usage of the library for in-browser photo and sequence manipulation.
2009-07-14 23:52:14 +00:00
|
|
|
}
|
2009-07-15 00:55:58 +00:00
|
|
|
|
2008-08-21 14:09:57 +00:00
|
|
|
/**
|
resourceloader: Move queue formatting out of OutputPage
HTML formatting of the queue was distributed over several OutputPage methods.
Each method demanding a snippet of HTML by calling makeResourceLoaderLink()
with a limited amount of information. As such, makeResourceLoaderLink() was
unable to provide the client with the proper state information.
Centralising it also allows it to better reduce duplication in HTML output
and maintain a more accurate state.
Problems fixed by centralising:
1. The 'user' module is special (due to per-user 'version' and 'user' params).
It is manually requested via script-src. To avoid a separate (and wrong)
request from something that requires it, we set state=loading directly.
However, because the module is in the bottom, the old HTML formatter could
only put state=loading in the bottom also. This sometimes caused a wrong
request to be fired for modules=user if something in the top queue
triggered a requirement for it.
2. Since a464d1d4 (T87871) we track states of page-style modules, with purpose
of allowing dependencies on style modules without risking duplicate loading
on pages where the styles are loaded already. This didn't work, because the
state information about page-style modules is output near the stylesheet,
which is after the script tag with mw.loader.load(). That runs first, and
mw.loader would still make a duplicate request before it learns the state.
Changes:
* Document reasons for style/script tag order in getHeadHtml (per 09537e83).
* Pass $type from getModuleStyles() to getAllowedModules(). This wasn't needed
before since a duplicate check in makeResourceLoaderLink() verified the
origin a second time.
* Declare explicit position 'top' on 'user.options' and 'user.tokens' module.
Previously, OutputPage hardcoded them in the top. The new formatter doesn't.
* Remove getHeadScripts().
* Remove getInlineHeadScripts().
* Remove getExternalHeadScripts().
* Remove buildCssLinks().
* Remove getScriptsForBottomQueue().
* Change where Skin::setupSkinUserCss() is called. This methods lets the skin
add modules to the queue. Previously it was called from buildCssLinks(),
via headElement(), via prepareQuickTemplate(), via OutputPage::output().
It's now in OutputPage::output() directly (slightly earlier). This is needed
because prepareQuickTemplate() calls bottomScripts() before headElement().
And bottomScript() would lazy-initialise the queue and lock it before
setupSkinUserCss() is called from headElement().
This makes execution order more predictable instead of being dependent on
the arbitrary order of data extraction in prepareQuickTemplate (which varies
from one skin to another).
* Compute isUserModulePreview() and isKnownEmpty() for the 'user' module early
on so. This avoids wrongful loading and fixes problem 1.
Effective changes in output:
* mw.loader.state() is now before mw.loader.load(). This fixes problem 2.
* mw.loader.state() now sets 'user.options' and 'user.tokens' to "loading".
* mw.loader.state() now sets 'user' (as "loading" or "ready"). Fixes problem 1.
* The <script async src> tag for 'startup' changed position (slightly).
Previously it was after all inline scripts and stylesheets. It's still after
all inline scripts and after most stylesheets, but before any user styles.
Since the queue is now formatted outside OutputPage, it can't inject the
meta-ResourceLoaderDynamicStyles tag and user-stylesheet hack in the middle
of existing output. This shouldn't have any noticable impact.
Bug: T87871
Change-Id: I605b8cd1e1fc009b4662a0edbc54d09dd65ee1df
2016-07-15 14:13:09 +00:00
|
|
|
* Build exempt modules and legacy non-ResourceLoader styles.
|
2011-05-21 19:07:24 +00:00
|
|
|
*
|
2016-07-07 19:26:36 +00:00
|
|
|
* @return string|WrappedStringList HTML
|
2008-08-21 14:09:57 +00:00
|
|
|
*/
|
resourceloader: Move queue formatting out of OutputPage
HTML formatting of the queue was distributed over several OutputPage methods.
Each method demanding a snippet of HTML by calling makeResourceLoaderLink()
with a limited amount of information. As such, makeResourceLoaderLink() was
unable to provide the client with the proper state information.
Centralising it also allows it to better reduce duplication in HTML output
and maintain a more accurate state.
Problems fixed by centralising:
1. The 'user' module is special (due to per-user 'version' and 'user' params).
It is manually requested via script-src. To avoid a separate (and wrong)
request from something that requires it, we set state=loading directly.
However, because the module is in the bottom, the old HTML formatter could
only put state=loading in the bottom also. This sometimes caused a wrong
request to be fired for modules=user if something in the top queue
triggered a requirement for it.
2. Since a464d1d4 (T87871) we track states of page-style modules, with purpose
of allowing dependencies on style modules without risking duplicate loading
on pages where the styles are loaded already. This didn't work, because the
state information about page-style modules is output near the stylesheet,
which is after the script tag with mw.loader.load(). That runs first, and
mw.loader would still make a duplicate request before it learns the state.
Changes:
* Document reasons for style/script tag order in getHeadHtml (per 09537e83).
* Pass $type from getModuleStyles() to getAllowedModules(). This wasn't needed
before since a duplicate check in makeResourceLoaderLink() verified the
origin a second time.
* Declare explicit position 'top' on 'user.options' and 'user.tokens' module.
Previously, OutputPage hardcoded them in the top. The new formatter doesn't.
* Remove getHeadScripts().
* Remove getInlineHeadScripts().
* Remove getExternalHeadScripts().
* Remove buildCssLinks().
* Remove getScriptsForBottomQueue().
* Change where Skin::setupSkinUserCss() is called. This methods lets the skin
add modules to the queue. Previously it was called from buildCssLinks(),
via headElement(), via prepareQuickTemplate(), via OutputPage::output().
It's now in OutputPage::output() directly (slightly earlier). This is needed
because prepareQuickTemplate() calls bottomScripts() before headElement().
And bottomScript() would lazy-initialise the queue and lock it before
setupSkinUserCss() is called from headElement().
This makes execution order more predictable instead of being dependent on
the arbitrary order of data extraction in prepareQuickTemplate (which varies
from one skin to another).
* Compute isUserModulePreview() and isKnownEmpty() for the 'user' module early
on so. This avoids wrongful loading and fixes problem 1.
Effective changes in output:
* mw.loader.state() is now before mw.loader.load(). This fixes problem 2.
* mw.loader.state() now sets 'user.options' and 'user.tokens' to "loading".
* mw.loader.state() now sets 'user' (as "loading" or "ready"). Fixes problem 1.
* The <script async src> tag for 'startup' changed position (slightly).
Previously it was after all inline scripts and stylesheets. It's still after
all inline scripts and after most stylesheets, but before any user styles.
Since the queue is now formatted outside OutputPage, it can't inject the
meta-ResourceLoaderDynamicStyles tag and user-stylesheet hack in the middle
of existing output. This shouldn't have any noticable impact.
Bug: T87871
Change-Id: I605b8cd1e1fc009b4662a0edbc54d09dd65ee1df
2016-07-15 14:13:09 +00:00
|
|
|
protected function buildExemptModules() {
|
2014-08-23 08:52:41 +00:00
|
|
|
global $wgContLang;
|
2011-07-22 10:45:07 +00:00
|
|
|
|
resourceloader: Move queue formatting out of OutputPage
HTML formatting of the queue was distributed over several OutputPage methods.
Each method demanding a snippet of HTML by calling makeResourceLoaderLink()
with a limited amount of information. As such, makeResourceLoaderLink() was
unable to provide the client with the proper state information.
Centralising it also allows it to better reduce duplication in HTML output
and maintain a more accurate state.
Problems fixed by centralising:
1. The 'user' module is special (due to per-user 'version' and 'user' params).
It is manually requested via script-src. To avoid a separate (and wrong)
request from something that requires it, we set state=loading directly.
However, because the module is in the bottom, the old HTML formatter could
only put state=loading in the bottom also. This sometimes caused a wrong
request to be fired for modules=user if something in the top queue
triggered a requirement for it.
2. Since a464d1d4 (T87871) we track states of page-style modules, with purpose
of allowing dependencies on style modules without risking duplicate loading
on pages where the styles are loaded already. This didn't work, because the
state information about page-style modules is output near the stylesheet,
which is after the script tag with mw.loader.load(). That runs first, and
mw.loader would still make a duplicate request before it learns the state.
Changes:
* Document reasons for style/script tag order in getHeadHtml (per 09537e83).
* Pass $type from getModuleStyles() to getAllowedModules(). This wasn't needed
before since a duplicate check in makeResourceLoaderLink() verified the
origin a second time.
* Declare explicit position 'top' on 'user.options' and 'user.tokens' module.
Previously, OutputPage hardcoded them in the top. The new formatter doesn't.
* Remove getHeadScripts().
* Remove getInlineHeadScripts().
* Remove getExternalHeadScripts().
* Remove buildCssLinks().
* Remove getScriptsForBottomQueue().
* Change where Skin::setupSkinUserCss() is called. This methods lets the skin
add modules to the queue. Previously it was called from buildCssLinks(),
via headElement(), via prepareQuickTemplate(), via OutputPage::output().
It's now in OutputPage::output() directly (slightly earlier). This is needed
because prepareQuickTemplate() calls bottomScripts() before headElement().
And bottomScript() would lazy-initialise the queue and lock it before
setupSkinUserCss() is called from headElement().
This makes execution order more predictable instead of being dependent on
the arbitrary order of data extraction in prepareQuickTemplate (which varies
from one skin to another).
* Compute isUserModulePreview() and isKnownEmpty() for the 'user' module early
on so. This avoids wrongful loading and fixes problem 1.
Effective changes in output:
* mw.loader.state() is now before mw.loader.load(). This fixes problem 2.
* mw.loader.state() now sets 'user.options' and 'user.tokens' to "loading".
* mw.loader.state() now sets 'user' (as "loading" or "ready"). Fixes problem 1.
* The <script async src> tag for 'startup' changed position (slightly).
Previously it was after all inline scripts and stylesheets. It's still after
all inline scripts and after most stylesheets, but before any user styles.
Since the queue is now formatted outside OutputPage, it can't inject the
meta-ResourceLoaderDynamicStyles tag and user-stylesheet hack in the middle
of existing output. This shouldn't have any noticable impact.
Bug: T87871
Change-Id: I605b8cd1e1fc009b4662a0edbc54d09dd65ee1df
2016-07-15 14:13:09 +00:00
|
|
|
$chunks = [];
|
2016-08-19 02:04:21 +00:00
|
|
|
// Things that go after the ResourceLoaderDynamicStyles marker
|
resourceloader: Move queue formatting out of OutputPage
HTML formatting of the queue was distributed over several OutputPage methods.
Each method demanding a snippet of HTML by calling makeResourceLoaderLink()
with a limited amount of information. As such, makeResourceLoaderLink() was
unable to provide the client with the proper state information.
Centralising it also allows it to better reduce duplication in HTML output
and maintain a more accurate state.
Problems fixed by centralising:
1. The 'user' module is special (due to per-user 'version' and 'user' params).
It is manually requested via script-src. To avoid a separate (and wrong)
request from something that requires it, we set state=loading directly.
However, because the module is in the bottom, the old HTML formatter could
only put state=loading in the bottom also. This sometimes caused a wrong
request to be fired for modules=user if something in the top queue
triggered a requirement for it.
2. Since a464d1d4 (T87871) we track states of page-style modules, with purpose
of allowing dependencies on style modules without risking duplicate loading
on pages where the styles are loaded already. This didn't work, because the
state information about page-style modules is output near the stylesheet,
which is after the script tag with mw.loader.load(). That runs first, and
mw.loader would still make a duplicate request before it learns the state.
Changes:
* Document reasons for style/script tag order in getHeadHtml (per 09537e83).
* Pass $type from getModuleStyles() to getAllowedModules(). This wasn't needed
before since a duplicate check in makeResourceLoaderLink() verified the
origin a second time.
* Declare explicit position 'top' on 'user.options' and 'user.tokens' module.
Previously, OutputPage hardcoded them in the top. The new formatter doesn't.
* Remove getHeadScripts().
* Remove getInlineHeadScripts().
* Remove getExternalHeadScripts().
* Remove buildCssLinks().
* Remove getScriptsForBottomQueue().
* Change where Skin::setupSkinUserCss() is called. This methods lets the skin
add modules to the queue. Previously it was called from buildCssLinks(),
via headElement(), via prepareQuickTemplate(), via OutputPage::output().
It's now in OutputPage::output() directly (slightly earlier). This is needed
because prepareQuickTemplate() calls bottomScripts() before headElement().
And bottomScript() would lazy-initialise the queue and lock it before
setupSkinUserCss() is called from headElement().
This makes execution order more predictable instead of being dependent on
the arbitrary order of data extraction in prepareQuickTemplate (which varies
from one skin to another).
* Compute isUserModulePreview() and isKnownEmpty() for the 'user' module early
on so. This avoids wrongful loading and fixes problem 1.
Effective changes in output:
* mw.loader.state() is now before mw.loader.load(). This fixes problem 2.
* mw.loader.state() now sets 'user.options' and 'user.tokens' to "loading".
* mw.loader.state() now sets 'user' (as "loading" or "ready"). Fixes problem 1.
* The <script async src> tag for 'startup' changed position (slightly).
Previously it was after all inline scripts and stylesheets. It's still after
all inline scripts and after most stylesheets, but before any user styles.
Since the queue is now formatted outside OutputPage, it can't inject the
meta-ResourceLoaderDynamicStyles tag and user-stylesheet hack in the middle
of existing output. This shouldn't have any noticable impact.
Bug: T87871
Change-Id: I605b8cd1e1fc009b4662a0edbc54d09dd65ee1df
2016-07-15 14:13:09 +00:00
|
|
|
$append = [];
|
2011-07-22 10:45:07 +00:00
|
|
|
|
2016-08-19 02:04:21 +00:00
|
|
|
// Exempt 'user' styles module (may need 'excludepages' for live preview)
|
|
|
|
|
if ( $this->isUserCssPreview() ) {
|
resourceloader: Move queue formatting out of OutputPage
HTML formatting of the queue was distributed over several OutputPage methods.
Each method demanding a snippet of HTML by calling makeResourceLoaderLink()
with a limited amount of information. As such, makeResourceLoaderLink() was
unable to provide the client with the proper state information.
Centralising it also allows it to better reduce duplication in HTML output
and maintain a more accurate state.
Problems fixed by centralising:
1. The 'user' module is special (due to per-user 'version' and 'user' params).
It is manually requested via script-src. To avoid a separate (and wrong)
request from something that requires it, we set state=loading directly.
However, because the module is in the bottom, the old HTML formatter could
only put state=loading in the bottom also. This sometimes caused a wrong
request to be fired for modules=user if something in the top queue
triggered a requirement for it.
2. Since a464d1d4 (T87871) we track states of page-style modules, with purpose
of allowing dependencies on style modules without risking duplicate loading
on pages where the styles are loaded already. This didn't work, because the
state information about page-style modules is output near the stylesheet,
which is after the script tag with mw.loader.load(). That runs first, and
mw.loader would still make a duplicate request before it learns the state.
Changes:
* Document reasons for style/script tag order in getHeadHtml (per 09537e83).
* Pass $type from getModuleStyles() to getAllowedModules(). This wasn't needed
before since a duplicate check in makeResourceLoaderLink() verified the
origin a second time.
* Declare explicit position 'top' on 'user.options' and 'user.tokens' module.
Previously, OutputPage hardcoded them in the top. The new formatter doesn't.
* Remove getHeadScripts().
* Remove getInlineHeadScripts().
* Remove getExternalHeadScripts().
* Remove buildCssLinks().
* Remove getScriptsForBottomQueue().
* Change where Skin::setupSkinUserCss() is called. This methods lets the skin
add modules to the queue. Previously it was called from buildCssLinks(),
via headElement(), via prepareQuickTemplate(), via OutputPage::output().
It's now in OutputPage::output() directly (slightly earlier). This is needed
because prepareQuickTemplate() calls bottomScripts() before headElement().
And bottomScript() would lazy-initialise the queue and lock it before
setupSkinUserCss() is called from headElement().
This makes execution order more predictable instead of being dependent on
the arbitrary order of data extraction in prepareQuickTemplate (which varies
from one skin to another).
* Compute isUserModulePreview() and isKnownEmpty() for the 'user' module early
on so. This avoids wrongful loading and fixes problem 1.
Effective changes in output:
* mw.loader.state() is now before mw.loader.load(). This fixes problem 2.
* mw.loader.state() now sets 'user.options' and 'user.tokens' to "loading".
* mw.loader.state() now sets 'user' (as "loading" or "ready"). Fixes problem 1.
* The <script async src> tag for 'startup' changed position (slightly).
Previously it was after all inline scripts and stylesheets. It's still after
all inline scripts and after most stylesheets, but before any user styles.
Since the queue is now formatted outside OutputPage, it can't inject the
meta-ResourceLoaderDynamicStyles tag and user-stylesheet hack in the middle
of existing output. This shouldn't have any noticable impact.
Bug: T87871
Change-Id: I605b8cd1e1fc009b4662a0edbc54d09dd65ee1df
2016-07-15 14:13:09 +00:00
|
|
|
$append[] = $this->makeResourceLoaderLink(
|
|
|
|
|
'user.styles',
|
|
|
|
|
ResourceLoaderModule::TYPE_STYLES,
|
2016-02-17 09:09:32 +00:00
|
|
|
[ 'excludepage' => $this->getTitle()->getPrefixedDBkey() ]
|
2013-11-14 16:54:19 +00:00
|
|
|
);
|
|
|
|
|
|
resourceloader: Move queue formatting out of OutputPage
HTML formatting of the queue was distributed over several OutputPage methods.
Each method demanding a snippet of HTML by calling makeResourceLoaderLink()
with a limited amount of information. As such, makeResourceLoaderLink() was
unable to provide the client with the proper state information.
Centralising it also allows it to better reduce duplication in HTML output
and maintain a more accurate state.
Problems fixed by centralising:
1. The 'user' module is special (due to per-user 'version' and 'user' params).
It is manually requested via script-src. To avoid a separate (and wrong)
request from something that requires it, we set state=loading directly.
However, because the module is in the bottom, the old HTML formatter could
only put state=loading in the bottom also. This sometimes caused a wrong
request to be fired for modules=user if something in the top queue
triggered a requirement for it.
2. Since a464d1d4 (T87871) we track states of page-style modules, with purpose
of allowing dependencies on style modules without risking duplicate loading
on pages where the styles are loaded already. This didn't work, because the
state information about page-style modules is output near the stylesheet,
which is after the script tag with mw.loader.load(). That runs first, and
mw.loader would still make a duplicate request before it learns the state.
Changes:
* Document reasons for style/script tag order in getHeadHtml (per 09537e83).
* Pass $type from getModuleStyles() to getAllowedModules(). This wasn't needed
before since a duplicate check in makeResourceLoaderLink() verified the
origin a second time.
* Declare explicit position 'top' on 'user.options' and 'user.tokens' module.
Previously, OutputPage hardcoded them in the top. The new formatter doesn't.
* Remove getHeadScripts().
* Remove getInlineHeadScripts().
* Remove getExternalHeadScripts().
* Remove buildCssLinks().
* Remove getScriptsForBottomQueue().
* Change where Skin::setupSkinUserCss() is called. This methods lets the skin
add modules to the queue. Previously it was called from buildCssLinks(),
via headElement(), via prepareQuickTemplate(), via OutputPage::output().
It's now in OutputPage::output() directly (slightly earlier). This is needed
because prepareQuickTemplate() calls bottomScripts() before headElement().
And bottomScript() would lazy-initialise the queue and lock it before
setupSkinUserCss() is called from headElement().
This makes execution order more predictable instead of being dependent on
the arbitrary order of data extraction in prepareQuickTemplate (which varies
from one skin to another).
* Compute isUserModulePreview() and isKnownEmpty() for the 'user' module early
on so. This avoids wrongful loading and fixes problem 1.
Effective changes in output:
* mw.loader.state() is now before mw.loader.load(). This fixes problem 2.
* mw.loader.state() now sets 'user.options' and 'user.tokens' to "loading".
* mw.loader.state() now sets 'user' (as "loading" or "ready"). Fixes problem 1.
* The <script async src> tag for 'startup' changed position (slightly).
Previously it was after all inline scripts and stylesheets. It's still after
all inline scripts and after most stylesheets, but before any user styles.
Since the queue is now formatted outside OutputPage, it can't inject the
meta-ResourceLoaderDynamicStyles tag and user-stylesheet hack in the middle
of existing output. This shouldn't have any noticable impact.
Bug: T87871
Change-Id: I605b8cd1e1fc009b4662a0edbc54d09dd65ee1df
2016-07-15 14:13:09 +00:00
|
|
|
// Load the previewed CSS. Janus it if needed.
|
|
|
|
|
// User-supplied CSS is assumed to in the wiki's content language.
|
2013-11-14 16:54:19 +00:00
|
|
|
$previewedCSS = $this->getRequest()->getText( 'wpTextbox1' );
|
|
|
|
|
if ( $this->getLanguage()->getDir() !== $wgContLang->getDir() ) {
|
|
|
|
|
$previewedCSS = CSSJanus::transform( $previewedCSS, true, false );
|
2011-07-22 10:45:07 +00:00
|
|
|
}
|
resourceloader: Move queue formatting out of OutputPage
HTML formatting of the queue was distributed over several OutputPage methods.
Each method demanding a snippet of HTML by calling makeResourceLoaderLink()
with a limited amount of information. As such, makeResourceLoaderLink() was
unable to provide the client with the proper state information.
Centralising it also allows it to better reduce duplication in HTML output
and maintain a more accurate state.
Problems fixed by centralising:
1. The 'user' module is special (due to per-user 'version' and 'user' params).
It is manually requested via script-src. To avoid a separate (and wrong)
request from something that requires it, we set state=loading directly.
However, because the module is in the bottom, the old HTML formatter could
only put state=loading in the bottom also. This sometimes caused a wrong
request to be fired for modules=user if something in the top queue
triggered a requirement for it.
2. Since a464d1d4 (T87871) we track states of page-style modules, with purpose
of allowing dependencies on style modules without risking duplicate loading
on pages where the styles are loaded already. This didn't work, because the
state information about page-style modules is output near the stylesheet,
which is after the script tag with mw.loader.load(). That runs first, and
mw.loader would still make a duplicate request before it learns the state.
Changes:
* Document reasons for style/script tag order in getHeadHtml (per 09537e83).
* Pass $type from getModuleStyles() to getAllowedModules(). This wasn't needed
before since a duplicate check in makeResourceLoaderLink() verified the
origin a second time.
* Declare explicit position 'top' on 'user.options' and 'user.tokens' module.
Previously, OutputPage hardcoded them in the top. The new formatter doesn't.
* Remove getHeadScripts().
* Remove getInlineHeadScripts().
* Remove getExternalHeadScripts().
* Remove buildCssLinks().
* Remove getScriptsForBottomQueue().
* Change where Skin::setupSkinUserCss() is called. This methods lets the skin
add modules to the queue. Previously it was called from buildCssLinks(),
via headElement(), via prepareQuickTemplate(), via OutputPage::output().
It's now in OutputPage::output() directly (slightly earlier). This is needed
because prepareQuickTemplate() calls bottomScripts() before headElement().
And bottomScript() would lazy-initialise the queue and lock it before
setupSkinUserCss() is called from headElement().
This makes execution order more predictable instead of being dependent on
the arbitrary order of data extraction in prepareQuickTemplate (which varies
from one skin to another).
* Compute isUserModulePreview() and isKnownEmpty() for the 'user' module early
on so. This avoids wrongful loading and fixes problem 1.
Effective changes in output:
* mw.loader.state() is now before mw.loader.load(). This fixes problem 2.
* mw.loader.state() now sets 'user.options' and 'user.tokens' to "loading".
* mw.loader.state() now sets 'user' (as "loading" or "ready"). Fixes problem 1.
* The <script async src> tag for 'startup' changed position (slightly).
Previously it was after all inline scripts and stylesheets. It's still after
all inline scripts and after most stylesheets, but before any user styles.
Since the queue is now formatted outside OutputPage, it can't inject the
meta-ResourceLoaderDynamicStyles tag and user-stylesheet hack in the middle
of existing output. This shouldn't have any noticable impact.
Bug: T87871
Change-Id: I605b8cd1e1fc009b4662a0edbc54d09dd65ee1df
2016-07-15 14:13:09 +00:00
|
|
|
$append[] = Html::inlineStyle( $previewedCSS );
|
2011-01-06 16:58:29 +00:00
|
|
|
}
|
|
|
|
|
|
2016-08-19 02:04:21 +00:00
|
|
|
// We want site, private and user styles to override dynamically added styles from
|
|
|
|
|
// general modules, but we want dynamically added styles to override statically added
|
|
|
|
|
// style modules. So the order has to be:
|
|
|
|
|
// - page style modules (formatted by ResourceLoaderClientHtml::getHeadHtml())
|
|
|
|
|
// - dynamically loaded styles (added by mw.loader before ResourceLoaderDynamicStyles)
|
|
|
|
|
// - ResourceLoaderDynamicStyles marker
|
|
|
|
|
// - site/private/user styles
|
resourceloader: Move queue formatting out of OutputPage
HTML formatting of the queue was distributed over several OutputPage methods.
Each method demanding a snippet of HTML by calling makeResourceLoaderLink()
with a limited amount of information. As such, makeResourceLoaderLink() was
unable to provide the client with the proper state information.
Centralising it also allows it to better reduce duplication in HTML output
and maintain a more accurate state.
Problems fixed by centralising:
1. The 'user' module is special (due to per-user 'version' and 'user' params).
It is manually requested via script-src. To avoid a separate (and wrong)
request from something that requires it, we set state=loading directly.
However, because the module is in the bottom, the old HTML formatter could
only put state=loading in the bottom also. This sometimes caused a wrong
request to be fired for modules=user if something in the top queue
triggered a requirement for it.
2. Since a464d1d4 (T87871) we track states of page-style modules, with purpose
of allowing dependencies on style modules without risking duplicate loading
on pages where the styles are loaded already. This didn't work, because the
state information about page-style modules is output near the stylesheet,
which is after the script tag with mw.loader.load(). That runs first, and
mw.loader would still make a duplicate request before it learns the state.
Changes:
* Document reasons for style/script tag order in getHeadHtml (per 09537e83).
* Pass $type from getModuleStyles() to getAllowedModules(). This wasn't needed
before since a duplicate check in makeResourceLoaderLink() verified the
origin a second time.
* Declare explicit position 'top' on 'user.options' and 'user.tokens' module.
Previously, OutputPage hardcoded them in the top. The new formatter doesn't.
* Remove getHeadScripts().
* Remove getInlineHeadScripts().
* Remove getExternalHeadScripts().
* Remove buildCssLinks().
* Remove getScriptsForBottomQueue().
* Change where Skin::setupSkinUserCss() is called. This methods lets the skin
add modules to the queue. Previously it was called from buildCssLinks(),
via headElement(), via prepareQuickTemplate(), via OutputPage::output().
It's now in OutputPage::output() directly (slightly earlier). This is needed
because prepareQuickTemplate() calls bottomScripts() before headElement().
And bottomScript() would lazy-initialise the queue and lock it before
setupSkinUserCss() is called from headElement().
This makes execution order more predictable instead of being dependent on
the arbitrary order of data extraction in prepareQuickTemplate (which varies
from one skin to another).
* Compute isUserModulePreview() and isKnownEmpty() for the 'user' module early
on so. This avoids wrongful loading and fixes problem 1.
Effective changes in output:
* mw.loader.state() is now before mw.loader.load(). This fixes problem 2.
* mw.loader.state() now sets 'user.options' and 'user.tokens' to "loading".
* mw.loader.state() now sets 'user' (as "loading" or "ready"). Fixes problem 1.
* The <script async src> tag for 'startup' changed position (slightly).
Previously it was after all inline scripts and stylesheets. It's still after
all inline scripts and after most stylesheets, but before any user styles.
Since the queue is now formatted outside OutputPage, it can't inject the
meta-ResourceLoaderDynamicStyles tag and user-stylesheet hack in the middle
of existing output. This shouldn't have any noticable impact.
Bug: T87871
Change-Id: I605b8cd1e1fc009b4662a0edbc54d09dd65ee1df
2016-07-15 14:13:09 +00:00
|
|
|
|
|
|
|
|
// Add legacy styles added through addStyle()/addInlineStyle() here
|
|
|
|
|
$chunks[] = implode( '', $this->buildCssLinksArray() ) . $this->mInlineStyles;
|
|
|
|
|
|
|
|
|
|
$chunks[] = Html::element(
|
2014-05-11 01:54:15 +00:00
|
|
|
'meta',
|
2016-02-17 09:09:32 +00:00
|
|
|
[ 'name' => 'ResourceLoaderDynamicStyles', 'content' => '' ]
|
2015-07-31 00:13:04 +00:00
|
|
|
);
|
2011-04-23 19:28:35 +00:00
|
|
|
|
2017-05-12 22:26:36 +00:00
|
|
|
$separateReq = [ 'site.styles', 'user.styles' ];
|
2016-08-19 02:04:21 +00:00
|
|
|
foreach ( $this->rlExemptStyleModules as $group => $moduleNames ) {
|
2017-05-12 22:26:36 +00:00
|
|
|
// Combinable modules
|
|
|
|
|
$chunks[] = $this->makeResourceLoaderLink(
|
|
|
|
|
array_diff( $moduleNames, $separateReq ),
|
2013-11-14 16:54:19 +00:00
|
|
|
ResourceLoaderModule::TYPE_STYLES
|
2011-02-20 17:24:42 +00:00
|
|
|
);
|
2017-05-12 22:26:36 +00:00
|
|
|
|
|
|
|
|
foreach ( array_intersect( $moduleNames, $separateReq ) as $name ) {
|
|
|
|
|
// These require their own dedicated request in order to support "@import"
|
|
|
|
|
// syntax, which is incompatible with concatenation. (T147667, T37562)
|
|
|
|
|
$chunks[] = $this->makeResourceLoaderLink( $name,
|
|
|
|
|
ResourceLoaderModule::TYPE_STYLES
|
|
|
|
|
);
|
|
|
|
|
}
|
2011-02-20 17:24:42 +00:00
|
|
|
}
|
2011-08-31 14:47:08 +00:00
|
|
|
|
resourceloader: Move queue formatting out of OutputPage
HTML formatting of the queue was distributed over several OutputPage methods.
Each method demanding a snippet of HTML by calling makeResourceLoaderLink()
with a limited amount of information. As such, makeResourceLoaderLink() was
unable to provide the client with the proper state information.
Centralising it also allows it to better reduce duplication in HTML output
and maintain a more accurate state.
Problems fixed by centralising:
1. The 'user' module is special (due to per-user 'version' and 'user' params).
It is manually requested via script-src. To avoid a separate (and wrong)
request from something that requires it, we set state=loading directly.
However, because the module is in the bottom, the old HTML formatter could
only put state=loading in the bottom also. This sometimes caused a wrong
request to be fired for modules=user if something in the top queue
triggered a requirement for it.
2. Since a464d1d4 (T87871) we track states of page-style modules, with purpose
of allowing dependencies on style modules without risking duplicate loading
on pages where the styles are loaded already. This didn't work, because the
state information about page-style modules is output near the stylesheet,
which is after the script tag with mw.loader.load(). That runs first, and
mw.loader would still make a duplicate request before it learns the state.
Changes:
* Document reasons for style/script tag order in getHeadHtml (per 09537e83).
* Pass $type from getModuleStyles() to getAllowedModules(). This wasn't needed
before since a duplicate check in makeResourceLoaderLink() verified the
origin a second time.
* Declare explicit position 'top' on 'user.options' and 'user.tokens' module.
Previously, OutputPage hardcoded them in the top. The new formatter doesn't.
* Remove getHeadScripts().
* Remove getInlineHeadScripts().
* Remove getExternalHeadScripts().
* Remove buildCssLinks().
* Remove getScriptsForBottomQueue().
* Change where Skin::setupSkinUserCss() is called. This methods lets the skin
add modules to the queue. Previously it was called from buildCssLinks(),
via headElement(), via prepareQuickTemplate(), via OutputPage::output().
It's now in OutputPage::output() directly (slightly earlier). This is needed
because prepareQuickTemplate() calls bottomScripts() before headElement().
And bottomScript() would lazy-initialise the queue and lock it before
setupSkinUserCss() is called from headElement().
This makes execution order more predictable instead of being dependent on
the arbitrary order of data extraction in prepareQuickTemplate (which varies
from one skin to another).
* Compute isUserModulePreview() and isKnownEmpty() for the 'user' module early
on so. This avoids wrongful loading and fixes problem 1.
Effective changes in output:
* mw.loader.state() is now before mw.loader.load(). This fixes problem 2.
* mw.loader.state() now sets 'user.options' and 'user.tokens' to "loading".
* mw.loader.state() now sets 'user' (as "loading" or "ready"). Fixes problem 1.
* The <script async src> tag for 'startup' changed position (slightly).
Previously it was after all inline scripts and stylesheets. It's still after
all inline scripts and after most stylesheets, but before any user styles.
Since the queue is now formatted outside OutputPage, it can't inject the
meta-ResourceLoaderDynamicStyles tag and user-stylesheet hack in the middle
of existing output. This shouldn't have any noticable impact.
Bug: T87871
Change-Id: I605b8cd1e1fc009b4662a0edbc54d09dd65ee1df
2016-07-15 14:13:09 +00:00
|
|
|
return self::combineWrappedStrings( array_merge( $chunks, $append ) );
|
2010-05-24 16:35:23 +00:00
|
|
|
}
|
|
|
|
|
|
2011-09-11 21:07:17 +00:00
|
|
|
/**
|
2014-04-10 18:50:10 +00:00
|
|
|
* @return array
|
2011-09-11 21:07:17 +00:00
|
|
|
*/
|
2010-05-24 16:35:23 +00:00
|
|
|
public function buildCssLinksArray() {
|
2016-02-17 09:09:32 +00:00
|
|
|
$links = [];
|
2011-07-22 10:45:07 +00:00
|
|
|
|
|
|
|
|
// Add any extension CSS
|
|
|
|
|
foreach ( $this->mExtStyles as $url ) {
|
|
|
|
|
$this->addStyle( $url );
|
|
|
|
|
}
|
2016-02-17 09:09:32 +00:00
|
|
|
$this->mExtStyles = [];
|
2011-07-22 10:45:07 +00:00
|
|
|
|
2013-04-17 14:52:47 +00:00
|
|
|
foreach ( $this->styles as $file => $options ) {
|
2008-08-21 14:09:57 +00:00
|
|
|
$link = $this->styleLink( $file, $options );
|
2013-04-17 14:52:47 +00:00
|
|
|
if ( $link ) {
|
2010-05-24 16:35:23 +00:00
|
|
|
$links[$file] = $link;
|
2010-05-22 12:18:22 +00:00
|
|
|
}
|
2008-08-21 14:09:57 +00:00
|
|
|
}
|
2010-05-24 16:35:23 +00:00
|
|
|
return $links;
|
2008-08-21 14:09:57 +00:00
|
|
|
}
|
|
|
|
|
|
2010-01-29 21:32:45 +00:00
|
|
|
/**
|
|
|
|
|
* Generate \<link\> tags for stylesheets
|
|
|
|
|
*
|
2013-03-11 17:15:01 +00:00
|
|
|
* @param string $style URL to the file
|
2014-04-08 15:29:17 +00:00
|
|
|
* @param array $options Option, can contain 'condition', 'dir', 'media' keys
|
|
|
|
|
* @return string HTML fragment
|
2010-01-29 21:32:45 +00:00
|
|
|
*/
|
2014-07-23 02:49:30 +00:00
|
|
|
protected function styleLink( $style, array $options ) {
|
2013-04-17 14:52:47 +00:00
|
|
|
if ( isset( $options['dir'] ) ) {
|
|
|
|
|
if ( $this->getLanguage()->getDir() != $options['dir'] ) {
|
2008-08-21 14:09:57 +00:00
|
|
|
return '';
|
2010-05-22 12:18:22 +00:00
|
|
|
}
|
2008-08-21 14:09:57 +00:00
|
|
|
}
|
|
|
|
|
|
2013-04-17 14:52:47 +00:00
|
|
|
if ( isset( $options['media'] ) ) {
|
2011-01-07 20:22:50 +00:00
|
|
|
$media = self::transformCssMedia( $options['media'] );
|
2013-04-17 14:52:47 +00:00
|
|
|
if ( is_null( $media ) ) {
|
2008-08-21 14:09:57 +00:00
|
|
|
return '';
|
|
|
|
|
}
|
|
|
|
|
} else {
|
2009-09-07 00:21:55 +00:00
|
|
|
$media = 'all';
|
2008-08-21 14:09:57 +00:00
|
|
|
}
|
|
|
|
|
|
2013-04-17 14:52:47 +00:00
|
|
|
if ( substr( $style, 0, 1 ) == '/' ||
|
2008-08-21 14:09:57 +00:00
|
|
|
substr( $style, 0, 5 ) == 'http:' ||
|
|
|
|
|
substr( $style, 0, 6 ) == 'https:' ) {
|
|
|
|
|
$url = $style;
|
|
|
|
|
} else {
|
2014-08-23 08:52:41 +00:00
|
|
|
$config = $this->getConfig();
|
2015-09-27 07:58:17 +00:00
|
|
|
$url = $config->get( 'StylePath' ) . '/' . $style . '?' .
|
|
|
|
|
$config->get( 'StyleVersion' );
|
2008-08-21 14:09:57 +00:00
|
|
|
}
|
|
|
|
|
|
2009-08-11 00:09:24 +00:00
|
|
|
$link = Html::linkedStyle( $url, $media );
|
2008-08-21 14:09:57 +00:00
|
|
|
|
2013-04-17 14:52:47 +00:00
|
|
|
if ( isset( $options['condition'] ) ) {
|
2008-08-21 14:09:57 +00:00
|
|
|
$condition = htmlspecialchars( $options['condition'] );
|
|
|
|
|
$link = "<!--[if $condition]>$link<![endif]-->";
|
|
|
|
|
}
|
|
|
|
|
return $link;
|
|
|
|
|
}
|
|
|
|
|
|
2016-01-22 22:58:03 +00:00
|
|
|
/**
|
|
|
|
|
* Transform path to web-accessible static resource.
|
|
|
|
|
*
|
|
|
|
|
* This is used to add a validation hash as query string.
|
|
|
|
|
* This aids various behaviors:
|
|
|
|
|
*
|
|
|
|
|
* - Put long Cache-Control max-age headers on responses for improved
|
|
|
|
|
* cache performance.
|
|
|
|
|
* - Get the correct version of a file as expected by the current page.
|
|
|
|
|
* - Instantly get the updated version of a file after deployment.
|
|
|
|
|
*
|
|
|
|
|
* Avoid using this for urls included in HTML as otherwise clients may get different
|
|
|
|
|
* versions of a resource when navigating the site depending on when the page was cached.
|
|
|
|
|
* If changes to the url propagate, this is not a problem (e.g. if the url is in
|
|
|
|
|
* an external stylesheet).
|
|
|
|
|
*
|
|
|
|
|
* @since 1.27
|
|
|
|
|
* @param Config $config
|
|
|
|
|
* @param string $path Path-absolute URL to file (from document root, must start with "/")
|
|
|
|
|
* @return string URL
|
|
|
|
|
*/
|
|
|
|
|
public static function transformResourcePath( Config $config, $path ) {
|
|
|
|
|
global $IP;
|
2017-02-10 00:03:06 +00:00
|
|
|
|
|
|
|
|
$localDir = $IP;
|
2016-02-22 03:51:19 +00:00
|
|
|
$remotePathPrefix = $config->get( 'ResourceBasePath' );
|
|
|
|
|
if ( $remotePathPrefix === '' ) {
|
|
|
|
|
// The configured base path is required to be empty string for
|
|
|
|
|
// wikis in the domain root
|
|
|
|
|
$remotePath = '/';
|
|
|
|
|
} else {
|
|
|
|
|
$remotePath = $remotePathPrefix;
|
|
|
|
|
}
|
2017-01-18 06:07:05 +00:00
|
|
|
if ( strpos( $path, $remotePath ) !== 0 || substr( $path, 0, 2 ) === '//' ) {
|
|
|
|
|
// - Path is outside wgResourceBasePath, ignore.
|
|
|
|
|
// - Path is protocol-relative. Fixes T155310. Not supported by RelPath lib.
|
2016-01-22 22:58:03 +00:00
|
|
|
return $path;
|
|
|
|
|
}
|
2017-02-10 00:03:06 +00:00
|
|
|
// For files in resources, extensions/ or skins/, ResourceBasePath is preferred here.
|
|
|
|
|
// For other misc files in $IP, we'll fallback to that as well. There is, however, a fourth
|
|
|
|
|
// supported dir/path pair in the configuration (wgUploadDirectory, wgUploadPath)
|
|
|
|
|
// which is not expected to be in wgResourceBasePath on CDNs. (T155146)
|
|
|
|
|
$uploadPath = $config->get( 'UploadPath' );
|
|
|
|
|
if ( strpos( $path, $uploadPath ) === 0 ) {
|
|
|
|
|
$localDir = $config->get( 'UploadDirectory' );
|
|
|
|
|
$remotePathPrefix = $remotePath = $uploadPath;
|
|
|
|
|
}
|
|
|
|
|
|
2016-01-22 22:58:03 +00:00
|
|
|
$path = RelPath\getRelativePath( $path, $remotePath );
|
2017-02-10 00:03:06 +00:00
|
|
|
return self::transformFilePath( $remotePathPrefix, $localDir, $path );
|
2016-01-22 22:58:03 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Utility method for transformResourceFilePath().
|
|
|
|
|
*
|
|
|
|
|
* Caller is responsible for ensuring the file exists. Emits a PHP warning otherwise.
|
|
|
|
|
*
|
|
|
|
|
* @since 1.27
|
2017-08-11 16:09:41 +00:00
|
|
|
* @param string $remotePathPrefix URL path prefix that points to $localPath
|
2016-01-22 22:58:03 +00:00
|
|
|
* @param string $localPath File directory exposed at $remotePath
|
|
|
|
|
* @param string $file Path to target file relative to $localPath
|
|
|
|
|
* @return string URL
|
|
|
|
|
*/
|
2016-02-22 03:51:19 +00:00
|
|
|
public static function transformFilePath( $remotePathPrefix, $localPath, $file ) {
|
2016-01-22 22:58:03 +00:00
|
|
|
$hash = md5_file( "$localPath/$file" );
|
|
|
|
|
if ( $hash === false ) {
|
|
|
|
|
wfLogWarning( __METHOD__ . ": Failed to hash $localPath/$file" );
|
|
|
|
|
$hash = '';
|
|
|
|
|
}
|
2016-02-22 03:51:19 +00:00
|
|
|
return "$remotePathPrefix/$file?" . substr( $hash, 0, 5 );
|
2016-01-22 22:58:03 +00:00
|
|
|
}
|
|
|
|
|
|
2010-01-29 21:32:45 +00:00
|
|
|
/**
|
|
|
|
|
* Transform "media" attribute based on request parameters
|
|
|
|
|
*
|
2014-04-08 15:29:17 +00:00
|
|
|
* @param string $media Current value of the "media" attribute
|
|
|
|
|
* @return string Modified value of the "media" attribute, or null to skip
|
2013-01-14 03:26:15 +00:00
|
|
|
* this stylesheet
|
2010-01-29 21:32:45 +00:00
|
|
|
*/
|
2011-01-07 20:22:50 +00:00
|
|
|
public static function transformCssMedia( $media ) {
|
2013-05-11 19:05:43 +00:00
|
|
|
global $wgRequest;
|
2008-08-21 14:09:57 +00:00
|
|
|
|
2016-10-13 05:34:26 +00:00
|
|
|
// https://www.w3.org/TR/css3-mediaqueries/#syntax
|
2013-01-14 03:26:15 +00:00
|
|
|
$screenMediaQueryRegex = '/^(?:only\s+)?screen\b/i';
|
|
|
|
|
|
2008-08-21 14:09:57 +00:00
|
|
|
// Switch in on-screen display for media testing
|
2016-02-17 09:09:32 +00:00
|
|
|
$switches = [
|
2008-08-21 14:09:57 +00:00
|
|
|
'printable' => 'print',
|
|
|
|
|
'handheld' => 'handheld',
|
2016-02-17 09:09:32 +00:00
|
|
|
];
|
2013-04-17 14:52:47 +00:00
|
|
|
foreach ( $switches as $switch => $targetMedia ) {
|
|
|
|
|
if ( $wgRequest->getBool( $switch ) ) {
|
|
|
|
|
if ( $media == $targetMedia ) {
|
2008-08-21 14:09:57 +00:00
|
|
|
$media = '';
|
2013-04-17 14:52:47 +00:00
|
|
|
} elseif ( preg_match( $screenMediaQueryRegex, $media ) === 1 ) {
|
2015-10-14 07:40:50 +00:00
|
|
|
/* This regex will not attempt to understand a comma-separated media_query_list
|
|
|
|
|
*
|
|
|
|
|
* Example supported values for $media:
|
|
|
|
|
* 'screen', 'only screen', 'screen and (min-width: 982px)' ),
|
|
|
|
|
* Example NOT supported value for $media:
|
|
|
|
|
* '3d-glasses, screen, print and resolution > 90dpi'
|
|
|
|
|
*
|
|
|
|
|
* If it's a print request, we never want any kind of screen stylesheets
|
|
|
|
|
* If it's a handheld request (currently the only other choice with a switch),
|
|
|
|
|
* we don't want simple 'screen' but we might want screen queries that
|
|
|
|
|
* have a max-width or something, so we'll pass all others on and let the
|
|
|
|
|
* client do the query.
|
|
|
|
|
*/
|
2013-04-17 14:52:47 +00:00
|
|
|
if ( $targetMedia == 'print' || $media == 'screen' ) {
|
2013-01-14 03:26:15 +00:00
|
|
|
return null;
|
|
|
|
|
}
|
2008-08-21 14:09:57 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return $media;
|
|
|
|
|
}
|
|
|
|
|
|
2008-02-18 07:25:35 +00:00
|
|
|
/**
|
|
|
|
|
* Add a wikitext-formatted message to the output.
|
|
|
|
|
* This is equivalent to:
|
|
|
|
|
*
|
2012-07-24 01:04:15 +00:00
|
|
|
* $wgOut->addWikiText( wfMessage( ... )->plain() )
|
2008-02-18 07:25:35 +00:00
|
|
|
*/
|
|
|
|
|
public function addWikiMsg( /*...*/ ) {
|
|
|
|
|
$args = func_get_args();
|
|
|
|
|
$name = array_shift( $args );
|
|
|
|
|
$this->addWikiMsgArray( $name, $args );
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Add a wikitext-formatted message to the output.
|
|
|
|
|
* Like addWikiMsg() except the parameters are taken as an array
|
|
|
|
|
* instead of a variable argument list.
|
|
|
|
|
*
|
2014-04-10 18:50:10 +00:00
|
|
|
* @param string $name
|
|
|
|
|
* @param array $args
|
2008-02-18 07:25:35 +00:00
|
|
|
*/
|
2011-10-23 08:13:52 +00:00
|
|
|
public function addWikiMsgArray( $name, $args ) {
|
2012-03-08 20:06:49 +00:00
|
|
|
$this->addHTML( $this->msg( $name, $args )->parseAsBlock() );
|
2008-02-18 07:25:35 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
2008-04-14 07:45:50 +00:00
|
|
|
* This function takes a number of message/argument specifications, wraps them in
|
2008-02-18 07:25:35 +00:00
|
|
|
* some overall structure, and then parses the result and adds it to the output.
|
|
|
|
|
*
|
2015-01-08 17:09:09 +00:00
|
|
|
* In the $wrap, $1 is replaced with the first message, $2 with the second,
|
|
|
|
|
* and so on. The subsequent arguments may be either
|
|
|
|
|
* 1) strings, in which case they are message names, or
|
|
|
|
|
* 2) arrays, in which case, within each array, the first element is the message
|
|
|
|
|
* name, and subsequent elements are the parameters to that message.
|
2008-02-18 07:25:35 +00:00
|
|
|
*
|
2015-01-08 17:09:09 +00:00
|
|
|
* Don't use this for messages that are not in the user's interface language.
|
2008-04-18 06:31:37 +00:00
|
|
|
*
|
2008-02-18 07:25:35 +00:00
|
|
|
* For example:
|
|
|
|
|
*
|
2010-05-28 21:22:45 +00:00
|
|
|
* $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>", 'some-error' );
|
2008-04-14 07:45:50 +00:00
|
|
|
*
|
2008-02-18 07:25:35 +00:00
|
|
|
* Is equivalent to:
|
|
|
|
|
*
|
2014-05-11 01:54:15 +00:00
|
|
|
* $wgOut->addWikiText( "<div class='error'>\n"
|
|
|
|
|
* . wfMessage( 'some-error' )->plain() . "\n</div>" );
|
2010-01-14 17:14:49 +00:00
|
|
|
*
|
2017-02-20 22:44:19 +00:00
|
|
|
* The newline after the opening div is needed in some wikitext. See T21226.
|
2011-05-21 19:07:24 +00:00
|
|
|
*
|
2014-04-10 18:50:10 +00:00
|
|
|
* @param string $wrap
|
2008-02-18 07:25:35 +00:00
|
|
|
*/
|
|
|
|
|
public function wrapWikiMsg( $wrap /*, ...*/ ) {
|
|
|
|
|
$msgSpecs = func_get_args();
|
|
|
|
|
array_shift( $msgSpecs );
|
|
|
|
|
$msgSpecs = array_values( $msgSpecs );
|
|
|
|
|
$s = $wrap;
|
|
|
|
|
foreach ( $msgSpecs as $n => $spec ) {
|
|
|
|
|
if ( is_array( $spec ) ) {
|
|
|
|
|
$args = $spec;
|
|
|
|
|
$name = array_shift( $args );
|
|
|
|
|
if ( isset( $args['options'] ) ) {
|
|
|
|
|
unset( $args['options'] );
|
2012-09-03 10:18:23 +00:00
|
|
|
wfDeprecated(
|
|
|
|
|
'Adding "options" to ' . __METHOD__ . ' is no longer supported',
|
|
|
|
|
'1.20'
|
|
|
|
|
);
|
2008-02-18 07:25:35 +00:00
|
|
|
}
|
2013-02-03 20:05:24 +00:00
|
|
|
} else {
|
2016-02-17 09:09:32 +00:00
|
|
|
$args = [];
|
2008-02-18 07:25:35 +00:00
|
|
|
$name = $spec;
|
|
|
|
|
}
|
2012-09-03 19:38:59 +00:00
|
|
|
$s = str_replace( '$' . ( $n + 1 ), $this->msg( $name, $args )->plain(), $s );
|
2008-02-18 07:25:35 +00:00
|
|
|
}
|
2011-09-11 21:07:17 +00:00
|
|
|
$this->addWikiText( $s );
|
2008-02-18 07:25:35 +00:00
|
|
|
}
|
2010-01-23 20:11:42 +00:00
|
|
|
|
2013-08-22 22:22:03 +00:00
|
|
|
/**
|
2017-05-20 13:39:40 +00:00
|
|
|
* Whether the output has a table of contents
|
2013-08-22 22:22:03 +00:00
|
|
|
* @return bool
|
|
|
|
|
* @since 1.22
|
|
|
|
|
*/
|
|
|
|
|
public function isTOCEnabled() {
|
|
|
|
|
return $this->mEnableTOC;
|
|
|
|
|
}
|
2014-03-11 20:00:02 +00:00
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Enables/disables section edit links, doesn't override __NOEDITSECTION__
|
|
|
|
|
* @param bool $flag
|
|
|
|
|
* @since 1.23
|
|
|
|
|
*/
|
|
|
|
|
public function enableSectionEditLinks( $flag = true ) {
|
|
|
|
|
$this->mEnableSectionEditLinks = $flag;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @return bool
|
|
|
|
|
* @since 1.23
|
|
|
|
|
*/
|
|
|
|
|
public function sectionEditLinksEnabled() {
|
|
|
|
|
return $this->mEnableSectionEditLinks;
|
|
|
|
|
}
|
2015-01-05 20:18:57 +00:00
|
|
|
|
|
|
|
|
/**
|
2015-07-25 15:32:08 +00:00
|
|
|
* Helper function to setup the PHP implementation of OOUI to use in this request.
|
2015-01-05 20:18:57 +00:00
|
|
|
*
|
2015-07-25 15:32:08 +00:00
|
|
|
* @since 1.26
|
|
|
|
|
* @param String $skinName The Skin name to determine the correct OOUI theme
|
|
|
|
|
* @param String $dir Language direction
|
2015-01-05 20:18:57 +00:00
|
|
|
*/
|
2017-03-17 01:32:59 +00:00
|
|
|
public static function setupOOUI( $skinName = 'default', $dir = 'ltr' ) {
|
|
|
|
|
$themes = ResourceLoaderOOUIModule::getSkinThemeMap();
|
|
|
|
|
$theme = isset( $themes[$skinName] ) ? $themes[$skinName] : $themes['default'];
|
|
|
|
|
// For example, 'OOUI\WikimediaUITheme'.
|
2015-07-23 16:37:53 +00:00
|
|
|
$themeClass = "OOUI\\{$theme}Theme";
|
|
|
|
|
OOUI\Theme::setSingleton( new $themeClass() );
|
2015-07-25 15:32:08 +00:00
|
|
|
OOUI\Element::setDefaultDir( $dir );
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Add ResourceLoader module styles for OOUI and set up the PHP implementation of it for use with
|
|
|
|
|
* MediaWiki and this OutputPage instance.
|
|
|
|
|
*
|
|
|
|
|
* @since 1.25
|
|
|
|
|
*/
|
|
|
|
|
public function enableOOUI() {
|
|
|
|
|
self::setupOOUI(
|
|
|
|
|
strtolower( $this->getSkin()->getSkinName() ),
|
|
|
|
|
$this->getLanguage()->getDir()
|
|
|
|
|
);
|
2016-02-17 09:09:32 +00:00
|
|
|
$this->addModuleStyles( [
|
2016-02-01 22:28:13 +00:00
|
|
|
'oojs-ui-core.styles',
|
2015-04-07 16:02:46 +00:00
|
|
|
'oojs-ui.styles.indicators',
|
|
|
|
|
'oojs-ui.styles.textures',
|
2015-07-14 20:30:06 +00:00
|
|
|
'mediawiki.widgets.styles',
|
2017-06-03 12:15:04 +00:00
|
|
|
'oojs-ui.styles.icons-content',
|
|
|
|
|
'oojs-ui.styles.icons-alerts',
|
|
|
|
|
'oojs-ui.styles.icons-interactions',
|
2016-02-17 09:09:32 +00:00
|
|
|
] );
|
2015-01-05 20:18:57 +00:00
|
|
|
}
|
2015-06-01 16:58:42 +00:00
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Add Link headers for preloading the wiki's logo.
|
|
|
|
|
*
|
2017-04-12 15:25:28 +00:00
|
|
|
* @since 1.26
|
2015-06-01 16:58:42 +00:00
|
|
|
*/
|
|
|
|
|
protected function addLogoPreloadLinkHeaders() {
|
2017-04-12 20:43:57 +00:00
|
|
|
$logo = ResourceLoaderSkinModule::getLogo( $this->getConfig() );
|
2015-06-01 16:58:42 +00:00
|
|
|
|
|
|
|
|
$tags = [];
|
|
|
|
|
$logosPerDppx = [];
|
|
|
|
|
$logos = [];
|
|
|
|
|
|
2017-04-12 20:43:57 +00:00
|
|
|
if ( !is_array( $logo ) ) {
|
2015-06-01 16:58:42 +00:00
|
|
|
// No media queries required if we only have one variant
|
|
|
|
|
$this->addLinkHeader( '<' . $logo . '>;rel=preload;as=image' );
|
|
|
|
|
return;
|
|
|
|
|
}
|
|
|
|
|
|
2017-04-12 20:43:57 +00:00
|
|
|
foreach ( $logo as $dppx => $src ) {
|
|
|
|
|
// Keys are in this format: "1.5x"
|
|
|
|
|
$dppx = substr( $dppx, 0, -1 );
|
|
|
|
|
$logosPerDppx[$dppx] = $src;
|
2015-06-01 16:58:42 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Because PHP can't have floats as array keys
|
|
|
|
|
uksort( $logosPerDppx, function ( $a , $b ) {
|
|
|
|
|
$a = floatval( $a );
|
|
|
|
|
$b = floatval( $b );
|
|
|
|
|
|
|
|
|
|
if ( $a == $b ) {
|
|
|
|
|
return 0;
|
|
|
|
|
}
|
|
|
|
|
// Sort from smallest to largest (e.g. 1x, 1.5x, 2x)
|
|
|
|
|
return ( $a < $b ) ? -1 : 1;
|
|
|
|
|
} );
|
|
|
|
|
|
|
|
|
|
foreach ( $logosPerDppx as $dppx => $src ) {
|
|
|
|
|
$logos[] = [ 'dppx' => $dppx, 'src' => $src ];
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
$logosCount = count( $logos );
|
|
|
|
|
// Logic must match ResourceLoaderSkinModule:
|
|
|
|
|
// - 1x applies to resolution < 1.5dppx
|
|
|
|
|
// - 1.5x applies to resolution >= 1.5dppx && < 2dppx
|
|
|
|
|
// - 2x applies to resolution >= 2dppx
|
|
|
|
|
// Note that min-resolution and max-resolution are both inclusive.
|
|
|
|
|
for ( $i = 0; $i < $logosCount; $i++ ) {
|
|
|
|
|
if ( $i === 0 ) {
|
|
|
|
|
// Smallest dppx
|
|
|
|
|
// min-resolution is ">=" (larger than or equal to)
|
|
|
|
|
// "not min-resolution" is essentially "<"
|
|
|
|
|
$media_query = 'not all and (min-resolution: ' . $logos[ 1 ]['dppx'] . 'dppx)';
|
|
|
|
|
} elseif ( $i !== $logosCount - 1 ) {
|
|
|
|
|
// In between
|
|
|
|
|
// Media query expressions can only apply "not" to the entire expression
|
|
|
|
|
// (e.g. can't express ">= 1.5 and not >= 2).
|
|
|
|
|
// Workaround: Use <= 1.9999 in place of < 2.
|
|
|
|
|
$upper_bound = floatval( $logos[ $i + 1 ]['dppx'] ) - 0.000001;
|
2017-04-12 15:25:28 +00:00
|
|
|
$media_query = '(min-resolution: ' . $logos[ $i ]['dppx'] .
|
2015-06-01 16:58:42 +00:00
|
|
|
'dppx) and (max-resolution: ' . $upper_bound . 'dppx)';
|
|
|
|
|
} else {
|
|
|
|
|
// Largest dppx
|
|
|
|
|
$media_query = '(min-resolution: ' . $logos[ $i ]['dppx'] . 'dppx)';
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
$this->addLinkHeader(
|
|
|
|
|
'<' . $logos[$i]['src'] . '>;rel=preload;as=image;media=' . $media_query
|
|
|
|
|
);
|
|
|
|
|
}
|
|
|
|
|
}
|
2007-08-16 07:05:38 +00:00
|
|
|
}
|
