Thijs/wiki.techinc.nl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Deprecate unusual uses of the ParserGetVariableValueSwitch hook

Browse source 
Ensure that the value returned is always also added to the cache, since
we (eventually) want to remove the hook's access to
$parser->mVarCache.  Also don't allow monkeying with the value passed
as $magicWordId, even though it's a reference.

Code search:
https://codesearch.wmflabs.org/deployed/?q=ParserGetVariableValueSwitch&i=nope&files=&repos=

Bug: T236813
Depends-On: Ia12faefada7e4cf04f1a6b12b3ed1703bf28e437
Depends-On: Ia9e2e00c6b7d0e62cbe80c3b124165b691b1ff3d
Depends-On: I1e48fa47b8723958d543a69aaf9b62b872200dc5
Depends-On: If9a0885a8664c22473ade712364c2dd0a5c04e0b
Change-Id: I3d6b281f8e4e0bf68eefbf9767047527b4573b79
This commit is contained in:
C. Scott Ananian 2020-03-26 17:57:22 -04:00
parent 063445581c
commit a3c9621ad0
3 changed files with 21 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
RELEASE-NOTES-1.35
View file

@ -700,6 +700,10 @@ because of Phabricator reports.
* The Parser::enableOOUI() method has been deprecated. Use
$parser->getOutput()->enableOOUI() instead.
* The ParserGetVariableValueVarCache hook has been deprecated.
* When using the ParserGetVariableValueSwitch hook, the following unusual
uses have been deprecated: modifying the passed $magicWordId or failing to
cache the returned value in $variableCache.
* Parser::$mVarCache has been deprecated for direct access.
* A new UserNameUtils service was introduced. The following User methods
were deprecated in favor of using the new service:
- isIP

8
docs/hooks.txt
View file

@ -2588,12 +2588,12 @@ $rev: Revision object of the template
'ParserFirstCallInit': Called when the parser initialises for the first time.
[&]$parser: Parser object being cleared
'ParserGetVariableValueSwitch': Called when the parser need the value of a
'ParserGetVariableValueSwitch': Called when the parser needs the value of a
custom magic word
[&]$parser: Parser object
&$variableCache: array to store the value in case of multiples calls of the
same magic word
&$magicWordId: index (string) of the magic word
&$variableCache: array to cache the value; when you return
$variableCache[$magicWordId] should be the same as $ret
[&]$magicWordId: index (string) of the magic word (hook should not mutate it!)
&$ret: value of the magic word (the hook should set it)
[&]$frame: PPFrame object to use for expanding any template variables

14
includes/parser/Parser.php
View file

@ -150,6 +150,7 @@ class Parser {
public $mFunctionTagHooks = [];
public $mStripList = [];
public $mDefaultStripList = [];
/** @deprecated since 1.35 */
public $mVarCache = [];
public $mImageParams = [];
public $mImageParamsMagicArray = [];
@ -3020,11 +3021,22 @@ class Parser {
break;
default:
$ret = null;
$originalIndex = $index;
Hooks::run(
'ParserGetVariableValueSwitch',
[ &$parser, &$this->mVarCache, &$index, &$ret, &$frame ]
);
if ( $index !== $originalIndex ) {
wfDeprecated(
'ParserGetVariableValueSwitch modifying $index', '1.35'
);
}
if ( !isset( $this->mVarCache[$originalIndex] ) ||
$this->mVarCache[$originalIndex] !== $ret ) {
wfDeprecated(
'ParserGetVariableValueSwitch bypassing cache', '1.35'
);
}
return $ret;
}