DataUpdate.php

Go to the documentation of this file.

<?php
abstract class DataUpdate implements DeferrableUpdate {
    public function __construct() {
        // noop
    }

    public function beginTransaction() {
        // noop
    }

    public function commitTransaction() {
        // noop
    }

    public function rollbackTransaction() {
        // noop
    }

    public static function runUpdates( array $updates, $mode = 'run' ) {
        if ( $mode === 'enqueue' ) {
            // When possible, push updates as jobs instead of calling doUpdate()
            $updates = self::enqueueUpdates( $updates );
        }

        if ( !count( $updates ) ) {
            return; // nothing to do
        }

        $open_transactions = [];
        $exception = null;

        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() . "\n" );
        }

        // rollback remaining transactions
        while ( count( $open_transactions ) > 0 ) {
            $trans = array_pop( $open_transactions );
            $trans->rollbackTransaction();
        }

        if ( $exception ) {
            throw $exception; // rethrow after cleanup
        }
    }

    protected static function enqueueUpdates( array $updates ) {
        $remaining = [];

        foreach ( $updates as $update ) {
            if ( $update instanceof EnqueueableDataUpdate ) {
                $spec = $update->getAsJobSpecification();
                JobQueueGroup::singleton( $spec['wiki'] )->push( $spec['job'] );
            } else {
                $remaining[] = $update;
            }
        }

        return $remaining;
    }
}

interface EnqueueableDataUpdate {
    public function getAsJobSpecification();
}