const STDIN_ALL = 'all';
// This is the desired params
- protected $mParams = array();
+ protected $mParams = [];
// Array of mapping short parameters to long ones
- protected $mShortParamsMap = array();
+ protected $mShortParamsMap = [];
// Array of desired args
- protected $mArgList = array();
+ protected $mArgList = [];
// This is the list of options that were actually passed
- protected $mOptions = array();
+ protected $mOptions = [];
// This is the list of arguments that were actually passed
- protected $mArgs = array();
+ protected $mArgs = [];
// Name of the script currently running
protected $mSelf;
protected $mQuiet = false;
protected $mDbUser, $mDbPass;
- // A description of the script, children should change this
+ // A description of the script, children should change this via addDescription()
protected $mDescription = '';
// Have we already loaded our user input?
protected $mBatchSize = null;
// Generic options added by addDefaultParams()
- private $mGenericParameters = array();
+ private $mGenericParameters = [];
// Generic options which might or not be supported by the script
- private $mDependantParameters = array();
+ private $mDependantParameters = [];
/**
* Used by getDB() / setDB()
- * @var DatabaseBase
+ * @var IDatabase
*/
private $mDb = null;
+ /** @var float UNIX timestamp */
+ private $lastSlaveWait = 0.0;
+
/**
* Used when creating separate schema files.
* @var resource
private $config;
/**
- * Used to read the options in the order
- * they were passed. Useful for option
- * chaining. (Ex. dumpBackup.php)
+ * Used to read the options in the order they were passed.
+ * Useful for option chaining (Ex. dumpBackup.php). It will
+ * be an empty array if the options are passed in through
+ * loadParamsAndArgs( $self, $opts, $args ).
*
* This is an array of arrays where
- * 0 => the option and 1 => parameter value
+ * 0 => the option and 1 => parameter value.
*
* @var array
*/
- public $orderedOptions = array();
+ public $orderedOptions = [];
/**
* Default constructor. Children should call this *first* if implementing
: realpath( __DIR__ . '/..' );
$this->addDefaultParams();
- register_shutdown_function( array( $this, 'outputChanneled' ), false );
+ register_shutdown_function( [ $this, 'outputChanneled' ], false );
}
/**
if ( $bt[0]['class'] !== 'Maintenance' || $bt[0]['function'] !== 'shouldExecute' ) {
return false; // last call should be to this function
}
- $includeFuncs = array( 'require_once', 'require', 'include', 'include_once' );
+ $includeFuncs = [ 'require_once', 'require', 'include', 'include_once' ];
for ( $i = 1; $i < $count; $i++ ) {
if ( !in_array( $bt[$i]['function'], $includeFuncs ) ) {
return false; // previous calls should all be "requires"
protected function addOption( $name, $description, $required = false,
$withArg = false, $shortName = false, $multiOccurrence = false
) {
- $this->mParams[$name] = array(
+ $this->mParams[$name] = [
'desc' => $description,
'require' => $required,
'withArg' => $withArg,
'shortName' => $shortName,
'multiOccurrence' => $multiOccurrence
- );
+ ];
if ( $shortName !== false ) {
$this->mShortParamsMap[$shortName] = $name;
* @param bool $required Is this required?
*/
protected function addArg( $arg, $description, $required = true ) {
- $this->mArgList[] = array(
+ $this->mArgList[] = [
'name' => $arg,
'desc' => $description,
'require' => $required
- );
+ ];
}
/**
if ( is_array( $wgProfiler ) && isset( $wgProfiler['class'] ) ) {
$class = $wgProfiler['class'];
$profiler = new $class(
- array( 'sampling' => 1, 'output' => array( $output ) )
+ [ 'sampling' => 1, 'output' => [ $output ] ]
+ $wgProfiler
- + array( 'threshold' => $wgProfileLimit )
+ + [ 'threshold' => $wgProfileLimit ]
);
$profiler->setTemplated( true );
Profiler::replaceStubInstance( $profiler );
* Clear all params and arguments.
*/
public function clearParamsAndArgs() {
- $this->mOptions = array();
- $this->mArgs = array();
+ $this->mOptions = [];
+ $this->mArgs = [];
$this->mInputLoaded = false;
}
/**
- * Process command line arguments
- * $mOptions becomes an array with keys set to the option names
- * $mArgs becomes a zero-based array containing the non-option arguments
+ * Load params and arguments from a given array
+ * of command-line arguments
*
- * @param string $self The name of the script, if any
- * @param array $opts An array of options, in form of key=>value
- * @param array $args An array of command line arguments
+ * @since 1.27
+ * @param array $argv
*/
- public function loadParamsAndArgs( $self = null, $opts = null, $args = null ) {
- # If we were given opts or args, set those and return early
- if ( $self ) {
- $this->mSelf = $self;
- $this->mInputLoaded = true;
- }
- if ( $opts ) {
- $this->mOptions = $opts;
- $this->mInputLoaded = true;
- }
- if ( $args ) {
- $this->mArgs = $args;
- $this->mInputLoaded = true;
- }
-
- # If we've already loaded input (either by user values or from $argv)
- # skip on loading it again. The array_shift() will corrupt values if
- # it's run again and again
- if ( $this->mInputLoaded ) {
- $this->loadSpecialVars();
-
- return;
- }
-
- global $argv;
- $this->mSelf = array_shift( $argv );
-
- $options = array();
- $args = array();
- $this->orderedOptions = array();
+ public function loadWithArgv( $argv ) {
+ $options = [];
+ $args = [];
+ $this->orderedOptions = [];
# Parse arguments
for ( $arg = reset( $argv ); $arg !== false; $arg = next( $argv ) ) {
* @param mixed $value
*/
private function setParam( &$options, $option, $value ) {
- $this->orderedOptions[] = array( $option, $value );
+ $this->orderedOptions[] = [ $option, $value ];
if ( isset( $this->mParams[$option] ) ) {
$multi = $this->mParams[$option]['multiOccurrence'];
if ( $multi && $exists ) {
$options[$option][] = $value;
} elseif ( $multi ) {
- $options[$option] = array( $value );
+ $options[$option] = [ $value ];
} elseif ( !$exists ) {
$options[$option] = $value;
} else {
}
}
+ /**
+ * Process command line arguments
+ * $mOptions becomes an array with keys set to the option names
+ * $mArgs becomes a zero-based array containing the non-option arguments
+ *
+ * @param string $self The name of the script, if any
+ * @param array $opts An array of options, in form of key=>value
+ * @param array $args An array of command line arguments
+ */
+ public function loadParamsAndArgs( $self = null, $opts = null, $args = null ) {
+ # If we were given opts or args, set those and return early
+ if ( $self ) {
+ $this->mSelf = $self;
+ $this->mInputLoaded = true;
+ }
+ if ( $opts ) {
+ $this->mOptions = $opts;
+ $this->mInputLoaded = true;
+ }
+ if ( $args ) {
+ $this->mArgs = $args;
+ $this->mInputLoaded = true;
+ }
+
+ # If we've already loaded input (either by user values or from $argv)
+ # skip on loading it again. The array_shift() will corrupt values if
+ # it's run again and again
+ if ( $this->mInputLoaded ) {
+ $this->loadSpecialVars();
+
+ return;
+ }
+
+ global $argv;
+ $this->mSelf = $argv[0];
+ $this->loadWithArgv( array_slice( $argv, 1 ) );
+ }
+
/**
* Run some validation checks on the params, etc
*/
public function purgeRedundantText( $delete = true ) {
# Data should come off the master, wrapped in a transaction
$dbw = $this->getDB( DB_MASTER );
- $dbw->begin( __METHOD__ );
+ $this->beginTransaction( $dbw, __METHOD__ );
# Get "active" text records from the revisions table
$this->output( 'Searching for active text records in revisions table...' );
- $res = $dbw->select( 'revision', 'rev_text_id', array(), __METHOD__, array( 'DISTINCT' ) );
+ $res = $dbw->select( 'revision', 'rev_text_id', [], __METHOD__, [ 'DISTINCT' ] );
foreach ( $res as $row ) {
$cur[] = $row->rev_text_id;
}
# Get "active" text records from the archive table
$this->output( 'Searching for active text records in archive table...' );
- $res = $dbw->select( 'archive', 'ar_text_id', array(), __METHOD__, array( 'DISTINCT' ) );
+ $res = $dbw->select( 'archive', 'ar_text_id', [], __METHOD__, [ 'DISTINCT' ] );
foreach ( $res as $row ) {
# old pre-MW 1.5 records can have null ar_text_id's.
if ( $row->ar_text_id !== null ) {
# Get the IDs of all text records not in these sets
$this->output( 'Searching for inactive text records...' );
$cond = 'old_id NOT IN ( ' . $dbw->makeList( $cur ) . ' )';
- $res = $dbw->select( 'text', 'old_id', array( $cond ), __METHOD__, array( 'DISTINCT' ) );
- $old = array();
+ $res = $dbw->select( 'text', 'old_id', [ $cond ], __METHOD__, [ 'DISTINCT' ] );
+ $old = [];
foreach ( $res as $row ) {
$old[] = $row->old_id;
}
# Delete as appropriate
if ( $delete && $count ) {
$this->output( 'Deleting...' );
- $dbw->delete( 'text', array( 'old_id' => $old ), __METHOD__ );
+ $dbw->delete( 'text', [ 'old_id' => $old ], __METHOD__ );
$this->output( "done.\n" );
}
# Done
- $dbw->commit( __METHOD__ );
+ $this->commitTransaction( $dbw, __METHOD__ );
}
/**
* If not set, wfGetDB() will be used.
* This function has the same parameters as wfGetDB()
*
- * @return DatabaseBase
+ * @param integer $db DB index (DB_SLAVE/DB_MASTER)
+ * @param array $groups; default: empty array
+ * @param string|bool $wiki; default: current wiki
+ * @return IDatabase
*/
- protected function getDB( $db, $groups = array(), $wiki = false ) {
+ protected function getDB( $db, $groups = [], $wiki = false ) {
if ( is_null( $this->mDb ) ) {
return wfGetDB( $db, $groups, $wiki );
} else {
/**
* Sets database object to be returned by getDB().
*
- * @param DatabaseBase $db Database object to be used
+ * @param IDatabase $db Database object to be used
*/
- public function setDB( $db ) {
+ public function setDB( IDatabase $db ) {
$this->mDb = $db;
}
+ /**
+ * Begin a transcation on a DB
+ *
+ * This method makes it clear that begin() is called from a maintenance script,
+ * which has outermost scope. This is safe, unlike $dbw->begin() called in other places.
+ *
+ * @param IDatabase $dbw
+ * @param string $fname Caller name
+ * @since 1.27
+ */
+ protected function beginTransaction( IDatabase $dbw, $fname ) {
+ $dbw->begin( $fname );
+ }
+
+ /**
+ * Commit the transcation on a DB handle and wait for slaves to catch up
+ *
+ * This method makes it clear that commit() is called from a maintenance script,
+ * which has outermost scope. This is safe, unlike $dbw->commit() called in other places.
+ *
+ * @param IDatabase $dbw
+ * @param string $fname Caller name
+ * @return bool Whether the slave wait succeeded
+ * @since 1.27
+ */
+ protected function commitTransaction( IDatabase $dbw, $fname ) {
+ $dbw->commit( $fname );
+
+ $ok = wfWaitForSlaves( $this->lastSlaveWait, false, '*', 30 );
+ $this->lastSlaveWait = microtime( true );
+
+ return $ok;
+ }
+
+ /**
+ * Rollback the transcation on a DB handle
+ *
+ * This method makes it clear that rollback() is called from a maintenance script,
+ * which has outermost scope. This is safe, unlike $dbw->rollback() called in other places.
+ *
+ * @param IDatabase $dbw
+ * @param string $fname Caller name
+ * @since 1.27
+ */
+ protected function rollbackTransaction( IDatabase $dbw, $fname ) {
+ $dbw->rollback( $fname );
+ }
+
/**
* Lock the search index
* @param DatabaseBase &$db
*/
private function lockSearchindex( $db ) {
- $write = array( 'searchindex' );
- $read = array(
+ $write = [ 'searchindex' ];
+ $read = [
'page',
'revision',
'text',
'l10n_cache',
'user',
'page_restrictions'
- );
+ ];
$db->lockTables( $read, $write, __CLASS__ . '::' . __METHOD__ );
}
* @return string
*/
private static function readlineEmulation( $prompt ) {
- $bash = Installer::locateExecutableInDefaultPaths( array( 'bash' ) );
+ $bash = Installer::locateExecutableInDefaultPaths( [ 'bash' ] );
if ( !wfIsWindows() && $bash ) {
$retval = false;
$encPrompt = wfEscapeShellArg( $prompt );
$command = "read -er -p $encPrompt && echo \"\$REPLY\"";
$encCommand = wfEscapeShellArg( $command );
- $line = wfShellExec( "$bash -c $encCommand", $retval, array(), array( 'walltime' => 0 ) );
+ $line = wfShellExec( "$bash -c $encCommand", $retval, [], [ 'walltime' => 0 ] );
if ( $retval == 0 ) {
return $line;
$key = $this->getUpdateKey();
if ( !$this->hasOption( 'force' )
- && $db->selectRow( 'updatelog', '1', array( 'ul_key' => $key ), __METHOD__ )
+ && $db->selectRow( 'updatelog', '1', [ 'ul_key' => $key ], __METHOD__ )
) {
$this->output( "..." . $this->updateSkippedMessage() . "\n" );
return false;
}
- if ( $db->insert( 'updatelog', array( 'ul_key' => $key ), __METHOD__, 'IGNORE' ) ) {
+ if ( $db->insert( 'updatelog', [ 'ul_key' => $key ], __METHOD__, 'IGNORE' ) ) {
return true;
} else {
$this->output( $this->updatelogFailedMessage() . "\n" );
dépôts / lhc / web / wiklou.git / blobdiff