Page Menu
Home
WickedGov Phorge
Search
Configure Global Search
Log In
Files
F7406622
EditStashCache.php
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Flag For Later
Award Token
Size
3 KB
Referenced Files
None
Subscribers
None
EditStashCache.php
View Options
<?php
namespace
MediaWiki\Extension\AbuseFilter
;
use
InvalidArgumentException
;
use
MediaWiki\Extension\AbuseFilter\Variables\VariableHolder
;
use
MediaWiki\Extension\AbuseFilter\Variables\VariablesManager
;
use
MediaWiki\Linker\LinkTarget
;
use
Psr\Log\LoggerInterface
;
use
Wikimedia\ObjectCache\BagOStuff
;
use
Wikimedia\Stats\IBufferingStatsdDataFactory
;
/**
* Wrapper around cache for storing and retrieving data from edit stash
*/
class
EditStashCache
{
private
const
CACHE_VERSION
=
'v5'
;
/** @var BagOStuff */
private
$cache
;
/** @var IBufferingStatsdDataFactory */
private
$statsdDataFactory
;
/** @var VariablesManager */
private
$variablesManager
;
/** @var LoggerInterface */
private
$logger
;
/** @var LinkTarget */
private
$target
;
/** @var string */
private
$group
;
/**
* @param BagOStuff $cache
* @param IBufferingStatsdDataFactory $statsdDataFactory
* @param VariablesManager $variablesManager
* @param LoggerInterface $logger
* @param LinkTarget $target
* @param string $group
*/
public
function
__construct
(
BagOStuff
$cache
,
IBufferingStatsdDataFactory
$statsdDataFactory
,
VariablesManager
$variablesManager
,
LoggerInterface
$logger
,
LinkTarget
$target
,
string
$group
)
{
$this
->
cache
=
$cache
;
$this
->
statsdDataFactory
=
$statsdDataFactory
;
$this
->
variablesManager
=
$variablesManager
;
$this
->
logger
=
$logger
;
$this
->
target
=
$target
;
$this
->
group
=
$group
;
}
/**
* @param VariableHolder $vars For creating the key
* @param array $data Data to store
*/
public
function
store
(
VariableHolder
$vars
,
array
$data
):
void
{
$key
=
$this
->
getStashKey
(
$vars
);
$this
->
cache
->
set
(
$key
,
$data
,
BagOStuff
::
TTL_MINUTE
);
$this
->
logCache
(
'store'
,
$key
);
}
/**
* Search the cache to find data for a previous execution done for the current edit.
*
* @param VariableHolder $vars For creating the key
* @return false|array False on cache miss, the array with data otherwise
*/
public
function
seek
(
VariableHolder
$vars
)
{
$key
=
$this
->
getStashKey
(
$vars
);
$value
=
$this
->
cache
->
get
(
$key
);
$status
=
$value
!==
false
?
'hit'
:
'miss'
;
$this
->
logCache
(
$status
,
$key
);
return
$value
;
}
/**
* Log cache operations related to stashed edits, i.e. store, hit and miss
*
* @param string $type Either 'store', 'hit' or 'miss'
* @param string $key The cache key used
* @throws InvalidArgumentException
*/
private
function
logCache
(
string
$type
,
string
$key
):
void
{
if
(
!
in_array
(
$type
,
[
'store'
,
'hit'
,
'miss'
]
)
)
{
// @codeCoverageIgnoreStart
throw
new
InvalidArgumentException
(
'$type must be either "store", "hit" or "miss"'
);
// @codeCoverageIgnoreEnd
}
$this
->
logger
->
debug
(
__METHOD__
.
": cache {logtype} for '{target}' (key {key})."
,
[
'logtype'
=>
$type
,
'target'
=>
$this
->
target
,
'key'
=>
$key
]
);
$this
->
statsdDataFactory
->
increment
(
"abusefilter.check-stash.$type"
);
}
/**
* Get the stash key for the current variables
*
* @param VariableHolder $vars
* @return string
*/
private
function
getStashKey
(
VariableHolder
$vars
):
string
{
$inputVars
=
$this
->
variablesManager
->
exportNonLazyVars
(
$vars
);
// Exclude noisy fields that have superficial changes
$excludedVars
=
[
'old_html'
=>
true
,
'new_html'
=>
true
,
'user_age'
=>
true
,
'timestamp'
=>
true
,
'page_age'
=>
true
,
'page_last_edit_age'
=>
true
,
];
$inputVars
=
array_diff_key
(
$inputVars
,
$excludedVars
);
ksort
(
$inputVars
);
$hash
=
md5
(
serialize
(
$inputVars
)
);
return
$this
->
cache
->
makeKey
(
'abusefilter'
,
'check-stash'
,
$this
->
group
,
$hash
,
self
::
CACHE_VERSION
);
}
}
File Metadata
Details
Attached
Mime Type
text/x-php
Expires
Sat, Nov 21, 20:30 (1 d, 9 h)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
07/ff/6da6f13b5778e548e56cd262ebed
Default Alt Text
EditStashCache.php (3 KB)
Attached To
Mode
rMWPROD MediaWiki Production
Attached
Detach File
Event Timeline
Log In to Comment