includes/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  * @note: subclasses should NOT start or commit transactions in their doUpdate() method,
  29  *        a transaction will automatically be wrapped around the update. If need be,
  30  *        subclasses can override the beginTransaction() and commitTransaction() methods.
  31  */
  32 abstract class DataUpdate implements DeferrableUpdate {
  33
  34         /**
  35          * Constructor
  36          */
  37         public function __construct() {
  38                 # noop
  39         }
  40
  41         /**
  42          * Begin an appropriate transaction, if any.
  43          * This default implementation does nothing.
  44          */
  45         public function beginTransaction() {
  46                 //noop
  47         }
  48
  49         /**
  50          * Commit the transaction started via beginTransaction, if any.
  51          * This default implementation does nothing.
  52          */
  53         public function commitTransaction() {
  54                 //noop
  55         }
  56
  57         /**
  58          * Abort / roll back the transaction started via beginTransaction, if any.
  59          * This default implementation does nothing.
  60          */
  61         public function rollbackTransaction() {
  62                 //noop
  63         }
  64
  65         /**
  66          * Convenience method, calls doUpdate() on every DataUpdate in the array.
  67          *
  68          * This methods supports transactions logic by first calling beginTransaction()
  69          * on all updates in the array, then calling doUpdate() on each, and, if all goes well,
  70          * then calling commitTransaction() on each update. If an error occurs,
  71          * rollbackTransaction() will be called on any update object that had beginTransaction()
  72          * called but not yet commitTransaction().
  73          *
  74          * This allows for limited transactional logic across multiple backends for storing
  75          * secondary data.
  76          *
  77          * @param array $updates a list of DataUpdate instances
  78          * @throws Exception|null
  79          */
  80         public static function runUpdates( $updates ) {
  81                 if ( empty( $updates ) ) {
  82                         return; # nothing to do
  83                 }
  84
  85                 $open_transactions = array();
  86                 $exception = null;
  87
  88                 /**
  89                  * @var $update DataUpdate
  90                  * @var $trans DataUpdate
  91                  */
  92
  93                 try {
  94                         // begin transactions
  95                         foreach ( $updates as $update ) {
  96                                 $update->beginTransaction();
  97                                 $open_transactions[] = $update;
  98                         }
  99
 100                         // do work
 101                         foreach ( $updates as $update ) {
 102                                 $update->doUpdate();
 103                         }
 104
 105                         // commit transactions
 106                         while ( count( $open_transactions ) > 0 ) {
 107                                 $trans = array_pop( $open_transactions );
 108                                 $trans->commitTransaction();
 109                         }
 110                 } catch ( Exception $ex ) {
 111                         $exception = $ex;
 112                         wfDebug( "Caught exception, will rethrow after rollback: " . $ex->getMessage() );
 113                 }
 114
 115                 // rollback remaining transactions
 116                 while ( count( $open_transactions ) > 0 ) {
 117                         $trans = array_pop( $open_transactions );
 118                         $trans->rollbackTransaction();
 119                 }
 120
 121                 if ( $exception ) {
 122                         throw $exception; // rethrow after cleanup
 123                 }
 124         }
 125
 126 }