Page MenuHomeWickedGov Phorge
Files F1428004

RefreshSecondaryDataUpdate.php
No OneTemporary
Actions

Size
4 KB
Referenced Files
None
Subscribers
None

RefreshSecondaryDataUpdate.php
View Options

<?php
/**
* Updater for secondary data after a page edit.
*
* 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
*/
namespace MediaWiki\Deferred;
use Exception;
use JobSpecification;
use MediaWiki\Deferred\LinksUpdate\LinksUpdate;
use MediaWiki\Page\PageIdentity;
use MediaWiki\Revision\RevisionRecord;
use MediaWiki\Storage\DerivedPageDataUpdater;
use MediaWiki\User\UserIdentity;
use MWExceptionHandler;
use Wikimedia\Rdbms\ILBFactory;
/**
* Update object handling the cleanup of secondary data after a page was edited.
*
* This makes it possible for DeferredUpdates to have retry logic using a
* single refreshLinks job if any of the bundled updates fail.
*
* @since 1.34
*/
class RefreshSecondaryDataUpdate extends DataUpdate
implements TransactionRoundAwareUpdate, EnqueueableDataUpdate
{
/** @var ILBFactory */
private $lbFactory;
/** @var PageIdentity */
private $page;
/** @var DerivedPageDataUpdater */
private $updater;
/** @var bool */
private $recursive;
/** @var string|false TS_MW */
private $freshness;
/** @var RevisionRecord */
private $revisionRecord;
/** @var UserIdentity */
private $user;
/**
* @param ILBFactory $lbFactory
* @param UserIdentity $user
* @param PageIdentity $page Page we are updating
* @param RevisionRecord $revisionRecord
* @param DerivedPageDataUpdater $updater
* @param array $options Options map; supports "recursive" (bool) and "freshness" (string|false, TS_MW)
*/
public function __construct(
ILBFactory $lbFactory,
UserIdentity $user,
PageIdentity $page,
RevisionRecord $revisionRecord,
DerivedPageDataUpdater $updater,
array $options
) {
parent::__construct();
$this->lbFactory = $lbFactory;
$this->user = $user;
$this->page = $page;
$this->revisionRecord = $revisionRecord;
$this->updater = $updater;
$this->recursive = !empty( $options['recursive'] );
$this->freshness = $options['freshness'] ?? false;
}
public function getTransactionRoundRequirement() {
return self::TRX_ROUND_ABSENT;
}
public function doUpdate() {
$updates = $this->updater->getSecondaryDataUpdates( $this->recursive );
foreach ( $updates as $update ) {
if ( $update instanceof LinksUpdate ) {
$update->setRevisionRecord( $this->revisionRecord );
$update->setTriggeringUser( $this->user );
}
if ( $update instanceof DataUpdate ) {
$update->setCause( $this->causeAction, $this->causeAgent );
}
}
// T221577, T248003: flush any transaction; each update needs outer transaction scope
// and the code above may have implicitly started one.
$this->lbFactory->commitPrimaryChanges( __METHOD__ );
$e = null;
foreach ( $updates as $update ) {
try {
DeferredUpdates::attemptUpdate( $update );
} catch ( Exception $e ) {
// Try as many updates as possible on the first pass
MWExceptionHandler::rollbackPrimaryChangesAndLog( $e );
}
}
if ( $e instanceof Exception ) {
throw $e; // trigger RefreshLinksJob enqueue via getAsJobSpecification()
}
}
public function getAsJobSpecification() {
return [
'domain' => $this->lbFactory->getLocalDomainID(),
'job' => new JobSpecification(
'refreshLinksPrioritized',
[
'namespace' => $this->page->getNamespace(),
'title' => $this->page->getDBkey(),
// Ensure fresh data are used, for normal data reuse the parser cache if it was saved
'rootJobTimestamp' => $this->freshness ?: $this->revisionRecord->getTimestamp(),
'useRecursiveLinksUpdate' => $this->recursive,
'triggeringUser' => [
'userId' => $this->user->getId(),
'userName' => $this->user->getName()
],
'triggeringRevisionId' => $this->revisionRecord->getId(),
'causeAction' => $this->getCauseAction(),
'causeAgent' => $this->getCauseAgent()
],
[ 'removeDuplicates' => true ]
)
];
}
}
/** @deprecated class alias since 1.42 */
class_alias( RefreshSecondaryDataUpdate::class, 'RefreshSecondaryDataUpdate' );

File Metadata

Mime Type
text/x-php
Expires
Sat, May 16, 15:28 (15 h, 18 m)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
17/24/de9023e1dee2bcdd25f42cf83b98
Default Alt Text
RefreshSecondaryDataUpdate.php (4 KB)

Event Timeline