1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
<?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 MediaWiki\Deferred\LinksUpdate\LinksUpdate;
use MediaWiki\Exception\MWExceptionHandler;
use MediaWiki\JobQueue\JobSpecification;
use MediaWiki\Page\PageIdentity;
use MediaWiki\Revision\RevisionRecord;
use MediaWiki\Storage\DerivedPageDataUpdater;
use MediaWiki\User\UserIdentity;
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' );
|
