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
|
<?php
/**
* Base code for update jobs that do something with some secondary
* data extracted from article.
*
* 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
*/
/**
* Abstract base class for update jobs that do something with some secondary
* data extracted from article.
*
* @note: subclasses should NOT start or commit transactions in their doUpdate() method,
* a transaction will automatically be wrapped around the update. If need be,
* subclasses can override the beginTransaction() and commitTransaction() methods.
*/
abstract class DataUpdate implements DeferrableUpdate {
/**
* Constructor
*/
public function __construct() {
# noop
}
/**
* Begin an appropriate transaction, if any.
* This default implementation does nothing.
*/
public function beginTransaction() {
//noop
}
/**
* Commit the transaction started via beginTransaction, if any.
* This default implementation does nothing.
*/
public function commitTransaction() {
//noop
}
/**
* Abort / roll back the transaction started via beginTransaction, if any.
* This default implementation does nothing.
*/
public function rollbackTransaction() {
//noop
}
/**
* Convenience method, calls doUpdate() on every DataUpdate in the array.
*
* This methods supports transactions logic by first calling beginTransaction()
* on all updates in the array, then calling doUpdate() on each, and, if all goes well,
* then calling commitTransaction() on each update. If an error occurs,
* rollbackTransaction() will be called on any update object that had beginTransaction()
* called but not yet commitTransaction().
*
* This allows for limited transactional logic across multiple backends for storing
* secondary data.
*
* @param array $updates a list of DataUpdate instances
* @throws Exception|null
*/
public static function runUpdates( $updates ) {
if ( empty( $updates ) ) {
return; # nothing to do
}
$open_transactions = array();
$exception = null;
/**
* @var $update DataUpdate
* @var $trans DataUpdate
*/
try {
// begin transactions
foreach ( $updates as $update ) {
$update->beginTransaction();
$open_transactions[] = $update;
}
// do work
foreach ( $updates as $update ) {
$update->doUpdate();
}
// commit transactions
while ( count( $open_transactions ) > 0 ) {
$trans = array_pop( $open_transactions );
$trans->commitTransaction();
}
} catch ( Exception $ex ) {
$exception = $ex;
wfDebug( "Caught exception, will rethrow after rollback: " . $ex->getMessage() );
}
// rollback remaining transactions
while ( count( $open_transactions ) > 0 ) {
$trans = array_pop( $open_transactions );
$trans->rollbackTransaction();
}
if ( $exception ) {
throw $exception; // rethrow after cleanup
}
}
}
|
