cad89b14796101c425256611e17d842954558c12
3 * Base code for update jobs that do something with some secondary
4 * data extracted from article.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19 * http://www.gnu.org/copyleft/gpl.html
25 * Abstract base class for update jobs that do something with some secondary
26 * data extracted from article.
28 abstract class DataUpdate
implements DeferrableUpdate
{
29 /** @var mixed Result from LBFactory::getEmptyTransactionTicket() */
32 public function __construct() {
37 * @param mixed $ticket Result of getEmptyTransactionTicket()
40 public function setTransactionTicket( $ticket ) {
41 $this->ticket
= $ticket;
45 * Convenience method, calls doUpdate() on every DataUpdate in the array.
47 * This methods supports transactions logic by first calling beginTransaction()
48 * on all updates in the array, then calling doUpdate() on each, and, if all goes well,
49 * then calling commitTransaction() on each update. If an error occurs,
50 * rollbackTransaction() will be called on any update object that had beginTransaction()
51 * called but not yet commitTransaction().
53 * This allows for limited transactional logic across multiple backends for storing
56 * @param DataUpdate[] $updates A list of DataUpdate instances
57 * @param string $mode Use "enqueue" to use the job queue when possible [Default: run]
58 * @throws Exception|null
60 public static function runUpdates( array $updates, $mode = 'run' ) {
61 if ( $mode === 'enqueue' ) {
62 // When possible, push updates as jobs instead of calling doUpdate()
63 $updates = self
::enqueueUpdates( $updates );
66 foreach ( $updates as $update ) {
72 * Enqueue jobs for every DataUpdate that support enqueueUpdate()
73 * and return the remaining DataUpdate objects (those that do not)
75 * @param DataUpdate[] $updates A list of DataUpdate instances
76 * @return DataUpdate[]
79 protected static function enqueueUpdates( array $updates ) {
82 foreach ( $updates as $update ) {
83 if ( $update instanceof EnqueueableDataUpdate
) {
84 $spec = $update->getAsJobSpecification();
85 JobQueueGroup
::singleton( $spec['wiki'] )->push( $spec['job'] );
87 $remaining[] = $update;