wikimedia/mediawiki-extensions-Cite
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/Cite synced 2024-11-14 10:34:53 +00:00
Code Issues Packages Projects Releases Wiki Activity
mediawiki-extensions-Cite/includes/CiteHooks.php

313 lines
11 KiB
PHP
Raw Normal View History

VisualEditor: Move code for Cite into this repo This code has been developed over three years now in the repo of MediaWiki's integration of VisualEditor. It has grown and developed significantly during that time, but now is pretty stable. A number of hacks inside the MediaWiki- VisualEditor code base have been used to prevent this code from being loaded on wikis where the Cite extension is not deployed, but this state of affairs is and always was meant to be temporary. This code is under the MIT licence which is a tad messy, but not impossible. It's clearly labelled as such. The list of authors has been updated to take into account the influx of new functionality. Bug: T41621 Bug: T104928 Change-Id: I39936ed83d5a60471a0a75da753f498e80aef234
2016-02-03 21:03:41 +00:00
<?php
/**
doc: Bump copyright year Also make the overly-terse statement clearer. Change-Id: I752bb82444bf7cb41480076bace42331dc35a598
2018-01-03 01:05:45 +00:00
* @copyright 2011-2018 VisualEditor Team's Cite sub-team and others; see AUTHORS.txt
Use standard form for @license tags See https://spdx.org/licenses/ Change-Id: Ic091ebc3844abcd6de90b3241382fb4732200a6d
2017-12-29 12:12:35 +00:00
* @license MIT
VisualEditor: Move code for Cite into this repo This code has been developed over three years now in the repo of MediaWiki's integration of VisualEditor. It has grown and developed significantly during that time, but now is pretty stable. A number of hacks inside the MediaWiki- VisualEditor code base have been used to prevent this code from being loaded on wikis where the Cite extension is not deployed, but this state of affairs is and always was meant to be temporary. This code is under the MIT licence which is a tad messy, but not impossible. It's clearly labelled as such. The list of authors has been updated to take into account the influx of new functionality. Bug: T41621 Bug: T104928 Change-Id: I39936ed83d5a60471a0a75da753f498e80aef234
2016-02-03 21:03:41 +00:00
*/
Add phan configuration for static analysis Bug: T179554 Change-Id: I2bfd52c08aac1aa8f34e0664e6314835f79a0324
2017-12-25 13:17:20 +00:00
use MediaWiki\MediaWikiServices;
VisualEditor: Move code for Cite into this repo This code has been developed over three years now in the repo of MediaWiki's integration of VisualEditor. It has grown and developed significantly during that time, but now is pretty stable. A number of hacks inside the MediaWiki- VisualEditor code base have been used to prevent this code from being loaded on wikis where the Cite extension is not deployed, but this state of affairs is and always was meant to be temporary. This code is under the MIT licence which is a tad messy, but not impossible. It's clearly labelled as such. The list of authors has been updated to take into account the influx of new functionality. Bug: T41621 Bug: T104928 Change-Id: I39936ed83d5a60471a0a75da753f498e80aef234
2016-02-03 21:03:41 +00:00
class CiteHooks {
Remove some obscure comments A good bunch of these comments literally repeats what the code already says. Change-Id: I9c128f748971bf20a61a85ed57d3261d27c465f0
2017-12-28 14:55:49 +00:00
VisualEditor: Move code for Cite into this repo This code has been developed over three years now in the repo of MediaWiki's integration of VisualEditor. It has grown and developed significantly during that time, but now is pretty stable. A number of hacks inside the MediaWiki- VisualEditor code base have been used to prevent this code from being loaded on wikis where the Cite extension is not deployed, but this state of affairs is and always was meant to be temporary. This code is under the MIT licence which is a tad messy, but not impossible. It's clearly labelled as such. The list of authors has been updated to take into account the influx of new functionality. Bug: T41621 Bug: T104928 Change-Id: I39936ed83d5a60471a0a75da753f498e80aef234
2016-02-03 21:03:41 +00:00
/**
* Convert the content model of a message that is actually JSON to JSON. This
* only affects validation and UI when saving and editing, not loading the
* content.
*
* @param Title $title
Improve some parameter docs Change-Id: I7d50eaabfba309a62d1dbd16ded0cbcab3beb82f
2017-10-06 19:22:30 +00:00
* @param string &$model
VisualEditor: Move code for Cite into this repo This code has been developed over three years now in the repo of MediaWiki's integration of VisualEditor. It has grown and developed significantly during that time, but now is pretty stable. A number of hacks inside the MediaWiki- VisualEditor code base have been used to prevent this code from being loaded on wikis where the Cite extension is not deployed, but this state of affairs is and always was meant to be temporary. This code is under the MIT licence which is a tad messy, but not impossible. It's clearly labelled as such. The list of authors has been updated to take into account the influx of new functionality. Bug: T41621 Bug: T104928 Change-Id: I39936ed83d5a60471a0a75da753f498e80aef234
2016-02-03 21:03:41 +00:00
*/
public static function onContentHandlerDefaultModelFor( Title $title, &$model ) {
if (
$title->inNamespace( NS_MEDIAWIKI ) &&
Follow-up I454380c3: Update/fix some things I missed Per Krinkle's comment Change-Id: I527a694116939d0303a06556eb479201852e227d
2016-06-28 22:01:20 +00:00
(
$title->getText() == 'Visualeditor-cite-tool-definition.json' ||
$title->getText() == 'Cite-tool-definition.json'
)
VisualEditor: Move code for Cite into this repo This code has been developed over three years now in the repo of MediaWiki's integration of VisualEditor. It has grown and developed significantly during that time, but now is pretty stable. A number of hacks inside the MediaWiki- VisualEditor code base have been used to prevent this code from being loaded on wikis where the Cite extension is not deployed, but this state of affairs is and always was meant to be temporary. This code is under the MIT licence which is a tad messy, but not impossible. It's clearly labelled as such. The list of authors has been updated to take into account the influx of new functionality. Bug: T41621 Bug: T104928 Change-Id: I39936ed83d5a60471a0a75da753f498e80aef234
2016-02-03 21:03:41 +00:00
) {
$model = CONTENT_MODEL_JSON;
}
}
VisualEditor: Bring in unit tests from VE Change-Id: I7da5f25f61d0c7f2331ab927c35d8f6a975041b8
2016-02-05 20:54:55 +00:00
/**
* Conditionally register the unit testing module for the ext.cite.visualEditor module
* only if that module is loaded
*
Improve some parameter docs Change-Id: I7d50eaabfba309a62d1dbd16ded0cbcab3beb82f
2017-10-06 19:22:30 +00:00
* @param array &$testModules The array of registered test modules
Don't expect objects by reference in hook handlers The motivation for this patch is to make the code less complex, better readable, and less brittle. Example: public function onExampleHook( Parser &$parser, array &$result ) { /* This is the hook handler */ } In this example the $result array is meant to be manipulated by the hook handler. Changes should become visible to the caller. Since PHP passes arrays by value, the & is needed to make this possible. But the & is misplaced in pretty much all cases where the parameter is an object. The only reason we still see these & in many hook handlers is historical: PHP 4 passed objects by value, which potentially caused expensive cloning. This was prevented with the &. Since PHP 5 objects are passed by reference. However, this did not made the & entirely meaningless. Keeping the & means callees are allowed to replace passed objects with new ones. The & makes it look like a function might intentionally replace a passed object, which is unintended and actually scary in cases like the Parser. Luckily all Hooks::run I have seen so far ignore unintended out-values. So even if a hook handler tries to do something bad like replacing the Parser with a different one, this would not have an effect. Removing the & does not remove the possibility to manipulate the object. Changes done to public properties are still visible to the caller. Unfortunately these & cannot be removed from the callers as long as there is a single callee expecting a reference. This patch reduces the number of such problematic callees. Change-Id: Ib3a9da257b50326d569ab1973b523c952963c16b
2018-05-15 14:45:26 +00:00
* @param ResourceLoader $resourceLoader
VisualEditor: Bring in unit tests from VE Change-Id: I7da5f25f61d0c7f2331ab927c35d8f6a975041b8
2016-02-05 20:54:55 +00:00
*/
public static function onResourceLoaderTestModules(
array &$testModules,
Don't expect objects by reference in hook handlers The motivation for this patch is to make the code less complex, better readable, and less brittle. Example: public function onExampleHook( Parser &$parser, array &$result ) { /* This is the hook handler */ } In this example the $result array is meant to be manipulated by the hook handler. Changes should become visible to the caller. Since PHP passes arrays by value, the & is needed to make this possible. But the & is misplaced in pretty much all cases where the parameter is an object. The only reason we still see these & in many hook handlers is historical: PHP 4 passed objects by value, which potentially caused expensive cloning. This was prevented with the &. Since PHP 5 objects are passed by reference. However, this did not made the & entirely meaningless. Keeping the & means callees are allowed to replace passed objects with new ones. The & makes it look like a function might intentionally replace a passed object, which is unintended and actually scary in cases like the Parser. Luckily all Hooks::run I have seen so far ignore unintended out-values. So even if a hook handler tries to do something bad like replacing the Parser with a different one, this would not have an effect. Removing the & does not remove the possibility to manipulate the object. Changes done to public properties are still visible to the caller. Unfortunately these & cannot be removed from the callers as long as there is a single callee expecting a reference. This patch reduces the number of such problematic callees. Change-Id: Ib3a9da257b50326d569ab1973b523c952963c16b
2018-05-15 14:45:26 +00:00
ResourceLoader $resourceLoader
VisualEditor: Bring in unit tests from VE Change-Id: I7da5f25f61d0c7f2331ab927c35d8f6a975041b8
2016-02-05 20:54:55 +00:00
) {
$resourceModules = $resourceLoader->getConfig()->get( 'ResourceModules' );
if (
Check VE is available before running unit tests Bug: T127763 Change-Id: I2ad8814d39b16ce5918d9f53ba9bf4bf59a0cbe9
2016-03-01 12:21:00 +00:00
isset( $resourceModules[ 'ext.visualEditor.mediawiki' ] ) ||
$resourceLoader->isModuleRegistered( 'ext.visualEditor.mediawiki' )
VisualEditor: Bring in unit tests from VE Change-Id: I7da5f25f61d0c7f2331ab927c35d8f6a975041b8
2016-02-05 20:54:55 +00:00
) {
build: Updating mediawiki/mediawiki-codesniffer to 0.7.1 Also added "composer fix" command. Change-Id: I3cdaa7aac81fc3f9b3e284b049a2dd07b1abf0f3
2016-05-09 23:36:49 +00:00
$testModules['qunit']['ext.cite.visualEditor.test'] = [
'scripts' => [
Followup Ic6afacbf2a: Fix test file paths The current path for the test files was wrong and broke qunit test running in debug mode. This fix corrects the path for both debug and non debug mode. Change-Id: I0e2f3296daff1aff5d417a9e8f8ae7eadfe78982
2016-09-20 20:54:52 +00:00
'modules/ve-cite/tests/ve.dm.citeExample.js',
'modules/ve-cite/tests/ve.dm.Converter.test.js',
'modules/ve-cite/tests/ve.dm.InternalList.test.js',
'modules/ve-cite/tests/ve.dm.Transaction.test.js',
Create first unit test for reference diffs Depends-On: Ia34b535c34aeed933164a18a0be76d7c0ac28bc6 Depends-On: Ic70bd3e8ba090c2d174164fd1ecebdf6f2225254 Change-Id: Ib8b485663dea6fcc50c0197451d0a553e5d89c27
2018-02-12 17:57:00 +00:00
'modules/ve-cite/tests/ve.ui.DiffElement.test.js',
Bring in wikitext paste tests from ve-mw Depends-On: Ibea6994a208e4b0b1022896eb31dd2f36f0fd6c6 Change-Id: I244570c39e2f3595137c02e62cb91ba8eeab8a4a
2017-04-20 16:11:00 +00:00
'modules/ve-cite/tests/ve.ui.MWWikitextStringTransferHandler.test.js',
build: Updating mediawiki/mediawiki-codesniffer to 0.7.1 Also added "composer fix" command. Change-Id: I3cdaa7aac81fc3f9b3e284b049a2dd07b1abf0f3
2016-05-09 23:36:49 +00:00
],
'dependencies' => [
VisualEditor: Bring in unit tests from VE Change-Id: I7da5f25f61d0c7f2331ab927c35d8f6a975041b8
2016-02-05 20:54:55 +00:00
'ext.cite.visualEditor',
Tests: Depend on newly-renamed VE test suite Depends-On: If6e0450ec73051d9b1d9111aed808fee26b45705 Change-Id: I5a9a6162144dd7cdd34cd771a62477a9a1b6886d
2019-01-23 21:21:40 +00:00
'test.VisualEditor'
build: Updating mediawiki/mediawiki-codesniffer to 0.7.1 Also added "composer fix" command. Change-Id: I3cdaa7aac81fc3f9b3e284b049a2dd07b1abf0f3
2016-05-09 23:36:49 +00:00
],
Followup Ic6afacbf2a: Fix test file paths The current path for the test files was wrong and broke qunit test running in debug mode. This fix corrects the path for both debug and non debug mode. Change-Id: I0e2f3296daff1aff5d417a9e8f8ae7eadfe78982
2016-09-20 20:54:52 +00:00
'localBasePath' => dirname( __DIR__ ),
VisualEditor: Bring in unit tests from VE Change-Id: I7da5f25f61d0c7f2331ab927c35d8f6a975041b8
2016-02-05 20:54:55 +00:00
'remoteExtPath' => 'Cite',
build: Updating mediawiki/mediawiki-codesniffer to 0.7.1 Also added "composer fix" command. Change-Id: I3cdaa7aac81fc3f9b3e284b049a2dd07b1abf0f3
2016-05-09 23:36:49 +00:00
];
VisualEditor: Bring in unit tests from VE Change-Id: I7da5f25f61d0c7f2331ab927c35d8f6a975041b8
2016-02-05 20:54:55 +00:00
}
}
Store references in page_props and cache This stores references in page_props during links update in compressed JSON form. If the size is too big, it's broken up in several parts to fit, which is very unlikely to occur more than once. When the data is retrieved from the db, it's always cached. If set in config, it's also saved in the cache on parse. If not, the cache is invalidated when references are modified. Uses cases include : section preview to also show refs defined elsewhere on the page (T124840) and MobileFrontend (T123328). For the later, this still needs API support (T123290). There's a soft dependency on the core change I0c73b3d181f32502da75687857ae9aeff731f559. Bug: T125329 Change-Id: I7b106254b8f264f93b0f0c9cfa89f65adeeea4f0
2016-01-25 16:52:46 +00:00
Skip registering RL modules depending on VisualEditor When VisualEditor is not installed, there is no point in registered resource loader modules that depends on it. A use case is trying to run tests for the MediaWiki tarball. It comes with Cite but without VisualEditor. The patch is based on GuidedTour patch by Matthew Flaschen https://gerrit.wikimedia.org/r/#/c/305691/ for T143297 Change-Id: Idf769e0149f93c099a94b1b7a6cb203273dab881
2016-10-14 21:40:54 +00:00
/**
Baseline reference interaction tracking Collect EventLogging metrics for footnote and reference link interactions, so that we can compare behavior with and without Reference Previews enabled. This tracking will be reverted once analysis is complete. A mostly arbitrary sample rate of 1/1000 is hardcoded here. This is loosely based on the latest tuning of Popups sampling at 1/100, divided by a conservative factor of 10 to ensure headroom. The sample is skewed by skipping clients without sendBeacon support, but we're avoiding the mw.track synchronous fallback, which injects an image tag and introduces lag any time the user clicks external links in the references. Bug: T231529 Change-Id: Iad32b64114f88675eecbb01712418c968e3cf661
2019-09-20 13:03:16 +00:00
* Conditionally register resource loader modules that depend on
* other MediaWiki extensions.
Skip registering RL modules depending on VisualEditor When VisualEditor is not installed, there is no point in registered resource loader modules that depends on it. A use case is trying to run tests for the MediaWiki tarball. It comes with Cite but without VisualEditor. The patch is based on GuidedTour patch by Matthew Flaschen https://gerrit.wikimedia.org/r/#/c/305691/ for T143297 Change-Id: Idf769e0149f93c099a94b1b7a6cb203273dab881
2016-10-14 21:40:54 +00:00
*
Don't expect objects by reference in hook handlers The motivation for this patch is to make the code less complex, better readable, and less brittle. Example: public function onExampleHook( Parser &$parser, array &$result ) { /* This is the hook handler */ } In this example the $result array is meant to be manipulated by the hook handler. Changes should become visible to the caller. Since PHP passes arrays by value, the & is needed to make this possible. But the & is misplaced in pretty much all cases where the parameter is an object. The only reason we still see these & in many hook handlers is historical: PHP 4 passed objects by value, which potentially caused expensive cloning. This was prevented with the &. Since PHP 5 objects are passed by reference. However, this did not made the & entirely meaningless. Keeping the & means callees are allowed to replace passed objects with new ones. The & makes it look like a function might intentionally replace a passed object, which is unintended and actually scary in cases like the Parser. Luckily all Hooks::run I have seen so far ignore unintended out-values. So even if a hook handler tries to do something bad like replacing the Parser with a different one, this would not have an effect. Removing the & does not remove the possibility to manipulate the object. Changes done to public properties are still visible to the caller. Unfortunately these & cannot be removed from the callers as long as there is a single callee expecting a reference. This patch reduces the number of such problematic callees. Change-Id: Ib3a9da257b50326d569ab1973b523c952963c16b
2018-05-15 14:45:26 +00:00
* @param ResourceLoader $resourceLoader
Skip registering RL modules depending on VisualEditor When VisualEditor is not installed, there is no point in registered resource loader modules that depends on it. A use case is trying to run tests for the MediaWiki tarball. It comes with Cite but without VisualEditor. The patch is based on GuidedTour patch by Matthew Flaschen https://gerrit.wikimedia.org/r/#/c/305691/ for T143297 Change-Id: Idf769e0149f93c099a94b1b7a6cb203273dab881
2016-10-14 21:40:54 +00:00
*/
Don't expect objects by reference in hook handlers The motivation for this patch is to make the code less complex, better readable, and less brittle. Example: public function onExampleHook( Parser &$parser, array &$result ) { /* This is the hook handler */ } In this example the $result array is meant to be manipulated by the hook handler. Changes should become visible to the caller. Since PHP passes arrays by value, the & is needed to make this possible. But the & is misplaced in pretty much all cases where the parameter is an object. The only reason we still see these & in many hook handlers is historical: PHP 4 passed objects by value, which potentially caused expensive cloning. This was prevented with the &. Since PHP 5 objects are passed by reference. However, this did not made the & entirely meaningless. Keeping the & means callees are allowed to replace passed objects with new ones. The & makes it look like a function might intentionally replace a passed object, which is unintended and actually scary in cases like the Parser. Luckily all Hooks::run I have seen so far ignore unintended out-values. So even if a hook handler tries to do something bad like replacing the Parser with a different one, this would not have an effect. Removing the & does not remove the possibility to manipulate the object. Changes done to public properties are still visible to the caller. Unfortunately these & cannot be removed from the callers as long as there is a single callee expecting a reference. This patch reduces the number of such problematic callees. Change-Id: Ib3a9da257b50326d569ab1973b523c952963c16b
2018-05-15 14:45:26 +00:00
public static function onResourceLoaderRegisterModules( ResourceLoader $resourceLoader ) {
Baseline reference interaction tracking Collect EventLogging metrics for footnote and reference link interactions, so that we can compare behavior with and without Reference Previews enabled. This tracking will be reverted once analysis is complete. A mostly arbitrary sample rate of 1/1000 is hardcoded here. This is loosely based on the latest tuning of Popups sampling at 1/100, divided by a conservative factor of 10 to ensure headroom. The sample is skewed by skipping clients without sendBeacon support, but we're avoiding the mw.track synchronous fallback, which injects an image tag and introduces lag any time the user clicks external links in the references. Bug: T231529 Change-Id: Iad32b64114f88675eecbb01712418c968e3cf661
2019-09-20 13:03:16 +00:00
$dir = dirname( __DIR__ ) . DIRECTORY_SEPARATOR;
Bundle tracking with another RL module This is slightly more efficient because it saves on early page- load bandwidth. Bug: T234605 Change-Id: If83420a9b4e654fd790e810fa82f922a8ba06e50
2019-10-07 08:34:31 +00:00
$uxEnhancementsModule = [
'localBasePath' => $dir . 'modules',
'remoteExtPath' => 'Cite/modules',
'scripts' => [
'ext.cite.a11y.js',
'ext.cite.highlighting.js',
],
'styles' => [
'ext.cite.a11y.css',
'ext.cite.highlighting.css',
],
'messages' => [
'cite_reference_link_prefix',
'cite_references_link_accessibility_label',
'cite_references_link_many_accessibility_label',
'cite_references_link_accessibility_back_label',
],
];
Baseline reference interaction tracking Collect EventLogging metrics for footnote and reference link interactions, so that we can compare behavior with and without Reference Previews enabled. This tracking will be reverted once analysis is complete. A mostly arbitrary sample rate of 1/1000 is hardcoded here. This is loosely based on the latest tuning of Popups sampling at 1/100, divided by a conservative factor of 10 to ensure headroom. The sample is skewed by skipping clients without sendBeacon support, but we're avoiding the mw.track synchronous fallback, which injects an image tag and introduces lag any time the user clicks external links in the references. Bug: T231529 Change-Id: Iad32b64114f88675eecbb01712418c968e3cf661
2019-09-20 13:03:16 +00:00
if ( ExtensionRegistry::getInstance()->isLoaded( 'EventLogging' ) ) {
Bundle tracking with another RL module This is slightly more efficient because it saves on early page- load bandwidth. Bug: T234605 Change-Id: If83420a9b4e654fd790e810fa82f922a8ba06e50
2019-10-07 08:34:31 +00:00
// Temporary tracking for T231529
$uxEnhancementsModule['scripts'][] = 'ext.cite.tracking.js';
$uxEnhancementsModule['dependencies'][] = 'ext.eventLogging';
Baseline reference interaction tracking Collect EventLogging metrics for footnote and reference link interactions, so that we can compare behavior with and without Reference Previews enabled. This tracking will be reverted once analysis is complete. A mostly arbitrary sample rate of 1/1000 is hardcoded here. This is loosely based on the latest tuning of Popups sampling at 1/100, divided by a conservative factor of 10 to ensure headroom. The sample is skewed by skipping clients without sendBeacon support, but we're avoiding the mw.track synchronous fallback, which injects an image tag and introduces lag any time the user clicks external links in the references. Bug: T231529 Change-Id: Iad32b64114f88675eecbb01712418c968e3cf661
2019-09-20 13:03:16 +00:00
}
Bundle tracking with another RL module This is slightly more efficient because it saves on early page- load bandwidth. Bug: T234605 Change-Id: If83420a9b4e654fd790e810fa82f922a8ba06e50
2019-10-07 08:34:31 +00:00
$resourceLoader->register( 'ext.cite.ux-enhancements', $uxEnhancementsModule );
Baseline reference interaction tracking Collect EventLogging metrics for footnote and reference link interactions, so that we can compare behavior with and without Reference Previews enabled. This tracking will be reverted once analysis is complete. A mostly arbitrary sample rate of 1/1000 is hardcoded here. This is loosely based on the latest tuning of Popups sampling at 1/100, divided by a conservative factor of 10 to ensure headroom. The sample is skewed by skipping clients without sendBeacon support, but we're avoiding the mw.track synchronous fallback, which injects an image tag and introduces lag any time the user clicks external links in the references. Bug: T231529 Change-Id: Iad32b64114f88675eecbb01712418c968e3cf661
2019-09-20 13:03:16 +00:00
Use ExtensionRegistry rather than class_exists Change-Id: I5c6a6ed3f6ecef1cde5519bcdac5ae35e7ab1a73
2019-03-03 00:47:00 +00:00
if ( !ExtensionRegistry::getInstance()->isLoaded( 'VisualEditor' ) ) {
Remove all default "return true" from all hook handlers This is the default for many years now. Returning true does nothing. It's identical to returning nothing (null). The only meaningful value a hook handler can return is false, and even this is meaningful only for very few hooks. TL;DR: A "return true" in a hook handler is always meaningless, dead code. I'm interested in this because we (WMDE) might start working on this extension soon and I want the code to be small and easy to maintain. Change-Id: If4f32a55cdc38a3cc8af286d1cca7c0089bbfc43
2018-05-15 08:40:58 +00:00
return;
Skip registering RL modules depending on VisualEditor When VisualEditor is not installed, there is no point in registered resource loader modules that depends on it. A use case is trying to run tests for the MediaWiki tarball. It comes with Cite but without VisualEditor. The patch is based on GuidedTour patch by Matthew Flaschen https://gerrit.wikimedia.org/r/#/c/305691/ for T143297 Change-Id: Idf769e0149f93c099a94b1b7a6cb203273dab881
2016-10-14 21:40:54 +00:00
}
$resourceLoader->register( "ext.cite.visualEditor.core", [
'localBasePath' => $dir . 'modules',
'remoteExtPath' => 'Cite/modules',
"scripts" => [
"ve-cite/ve.dm.MWReferenceModel.js",
"ve-cite/ve.dm.MWReferencesListNode.js",
"ve-cite/ve.dm.MWReferenceNode.js",
"ve-cite/ve.ce.MWReferencesListNode.js",
"ve-cite/ve.ce.MWReferenceNode.js",
"ve-cite/ve.ui.MWReferencesListCommand.js"
],
"styles" => [
"ve-cite/ve.ce.MWReferencesListNode.css",
"ve-cite/ve.ce.MWReferenceNode.css"
],
"dependencies" => [
"ext.visualEditor.mwcore"
],
"messages" => [
"cite-ve-referenceslist-isempty",
"cite-ve-referenceslist-isempty-default",
Visual diff: Show correct reference indices in diff Bug: T162819 Change-Id: I7eec4ee12a24ff99388cc0c95a24d50f321511f9
2017-06-12 14:03:00 +00:00
"cite-ve-referenceslist-missingref",
Add separate message for missing reference in references list Message indicates that a preview of the reference is missing, instead of implying that the user was trying to edit it. Bug: T188682 Change-Id: I5f5f8d5d0910ab2608696bbed380d4592cb6c7f1
2018-03-24 17:32:55 +00:00
"cite-ve-referenceslist-missingref-in-list",
Treat template-generated reference lists as real ones This will allow them to auto-update, and be used in the visual diff. We record a templateGenerated attribute to prevent them being edited, and to ensure they roundtrip back to templates. Bug: T52769 Change-Id: I4460d2c98166581e942e35921b20091990f5f6c7
2018-02-06 20:14:40 +00:00
"cite-ve-referenceslist-missingreflist",
Visual diff: Show correct reference indices in diff Bug: T162819 Change-Id: I7eec4ee12a24ff99388cc0c95a24d50f321511f9
2017-06-12 14:03:00 +00:00
"visualeditor-internal-list-diff-default-group-name-mwreference",
"visualeditor-internal-list-diff-group-name-mwreference"
Skip registering RL modules depending on VisualEditor When VisualEditor is not installed, there is no point in registered resource loader modules that depends on it. A use case is trying to run tests for the MediaWiki tarball. It comes with Cite but without VisualEditor. The patch is based on GuidedTour patch by Matthew Flaschen https://gerrit.wikimedia.org/r/#/c/305691/ for T143297 Change-Id: Idf769e0149f93c099a94b1b7a6cb203273dab881
2016-10-14 21:40:54 +00:00
],
"targets" => [
"desktop",
"mobile"
]
] );
$resourceLoader->register( "ext.cite.visualEditor.data",
[ "class" => "CiteDataModule" ] );
$resourceLoader->register( "ext.cite.visualEditor", [
'localBasePath' => $dir . 'modules',
'remoteExtPath' => 'Cite/modules',
"scripts" => [
"ve-cite/ve.ui.MWReferenceGroupInputWidget.js",
"ve-cite/ve.ui.MWReferenceSearchWidget.js",
"ve-cite/ve.ui.MWReferenceResultWidget.js",
"ve-cite/ve.ui.MWUseExistingReferenceCommand.js",
"ve-cite/ve.ui.MWCitationDialog.js",
"ve-cite/ve.ui.MWReferencesListDialog.js",
"ve-cite/ve.ui.MWReferenceDialog.js",
"ve-cite/ve.ui.MWReferenceDialogTool.js",
"ve-cite/ve.ui.MWCitationDialogTool.js",
"ve-cite/ve.ui.MWReferenceContextItem.js",
"ve-cite/ve.ui.MWReferencesListContextItem.js",
"ve-cite/ve.ui.MWCitationContextItem.js",
"ve-cite/ve.ui.MWCitationAction.js",
Citation needed template handling Bug: T211243 Depends-On: I82124b24cc9edbbfc41dedc72452cbb583051cf8 Depends-On: Icfc39e350452da238d0e0c17cb2305c60d9ca16a Change-Id: Ic443c1ae759a058673b71e47f09f2a7d219fc12e
2018-12-05 21:35:04 +00:00
"ve-cite/ve.ui.MWReference.init.js",
"ve-cite/ve.ui.MWCitationNeededContextItem.js",
Skip registering RL modules depending on VisualEditor When VisualEditor is not installed, there is no point in registered resource loader modules that depends on it. A use case is trying to run tests for the MediaWiki tarball. It comes with Cite but without VisualEditor. The patch is based on GuidedTour patch by Matthew Flaschen https://gerrit.wikimedia.org/r/#/c/305691/ for T143297 Change-Id: Idf769e0149f93c099a94b1b7a6cb203273dab881
2016-10-14 21:40:54 +00:00
],
"styles" => [
Improve warning that reference is reused * Show the warning in the context menu (on desktop only) in addition to the reference dialog. * Add more details to the warning in reference dialog, and adjust spacing around it to make it more noticeable. Bug: T208981 Bug: T212609 Depends-On: I6ca605ddd580d6259952c8799ecdca08da07474a Change-Id: I23cc02f651c15b3276613d32a0c2537032f731c2
2019-01-03 20:06:12 +00:00
"ve-cite/ve.ui.MWReferenceDialog.css",
Skip registering RL modules depending on VisualEditor When VisualEditor is not installed, there is no point in registered resource loader modules that depends on it. A use case is trying to run tests for the MediaWiki tarball. It comes with Cite but without VisualEditor. The patch is based on GuidedTour patch by Matthew Flaschen https://gerrit.wikimedia.org/r/#/c/305691/ for T143297 Change-Id: Idf769e0149f93c099a94b1b7a6cb203273dab881
2016-10-14 21:40:54 +00:00
"ve-cite/ve.ui.MWReferenceContextItem.css",
"ve-cite/ve.ui.MWReferenceGroupInputWidget.css",
"ve-cite/ve.ui.MWReferenceResultWidget.css",
"ve-cite/ve.ui.MWReferenceSearchWidget.css"
],
"dependencies" => [
Add appropriate OOjs UI icon pack dependencies modules/ve-cite/ve.ui.MWReferenceDialog.js * Add 'alerts' as it uses 'alert' * Add 'interactions' as it uses 'settings' Bug: T166730 Change-Id: I39d98c197220d463f18d473a9605e242ec9755a9
2017-06-03 10:45:02 +00:00
"oojs-ui.styles.icons-alerts",
VE: Make the OOUI citation icons available This allows on-wiki use to be migrated to the standard icons rather than in-repo ones, so that they can (later) be removed. Change-Id: I19bec075c77396f163977962bbe1afb69a231c1e
2018-08-14 18:55:44 +00:00
"oojs-ui.styles.icons-editing-citation",
Add appropriate OOjs UI icon pack dependencies modules/ve-cite/ve.ui.MWReferenceDialog.js * Add 'alerts' as it uses 'alert' * Add 'interactions' as it uses 'settings' Bug: T166730 Change-Id: I39d98c197220d463f18d473a9605e242ec9755a9
2017-06-03 10:45:02 +00:00
"oojs-ui.styles.icons-interactions",
Skip registering RL modules depending on VisualEditor When VisualEditor is not installed, there is no point in registered resource loader modules that depends on it. A use case is trying to run tests for the MediaWiki tarball. It comes with Cite but without VisualEditor. The patch is based on GuidedTour patch by Matthew Flaschen https://gerrit.wikimedia.org/r/#/c/305691/ for T143297 Change-Id: Idf769e0149f93c099a94b1b7a6cb203273dab881
2016-10-14 21:40:54 +00:00
"ext.cite.visualEditor.core",
"ext.cite.visualEditor.data",
"ext.cite.style",
VE: Support 'responsive' attribute Bug: T53260 Change-Id: I1e0ae39e8c30653b7ba0f537723a4bcd79ac3162
2017-09-19 15:35:27 +00:00
"ext.cite.styles",
Skip registering RL modules depending on VisualEditor When VisualEditor is not installed, there is no point in registered resource loader modules that depends on it. A use case is trying to run tests for the MediaWiki tarball. It comes with Cite but without VisualEditor. The patch is based on GuidedTour patch by Matthew Flaschen https://gerrit.wikimedia.org/r/#/c/305691/ for T143297 Change-Id: Idf769e0149f93c099a94b1b7a6cb203273dab881
2016-10-14 21:40:54 +00:00
"ext.visualEditor.mwtransclusion",
"ext.visualEditor.mediawiki"
],
"messages" => [
Describe group changes for references and references lists Bug: T160589 Change-Id: Ifccafdf08704f67027dae2703ff2ded809fb6ab7
2017-03-16 21:58:53 +00:00
"cite-ve-changedesc-ref-group-both",
"cite-ve-changedesc-ref-group-from",
"cite-ve-changedesc-ref-group-to",
"cite-ve-changedesc-reflist-group-both",
"cite-ve-changedesc-reflist-group-from",
"cite-ve-changedesc-reflist-group-to",
VisualDiff: Show less information about ref nodes If a ref node is highlighted as changed because its index has changed (e.g. because an earlier reference was inserted or removed), describe this more elegantly. Bug: T170235 Bug: T171377 Change-Id: I2513bb82099a92529516e4e217e61a2d0a2dd43b
2017-08-11 23:26:02 +00:00
"cite-ve-changedesc-reflist-item-id",
VisualEditor: Describe reflist responsiveness changes too Bug: T160589 Change-Id: Idb590bf0f3edbe8d056f544a148323da30211467
2018-02-23 00:01:44 +00:00
"cite-ve-changedesc-reflist-responsive-set",
"cite-ve-changedesc-reflist-responsive-unset",
Citation needed template handling Bug: T211243 Depends-On: I82124b24cc9edbbfc41dedc72452cbb583051cf8 Depends-On: Icfc39e350452da238d0e0c17cb2305c60d9ca16a Change-Id: Ic443c1ae759a058673b71e47f09f2a7d219fc12e
2018-12-05 21:35:04 +00:00
"cite-ve-citationneeded-button",
"cite-ve-citationneeded-description",
"cite-ve-citationneeded-title",
Skip registering RL modules depending on VisualEditor When VisualEditor is not installed, there is no point in registered resource loader modules that depends on it. A use case is trying to run tests for the MediaWiki tarball. It comes with Cite but without VisualEditor. The patch is based on GuidedTour patch by Matthew Flaschen https://gerrit.wikimedia.org/r/#/c/305691/ for T143297 Change-Id: Idf769e0149f93c099a94b1b7a6cb203273dab881
2016-10-14 21:40:54 +00:00
"cite-ve-dialog-reference-editing-reused",
Improve warning that reference is reused * Show the warning in the context menu (on desktop only) in addition to the reference dialog. * Add more details to the warning in reference dialog, and adjust spacing around it to make it more noticeable. Bug: T208981 Bug: T212609 Depends-On: I6ca605ddd580d6259952c8799ecdca08da07474a Change-Id: I23cc02f651c15b3276613d32a0c2537032f731c2
2019-01-03 20:06:12 +00:00
"cite-ve-dialog-reference-editing-reused-long",
Skip registering RL modules depending on VisualEditor When VisualEditor is not installed, there is no point in registered resource loader modules that depends on it. A use case is trying to run tests for the MediaWiki tarball. It comes with Cite but without VisualEditor. The patch is based on GuidedTour patch by Matthew Flaschen https://gerrit.wikimedia.org/r/#/c/305691/ for T143297 Change-Id: Idf769e0149f93c099a94b1b7a6cb203273dab881
2016-10-14 21:40:54 +00:00
"cite-ve-dialog-reference-options-group-label",
"cite-ve-dialog-reference-options-group-placeholder",
"cite-ve-dialog-reference-options-name-label",
VE: Support 'responsive' attribute Bug: T53260 Change-Id: I1e0ae39e8c30653b7ba0f537723a4bcd79ac3162
2017-09-19 15:35:27 +00:00
"cite-ve-dialog-reference-options-responsive-label",
Skip registering RL modules depending on VisualEditor When VisualEditor is not installed, there is no point in registered resource loader modules that depends on it. A use case is trying to run tests for the MediaWiki tarball. It comes with Cite but without VisualEditor. The patch is based on GuidedTour patch by Matthew Flaschen https://gerrit.wikimedia.org/r/#/c/305691/ for T143297 Change-Id: Idf769e0149f93c099a94b1b7a6cb203273dab881
2016-10-14 21:40:54 +00:00
"cite-ve-dialog-reference-options-section",
VisualEditor: Add a placeholder to MWReferenceDialog to make it less awful when empty Change-Id: I086d7243127ee411ea043bf29f4d4a5ae5d657a0
2017-05-24 16:12:54 +00:00
"cite-ve-dialog-reference-placeholder",
Skip registering RL modules depending on VisualEditor When VisualEditor is not installed, there is no point in registered resource loader modules that depends on it. A use case is trying to run tests for the MediaWiki tarball. It comes with Cite but without VisualEditor. The patch is based on GuidedTour patch by Matthew Flaschen https://gerrit.wikimedia.org/r/#/c/305691/ for T143297 Change-Id: Idf769e0149f93c099a94b1b7a6cb203273dab881
2016-10-14 21:40:54 +00:00
"cite-ve-dialog-reference-title",
"cite-ve-dialog-reference-useexisting-tool",
"cite-ve-dialog-referenceslist-contextitem-description-general",
"cite-ve-dialog-referenceslist-contextitem-description-named",
"cite-ve-dialog-referenceslist-title",
"cite-ve-dialogbutton-citation-educationpopup-title",
"cite-ve-dialogbutton-citation-educationpopup-text",
"cite-ve-dialogbutton-reference-full-label",
"cite-ve-dialogbutton-reference-tooltip",
"cite-ve-dialogbutton-reference-title",
"cite-ve-dialogbutton-referenceslist-tooltip",
"cite-ve-reference-input-placeholder",
"cite-ve-toolbar-group-label",
"cite-ve-othergroup-item"
],
"targets" => [
"desktop",
"mobile"
]
] );
}
Store references in page_props and cache This stores references in page_props during links update in compressed JSON form. If the size is too big, it's broken up in several parts to fit, which is very unlikely to occur more than once. When the data is retrieved from the db, it's always cached. If set in config, it's also saved in the cache on parse. If not, the cache is invalidated when references are modified. Uses cases include : section preview to also show refs defined elsewhere on the page (T124840) and MobileFrontend (T123328). For the later, this still needs API support (T123290). There's a soft dependency on the core change I0c73b3d181f32502da75687857ae9aeff731f559. Bug: T125329 Change-Id: I7b106254b8f264f93b0f0c9cfa89f65adeeea4f0
2016-01-25 16:52:46 +00:00
/**
* Callback for LinksUpdate hook
* Post-output processing of references property, for proper db storage
* Deferred to avoid performance overhead when outputting the page
*
Don't expect objects by reference in hook handlers The motivation for this patch is to make the code less complex, better readable, and less brittle. Example: public function onExampleHook( Parser &$parser, array &$result ) { /* This is the hook handler */ } In this example the $result array is meant to be manipulated by the hook handler. Changes should become visible to the caller. Since PHP passes arrays by value, the & is needed to make this possible. But the & is misplaced in pretty much all cases where the parameter is an object. The only reason we still see these & in many hook handlers is historical: PHP 4 passed objects by value, which potentially caused expensive cloning. This was prevented with the &. Since PHP 5 objects are passed by reference. However, this did not made the & entirely meaningless. Keeping the & means callees are allowed to replace passed objects with new ones. The & makes it look like a function might intentionally replace a passed object, which is unintended and actually scary in cases like the Parser. Luckily all Hooks::run I have seen so far ignore unintended out-values. So even if a hook handler tries to do something bad like replacing the Parser with a different one, this would not have an effect. Removing the & does not remove the possibility to manipulate the object. Changes done to public properties are still visible to the caller. Unfortunately these & cannot be removed from the callers as long as there is a single callee expecting a reference. This patch reduces the number of such problematic callees. Change-Id: Ib3a9da257b50326d569ab1973b523c952963c16b
2018-05-15 14:45:26 +00:00
* @param LinksUpdate $linksUpdate
Store references in page_props and cache This stores references in page_props during links update in compressed JSON form. If the size is too big, it's broken up in several parts to fit, which is very unlikely to occur more than once. When the data is retrieved from the db, it's always cached. If set in config, it's also saved in the cache on parse. If not, the cache is invalidated when references are modified. Uses cases include : section preview to also show refs defined elsewhere on the page (T124840) and MobileFrontend (T123328). For the later, this still needs API support (T123290). There's a soft dependency on the core change I0c73b3d181f32502da75687857ae9aeff731f559. Bug: T125329 Change-Id: I7b106254b8f264f93b0f0c9cfa89f65adeeea4f0
2016-01-25 16:52:46 +00:00
*/
Don't expect objects by reference in hook handlers The motivation for this patch is to make the code less complex, better readable, and less brittle. Example: public function onExampleHook( Parser &$parser, array &$result ) { /* This is the hook handler */ } In this example the $result array is meant to be manipulated by the hook handler. Changes should become visible to the caller. Since PHP passes arrays by value, the & is needed to make this possible. But the & is misplaced in pretty much all cases where the parameter is an object. The only reason we still see these & in many hook handlers is historical: PHP 4 passed objects by value, which potentially caused expensive cloning. This was prevented with the &. Since PHP 5 objects are passed by reference. However, this did not made the & entirely meaningless. Keeping the & means callees are allowed to replace passed objects with new ones. The & makes it look like a function might intentionally replace a passed object, which is unintended and actually scary in cases like the Parser. Luckily all Hooks::run I have seen so far ignore unintended out-values. So even if a hook handler tries to do something bad like replacing the Parser with a different one, this would not have an effect. Removing the & does not remove the possibility to manipulate the object. Changes done to public properties are still visible to the caller. Unfortunately these & cannot be removed from the callers as long as there is a single callee expecting a reference. This patch reduces the number of such problematic callees. Change-Id: Ib3a9da257b50326d569ab1973b523c952963c16b
2018-05-15 14:45:26 +00:00
public static function onLinksUpdate( LinksUpdate $linksUpdate ) {
Merge LinksUpdateConstructed hook into LinksUpdate This merges the content of the LinksUpdateConstructed hook callback into the LinksUpdate hook callback since it's fine to defer saving to the cache. Change-Id: Iad6008a31aaf659af3c560858df278335bc57c8f
2016-02-20 08:05:36 +00:00
global $wgCiteStoreReferencesData, $wgCiteCacheRawReferencesOnParse;
Store references in page_props and cache This stores references in page_props during links update in compressed JSON form. If the size is too big, it's broken up in several parts to fit, which is very unlikely to occur more than once. When the data is retrieved from the db, it's always cached. If set in config, it's also saved in the cache on parse. If not, the cache is invalidated when references are modified. Uses cases include : section preview to also show refs defined elsewhere on the page (T124840) and MobileFrontend (T123328). For the later, this still needs API support (T123290). There's a soft dependency on the core change I0c73b3d181f32502da75687857ae9aeff731f559. Bug: T125329 Change-Id: I7b106254b8f264f93b0f0c9cfa89f65adeeea4f0
2016-01-25 16:52:46 +00:00
if ( !$wgCiteStoreReferencesData ) {
return;
}
Merge LinksUpdateConstructed hook into LinksUpdate This merges the content of the LinksUpdateConstructed hook callback into the LinksUpdate hook callback since it's fine to defer saving to the cache. Change-Id: Iad6008a31aaf659af3c560858df278335bc57c8f
2016-02-20 08:05:36 +00:00
$refData = $linksUpdate->getParserOutput()->getExtensionData( Cite::EXT_DATA_KEY );
if ( $refData === null ) {
return;
}
if ( $wgCiteCacheRawReferencesOnParse ) {
// caching
Add phan configuration for static analysis Bug: T179554 Change-Id: I2bfd52c08aac1aa8f34e0664e6314835f79a0324
2017-12-25 13:17:20 +00:00
$cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
Merge LinksUpdateConstructed hook into LinksUpdate This merges the content of the LinksUpdateConstructed hook callback into the LinksUpdate hook callback since it's fine to defer saving to the cache. Change-Id: Iad6008a31aaf659af3c560858df278335bc57c8f
2016-02-20 08:05:36 +00:00
$articleID = $linksUpdate->getTitle()->getArticleID();
$key = $cache->makeKey( Cite::EXT_DATA_KEY, $articleID );
$cache->set( $key, $refData, Cite::CACHE_DURATION_ONPARSE );
}
// JSON encode
$ppValue = FormatJson::encode( $refData, false, FormatJson::ALL_OK );
// GZIP encode references data at maximum compression
$ppValue = gzencode( $ppValue, 9 );
// split the string in smaller parts that can fit into a db blob
$ppValues = str_split( $ppValue, Cite::MAX_STORAGE_LENGTH );
foreach ( $ppValues as $num => $ppValue ) {
$key = 'references-' . intval( $num + 1 );
$linksUpdate->mProperties[$key] = $ppValue;
Store references in page_props and cache This stores references in page_props during links update in compressed JSON form. If the size is too big, it's broken up in several parts to fit, which is very unlikely to occur more than once. When the data is retrieved from the db, it's always cached. If set in config, it's also saved in the cache on parse. If not, the cache is invalidated when references are modified. Uses cases include : section preview to also show refs defined elsewhere on the page (T124840) and MobileFrontend (T123328). For the later, this still needs API support (T123290). There's a soft dependency on the core change I0c73b3d181f32502da75687857ae9aeff731f559. Bug: T125329 Change-Id: I7b106254b8f264f93b0f0c9cfa89f65adeeea4f0
2016-01-25 16:52:46 +00:00
}
Merge LinksUpdateConstructed hook into LinksUpdate This merges the content of the LinksUpdateConstructed hook callback into the LinksUpdate hook callback since it's fine to defer saving to the cache. Change-Id: Iad6008a31aaf659af3c560858df278335bc57c8f
2016-02-20 08:05:36 +00:00
$linksUpdate->getParserOutput()->setExtensionData( Cite::EXT_DATA_KEY, null );
Store references in page_props and cache This stores references in page_props during links update in compressed JSON form. If the size is too big, it's broken up in several parts to fit, which is very unlikely to occur more than once. When the data is retrieved from the db, it's always cached. If set in config, it's also saved in the cache on parse. If not, the cache is invalidated when references are modified. Uses cases include : section preview to also show refs defined elsewhere on the page (T124840) and MobileFrontend (T123328). For the later, this still needs API support (T123290). There's a soft dependency on the core change I0c73b3d181f32502da75687857ae9aeff731f559. Bug: T125329 Change-Id: I7b106254b8f264f93b0f0c9cfa89f65adeeea4f0
2016-01-25 16:52:46 +00:00
}
/**
* Callback for LinksUpdateComplete hook
* If $wgCiteCacheRawReferencesOnParse is set to false, purges the cache
* when references are modified
*
Don't expect objects by reference in hook handlers The motivation for this patch is to make the code less complex, better readable, and less brittle. Example: public function onExampleHook( Parser &$parser, array &$result ) { /* This is the hook handler */ } In this example the $result array is meant to be manipulated by the hook handler. Changes should become visible to the caller. Since PHP passes arrays by value, the & is needed to make this possible. But the & is misplaced in pretty much all cases where the parameter is an object. The only reason we still see these & in many hook handlers is historical: PHP 4 passed objects by value, which potentially caused expensive cloning. This was prevented with the &. Since PHP 5 objects are passed by reference. However, this did not made the & entirely meaningless. Keeping the & means callees are allowed to replace passed objects with new ones. The & makes it look like a function might intentionally replace a passed object, which is unintended and actually scary in cases like the Parser. Luckily all Hooks::run I have seen so far ignore unintended out-values. So even if a hook handler tries to do something bad like replacing the Parser with a different one, this would not have an effect. Removing the & does not remove the possibility to manipulate the object. Changes done to public properties are still visible to the caller. Unfortunately these & cannot be removed from the callers as long as there is a single callee expecting a reference. This patch reduces the number of such problematic callees. Change-Id: Ib3a9da257b50326d569ab1973b523c952963c16b
2018-05-15 14:45:26 +00:00
* @param LinksUpdate $linksUpdate
Store references in page_props and cache This stores references in page_props during links update in compressed JSON form. If the size is too big, it's broken up in several parts to fit, which is very unlikely to occur more than once. When the data is retrieved from the db, it's always cached. If set in config, it's also saved in the cache on parse. If not, the cache is invalidated when references are modified. Uses cases include : section preview to also show refs defined elsewhere on the page (T124840) and MobileFrontend (T123328). For the later, this still needs API support (T123290). There's a soft dependency on the core change I0c73b3d181f32502da75687857ae9aeff731f559. Bug: T125329 Change-Id: I7b106254b8f264f93b0f0c9cfa89f65adeeea4f0
2016-01-25 16:52:46 +00:00
*/
Don't expect objects by reference in hook handlers The motivation for this patch is to make the code less complex, better readable, and less brittle. Example: public function onExampleHook( Parser &$parser, array &$result ) { /* This is the hook handler */ } In this example the $result array is meant to be manipulated by the hook handler. Changes should become visible to the caller. Since PHP passes arrays by value, the & is needed to make this possible. But the & is misplaced in pretty much all cases where the parameter is an object. The only reason we still see these & in many hook handlers is historical: PHP 4 passed objects by value, which potentially caused expensive cloning. This was prevented with the &. Since PHP 5 objects are passed by reference. However, this did not made the & entirely meaningless. Keeping the & means callees are allowed to replace passed objects with new ones. The & makes it look like a function might intentionally replace a passed object, which is unintended and actually scary in cases like the Parser. Luckily all Hooks::run I have seen so far ignore unintended out-values. So even if a hook handler tries to do something bad like replacing the Parser with a different one, this would not have an effect. Removing the & does not remove the possibility to manipulate the object. Changes done to public properties are still visible to the caller. Unfortunately these & cannot be removed from the callers as long as there is a single callee expecting a reference. This patch reduces the number of such problematic callees. Change-Id: Ib3a9da257b50326d569ab1973b523c952963c16b
2018-05-15 14:45:26 +00:00
public static function onLinksUpdateComplete( LinksUpdate $linksUpdate ) {
Store references in page_props and cache This stores references in page_props during links update in compressed JSON form. If the size is too big, it's broken up in several parts to fit, which is very unlikely to occur more than once. When the data is retrieved from the db, it's always cached. If set in config, it's also saved in the cache on parse. If not, the cache is invalidated when references are modified. Uses cases include : section preview to also show refs defined elsewhere on the page (T124840) and MobileFrontend (T123328). For the later, this still needs API support (T123290). There's a soft dependency on the core change I0c73b3d181f32502da75687857ae9aeff731f559. Bug: T125329 Change-Id: I7b106254b8f264f93b0f0c9cfa89f65adeeea4f0
2016-01-25 16:52:46 +00:00
global $wgCiteStoreReferencesData, $wgCiteCacheRawReferencesOnParse;
if ( !$wgCiteStoreReferencesData || $wgCiteCacheRawReferencesOnParse ) {
return;
}
// if we can, avoid clearing the cache when references were not changed
if ( method_exists( $linksUpdate, 'getAddedProperties' )
&& method_exists( $linksUpdate, 'getRemovedProperties' )
) {
$addedProps = $linksUpdate->getAddedProperties();
$removedProps = $linksUpdate->getRemovedProperties();
if ( !isset( $addedProps['references-1'] )
&& !isset( $removedProps['references-1'] )
) {
return;
}
}
Add phan configuration for static analysis Bug: T179554 Change-Id: I2bfd52c08aac1aa8f34e0664e6314835f79a0324
2017-12-25 13:17:20 +00:00
$cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
Store references in page_props and cache This stores references in page_props during links update in compressed JSON form. If the size is too big, it's broken up in several parts to fit, which is very unlikely to occur more than once. When the data is retrieved from the db, it's always cached. If set in config, it's also saved in the cache on parse. If not, the cache is invalidated when references are modified. Uses cases include : section preview to also show refs defined elsewhere on the page (T124840) and MobileFrontend (T123328). For the later, this still needs API support (T123290). There's a soft dependency on the core change I0c73b3d181f32502da75687857ae9aeff731f559. Bug: T125329 Change-Id: I7b106254b8f264f93b0f0c9cfa89f65adeeea4f0
2016-01-25 16:52:46 +00:00
$articleID = $linksUpdate->getTitle()->getArticleID();
$key = $cache->makeKey( Cite::EXT_DATA_KEY, $articleID );
// delete with reduced hold off period (LinksUpdate uses a master connection)
$cache->delete( $key, WANObjectCache::MAX_COMMIT_DELAY );
}
Make it possible to send VE cite toolbar items to the 'insert' (other) group To be merged with Ifd688ae6 Bug: T133727 Change-Id: Ic87f996f2a95ffe89999384c48f11745f251db0e
2016-04-27 20:03:49 +00:00
/**
* Adds extra variables to the global config
Improve some parameter docs Change-Id: I7d50eaabfba309a62d1dbd16ded0cbcab3beb82f
2017-10-06 19:22:30 +00:00
* @param array &$vars
Make it possible to send VE cite toolbar items to the 'insert' (other) group To be merged with Ifd688ae6 Bug: T133727 Change-Id: Ic87f996f2a95ffe89999384c48f11745f251db0e
2016-04-27 20:03:49 +00:00
*/
public static function onResourceLoaderGetConfigVars( array &$vars ) {
Add phan configuration for static analysis Bug: T179554 Change-Id: I2bfd52c08aac1aa8f34e0664e6314835f79a0324
2017-12-25 13:17:20 +00:00
$config = MediaWikiServices::getInstance()->getConfigFactory()->makeConfig( 'cite' );
Make it possible to send VE cite toolbar items to the 'insert' (other) group To be merged with Ifd688ae6 Bug: T133727 Change-Id: Ic87f996f2a95ffe89999384c48f11745f251db0e
2016-04-27 20:03:49 +00:00
$vars['wgCiteVisualEditorOtherGroup'] = $config->get( 'CiteVisualEditorOtherGroup' );
VE: Support 'responsive' attribute Bug: T53260 Change-Id: I1e0ae39e8c30653b7ba0f537723a4bcd79ac3162
2017-09-19 15:35:27 +00:00
$vars['wgCiteResponsiveReferences'] = $config->get( 'CiteResponsiveReferences' );
Make it possible to send VE cite toolbar items to the 'insert' (other) group To be merged with Ifd688ae6 Bug: T133727 Change-Id: Ic87f996f2a95ffe89999384c48f11745f251db0e
2016-04-27 20:03:49 +00:00
}
API: Expose $wgCiteResponsiveReferences via meta=siteinfo Bug: T159894 Change-Id: I2404999ab11b5cf7b740ae43696c4676ab1b6d22
2017-09-12 03:02:25 +00:00
/**
* Hook: APIQuerySiteInfoGeneralInfo
*
* Expose configs via action=query&meta=siteinfo
*
* @param ApiQuerySiteInfo $api
* @param array &$data
*/
public static function onAPIQuerySiteInfoGeneralInfo( ApiQuerySiteInfo $api, array &$data ) {
Add phan configuration for static analysis Bug: T179554 Change-Id: I2bfd52c08aac1aa8f34e0664e6314835f79a0324
2017-12-25 13:17:20 +00:00
$config = MediaWikiServices::getInstance()->getConfigFactory()->makeConfig( 'cite' );
API: Expose $wgCiteResponsiveReferences via meta=siteinfo Bug: T159894 Change-Id: I2404999ab11b5cf7b740ae43696c4676ab1b6d22
2017-09-12 03:02:25 +00:00
$data['citeresponsivereferences'] = $config->get( 'CiteResponsiveReferences' );
}
Remove some obscure comments A good bunch of these comments literally repeats what the code already says. Change-Id: I9c128f748971bf20a61a85ed57d3261d27c465f0
2017-12-28 14:55:49 +00:00
VisualEditor: Move code for Cite into this repo This code has been developed over three years now in the repo of MediaWiki's integration of VisualEditor. It has grown and developed significantly during that time, but now is pretty stable. A number of hacks inside the MediaWiki- VisualEditor code base have been used to prevent this code from being loaded on wikis where the Cite extension is not deployed, but this state of affairs is and always was meant to be temporary. This code is under the MIT licence which is a tad messy, but not impossible. It's clearly labelled as such. The list of authors has been updated to take into account the influx of new functionality. Bug: T41621 Bug: T104928 Change-Id: I39936ed83d5a60471a0a75da753f498e80aef234
2016-02-03 21:03:41 +00:00
}
Reference in a new issue Copy permalink