includes/deferred/DataUpdate.php

   1 <?php
   2 /**
   3  * Base code for update jobs that do something with some secondary
   4  * data extracted from article.
   5  *
   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.
  10  *
  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.
  15  *
  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
  20  *
  21  * @file
  22  */
  23
  24 /**
  25  * Abstract base class for update jobs that do something with some secondary
  26  * data extracted from article.
  27  */
  28 abstract class DataUpdate implements DeferrableUpdate {
  29         /** @var mixed Result from LBFactory::getEmptyTransactionTicket() */
  30         protected $ticket;
  31
  32         public function __construct() {
  33                 // noop
  34         }
  35
  36         /**
  37          * @param mixed $ticket Result of getEmptyTransactionTicket()
  38          * @since 1.28
  39          */
  40         public function setTransactionTicket( $ticket ) {
  41                 $this->ticket = $ticket;
  42         }
  43
  44         /**
  45          * Convenience method, calls doUpdate() on every DataUpdate in the array.
  46          *
  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().
  52          *
  53          * This allows for limited transactional logic across multiple backends for storing
  54          * secondary data.
  55          *
  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
  59          */
  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 );
  64                 }
  65
  66                 foreach ( $updates as $update ) {
  67                         $update->doUpdate();
  68                 }
  69         }
  70
  71         /**
  72          * Enqueue jobs for every DataUpdate that support enqueueUpdate()
  73          * and return the remaining DataUpdate objects (those that do not)
  74          *
  75          * @param DataUpdate[] $updates A list of DataUpdate instances
  76          * @return DataUpdate[]
  77          * @since 1.27
  78          */
  79         protected static function enqueueUpdates( array $updates ) {
  80                 $remaining = [];
  81
  82                 foreach ( $updates as $update ) {
  83                         if ( $update instanceof EnqueueableDataUpdate ) {
  84                                 $spec = $update->getAsJobSpecification();
  85                                 JobQueueGroup::singleton( $spec['wiki'] )->push( $spec['job'] );
  86                         } else {
  87                                 $remaining[] = $update;
  88                         }
  89                 }
  90
  91                 return $remaining;
  92         }
  93 }