Page MenuHomeWickedGov Phorge
Files F4118498

LoggedUpdateMaintenance.php
No OneTemporary
Actions

Size
2 KB
Referenced Files
None
Subscribers
None

LoggedUpdateMaintenance.php
View Options

<?php
/**
* 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
*/
namespace MediaWiki\Maintenance;
/**
* Class for scripts that perform database maintenance and want to log the
* update in `updatelog` so we can later skip it
* @ingroup Maintenance
*/
abstract class LoggedUpdateMaintenance extends Maintenance {
public function __construct() {
parent::__construct();
$this->addOption( 'force', 'Run the update even if it was completed already' );
$this->setBatchSize( 200 );
}
/** @inheritDoc */
public function execute() {
$db = $this->getPrimaryDB();
$key = $this->getUpdateKey();
$queryBuilder = $db->newSelectQueryBuilder()
->select( '1' )
->from( 'updatelog' )
->where( [ 'ul_key' => $key ] );
if ( !$this->hasOption( 'force' )
&& $queryBuilder->caller( __METHOD__ )->fetchRow()
) {
$this->output( "..." . $this->updateSkippedMessage() . "\n" );
return true;
}
if ( !$this->doDBUpdates() ) {
return false;
}
$db->newInsertQueryBuilder()
->insertInto( 'updatelog' )
->ignore()
->row( [ 'ul_key' => $key ] )
->caller( __METHOD__ )->execute();
return true;
}
/**
* Sets whether a run of this maintenance script has the force parameter set
* @param bool $forced
*/
public function setForce( $forced = true ) {
$this->setOption( 'force', $forced );
}
/**
* Message to show that the update was done already and was just skipped
* @return string
*/
protected function updateSkippedMessage() {
$key = $this->getUpdateKey();
return "Update '{$key}' already logged as completed. Use --force to run it again.";
}
/**
* Do the actual work. All child classes will need to implement this.
* Return true to log the update as done or false (usually on failure).
* @return bool
*/
abstract protected function doDBUpdates();
/**
* Get the update key name to go in the update log table
* @return string
*/
abstract protected function getUpdateKey();
}
/** @deprecated class alias since 1.43 */
class_alias( LoggedUpdateMaintenance::class, 'LoggedUpdateMaintenance' );

File Metadata

Mime Type
text/x-php
Expires
Wed, Aug 19, 02:49 (2 w, 2 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
a7/73/cf65f2568332a41e73362f587b6f
Default Alt Text
LoggedUpdateMaintenance.php (2 KB)

Event Timeline