<?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
* @ingroup Maintenance
* @defgroup Maintenance Maintenance
$maintClass = false;
// Make sure we're on PHP5 or better
-if ( version_compare( PHP_VERSION, '5.0.0' ) < 0 ) {
- die ( "Sorry! This version of MediaWiki requires PHP 5; you are running " .
+if ( version_compare( PHP_VERSION, '5.1.0' ) < 0 ) {
+ die ( "Sorry! This version of MediaWiki requires PHP 5.1.x; you are running " .
PHP_VERSION . ".\n\n" .
- "If you are sure you already have PHP 5 installed, it may be installed\n" .
- "in a different path from PHP 4. Check with your system administrator.\n" );
+ "If you are sure you already have PHP 5.1.x or higher installed, it may be\n" .
+ "installed in a different path from PHP " . PHP_VERSION . ". Check with your system\n" .
+ "administrator.\n" );
+}
+
+// Wrapper for posix_isatty()
+if ( !function_exists( 'posix_isatty' ) ) {
+ # We default as considering stdin a tty (for nice readline methods)
+ # but treating stout as not a tty to avoid color codes
+ function posix_isatty( $fd ) {
+ return !$fd;
+ }
}
/**
* is the execute() method. See docs/maintenance.txt for more info
* and a quick demo of how to use it.
*
- * 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
- *
* @author Chad Horohoe <chad@anyonecanedit.org>
* @since 1.16
* @ingroup Maintenance
protected static $mCoreScripts = null;
/**
- * Default constructor. Children should call this if implementing
+ * Default constructor. Children should call this *first* if implementing
* their own constructors
*/
public function __construct() {
+ // Setup $IP, using MW_INSTALL_PATH if it exists
+ global $IP;
+ $IP = strval( getenv( 'MW_INSTALL_PATH' ) ) !== ''
+ ? getenv( 'MW_INSTALL_PATH' )
+ : realpath( dirname( __FILE__ ) . '/..' );
+
$this->addDefaultParams();
register_shutdown_function( array( $this, 'outputChanneled' ), false );
}
return rtrim( $input );
}
+ public function isQuiet() {
+ return $this->mQuiet;
+ }
+
/**
* Throw some output to the user. Scripts can call this with no fears,
* as we handle all --quiet stuff here
$this->addOption( 'conf', 'Location of LocalSettings.php, if not default', false, true );
$this->addOption( 'wiki', 'For specifying the wiki ID', false, true );
$this->addOption( 'globals', 'Output globals at the end of processing for debugging' );
+ $this->addOption( 'memory-limit', 'Set a specific memory limit for the script, "max" for no limit or "default" to avoid changing it' );
+ $this->addOption( 'server', "The protocol and server name to use in URLs, e.g. " .
+ "http://en.wikipedia.org. This is sometimes necessary because " .
+ "server name detection may fail in command line scripts.", false, true );
// If we support a DB, show the options
if ( $this->getDbType() > 0 ) {
$this->addOption( 'dbuser', 'The DB user to use for this script', false, true );
* @param $classFile String: full path of where the child is
* @return Maintenance child
*/
- protected function runChild( $maintClass, $classFile = null ) {
+ public function runChild( $maintClass, $classFile = null ) {
// If we haven't already specified, kill setup procedures
// for child scripts, we've already got a sane environment
self::disableSetup();
* Do some sanity checking and basic setup
*/
public function setup() {
- global $IP, $wgCommandLineMode, $wgRequestTime;
+ global $wgCommandLineMode, $wgRequestTime;
# Abort if called from a web server
- if ( isset( $_SERVER ) && array_key_exists( 'REQUEST_METHOD', $_SERVER ) ) {
+ if ( isset( $_SERVER ) && isset( $_SERVER['REQUEST_METHOD'] ) ) {
$this->error( 'This script must be run from the command line', true );
}
// command-line mode is on, regardless of PHP version.
}
+ $this->loadParamsAndArgs();
+ $this->maybeHelp();
+
# Set the memory limit
# Note we need to set it again later in cache LocalSettings changed it
- ini_set( 'memory_limit', $this->memoryLimit() );
+ $this->adjustMemoryLimit();
# Set max execution time to 0 (no limit). PHP.net says that
# "When running PHP from the command line the default setting is 0."
# Define us as being in MediaWiki
define( 'MEDIAWIKI', true );
- # Setup $IP, using MW_INSTALL_PATH if it exists
- $IP = strval( getenv( 'MW_INSTALL_PATH' ) ) !== ''
- ? getenv( 'MW_INSTALL_PATH' )
- : realpath( dirname( __FILE__ ) . '/..' );
-
$wgCommandLineMode = true;
# Turn off output buffering if it's on
@ob_end_flush();
- $this->loadParamsAndArgs();
- $this->maybeHelp();
$this->validateParamsAndArgs();
}
/**
* Normally we disable the memory_limit when running admin scripts.
* Some scripts may wish to actually set a limit, however, to avoid
- * blowing up unexpectedly.
+ * blowing up unexpectedly. We also support a --memory-limit option,
+ * to allow sysadmins to explicitly set one if they'd prefer to override
+ * defaults (or for people using Suhosin which yells at you for trying
+ * to disable the limits)
*/
public function memoryLimit() {
- return -1;
+ $limit = $this->getOption( 'memory-limit', 'max' );
+ $limit = trim( $limit, "\" '" ); // trim quotes in case someone misunderstood
+ return $limit;
+ }
+
+ /**
+ * Adjusts PHP's memory limit to better suit our needs, if needed.
+ */
+ protected function adjustMemoryLimit() {
+ $limit = $this->memoryLimit();
+ if ( $limit == 'max' ) {
+ $limit = -1; // no memory limit
+ }
+ if ( $limit != 'default' ) {
+ ini_set( 'memory_limit', $limit );
+ }
}
/**
* @param $force boolean Whether to force the help to show, default false
*/
protected function maybeHelp( $force = false ) {
+ if( !$force && !$this->hasOption( 'help' ) ) {
+ return;
+ }
+
$screenWidth = 80; // TODO: Caculate this!
$tab = " ";
$descWidth = $screenWidth - ( 2 * strlen( $tab ) );
ksort( $this->mParams );
- if ( $this->hasOption( 'help' ) || $force ) {
- $this->mQuiet = false;
+ $this->mQuiet = false;
- if ( $this->mDescription ) {
- $this->output( "\n" . $this->mDescription . "\n" );
- }
- $output = "\nUsage: php " . basename( $this->mSelf );
- if ( $this->mParams ) {
- $output .= " [--" . implode( array_keys( $this->mParams ), "|--" ) . "]";
- }
- if ( $this->mArgList ) {
- $output .= " <";
- foreach ( $this->mArgList as $k => $arg ) {
- $output .= $arg['name'] . ">";
- if ( $k < count( $this->mArgList ) - 1 )
- $output .= " <";
+ // Description ...
+ if ( $this->mDescription ) {
+ $this->output( "\n" . $this->mDescription . "\n" );
+ }
+ $output = "\nUsage: php " . basename( $this->mSelf );
+
+ // ... append parameters ...
+ if ( $this->mParams ) {
+ $output .= " [--" . implode( array_keys( $this->mParams ), "|--" ) . "]";
+ }
+
+ // ... and append arguments.
+ if ( $this->mArgList ) {
+ $output .= ' ';
+ foreach ( $this->mArgList as $k => $arg ) {
+ if ( $arg['require'] ) {
+ $output .= '<' . $arg['name'] . '>';
+ } else {
+ $output .= '[' . $arg['name'] . ']';
}
+ if ( $k < count( $this->mArgList ) - 1 )
+ $output .= ' ';
}
- $this->output( "$output\n" );
- foreach ( $this->mParams as $par => $info ) {
- $this->output(
- wordwrap( "$tab$par : " . $info['desc'], $descWidth,
- "\n$tab$tab" ) . "\n"
- );
- }
- foreach ( $this->mArgList as $info ) {
- $this->output(
- wordwrap( "$tab<" . $info['name'] . "> : " .
- $info['desc'], $descWidth, "\n$tab$tab" ) . "\n"
- );
- }
- die( 1 );
}
+ $this->output( "$output\n\n" );
+
+ // Parameters description
+ foreach ( $this->mParams as $par => $info ) {
+ $this->output(
+ wordwrap( "$tab--$par: " . $info['desc'], $descWidth,
+ "\n$tab$tab" ) . "\n"
+ );
+ }
+
+ // Arguments description
+ foreach ( $this->mArgList as $info ) {
+ $openChar = $info['require'] ? '<' : '[';
+ $closeChar = $info['require'] ? '>' : ']';
+ $this->output(
+ wordwrap( "$tab$openChar" . $info['name'] . "$closeChar: " .
+ $info['desc'], $descWidth, "\n$tab$tab" ) . "\n"
+ );
+ }
+
+ die( 1 );
}
/**
* Handle some last-minute setup here.
*/
public function finalSetup() {
- global $wgCommandLineMode, $wgShowSQLErrors;
+ global $wgCommandLineMode, $wgShowSQLErrors, $wgServer;
global $wgProfiling, $wgDBadminuser, $wgDBadminpassword;
global $wgDBuser, $wgDBpassword, $wgDBservers, $wgLBFactoryConf;
# Same with these
$wgCommandLineMode = true;
+ # Override $wgServer
+ if( $this->hasOption( 'server') ) {
+ $wgServer = $this->getOption( 'server', $wgServer );
+ }
+
# If these were passed, use them
if ( $this->mDbUser ) {
$wgDBadminuser = $this->mDbUser;
$wgLBFactoryConf['serverTemplate']['user'] = $wgDBuser;
$wgLBFactoryConf['serverTemplate']['password'] = $wgDBpassword;
}
+ LBFactory::destroyInstance();
}
- if ( defined( 'MW_CMDLINE_CALLBACK' ) ) {
- $fn = MW_CMDLINE_CALLBACK;
- $fn();
- }
+ $this->afterFinalSetup();
$wgShowSQLErrors = true;
@set_time_limit( 0 );
- ini_set( 'memory_limit', $this->memoryLimit() );
+ $this->adjustMemoryLimit();
$wgProfiling = false; // only for Profiler.php mode; avoids OOM errors
}
+ /**
+ * Execute a callback function at the end of initialisation
+ */
+ protected function afterFinalSetup() {
+ if ( defined( 'MW_CMDLINE_CALLBACK' ) ) {
+ call_user_func( MW_CMDLINE_CALLBACK );
+ }
+ }
+
/**
* Potentially debug globals. Originally a feature only
* for refreshLinks
$wgWikiFarm = false;
if ( isset( $this->mOptions['conf'] ) ) {
$settingsFile = $this->mOptions['conf'];
+ } else if ( defined("MW_CONFIG_FILE") ) {
+ $settingsFile = MW_CONFIG_FILE;
} else {
$settingsFile = "$IP/LocalSettings.php";
}
if ( !is_readable( $settingsFile ) ) {
$this->error( "A copy of your installation's LocalSettings.php\n" .
- "must exist and be readable in the source directory.", true );
+ "must exist and be readable in the source directory.\n" .
+ "Use --conf to specify it." , true );
}
$wgCommandLineMode = true;
return $settingsFile;
return $title;
}
+ /**
+ * Prompt the console for input
+ * @param $prompt String what to begin the line with, like '> '
+ * @return String response
+ */
+ public static function readconsole( $prompt = '> ' ) {
+ static $isatty = null;
+ if ( is_null( $isatty ) ) {
+ $isatty = posix_isatty( 0 /*STDIN*/ );
+ }
+
+ if ( $isatty && function_exists( 'readline' ) ) {
+ return readline( $prompt );
+ } else {
+ if ( $isatty ) {
+ $st = self::readlineEmulation( $prompt );
+ } else {
+ if ( feof( STDIN ) ) {
+ $st = false;
+ } else {
+ $st = fgets( STDIN, 1024 );
+ }
+ }
+ if ( $st === false ) return false;
+ $resp = trim( $st );
+ return $resp;
+ }
+ }
+
+ /**
+ * Emulate readline()
+ * @param $prompt String what to begin the line with, like '> '
+ * @return String
+ */
+ private static function readlineEmulation( $prompt ) {
+ $bash = Installer::locateExecutableInDefaultPaths( array( '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 );
+
+ if ( $retval == 0 ) {
+ return $line;
+ } elseif ( $retval == 127 ) {
+ // Couldn't execute bash even though we thought we saw it.
+ // Shell probably spit out an error message, sorry :(
+ // Fall through to fgets()...
+ } else {
+ // EOF/ctrl+D
+ return false;
+ }
+ }
+
+ // Fallback... we'll have no editing controls, EWWW
+ if ( feof( STDIN ) ) {
+ return false;
+ }
+ print $prompt;
+ return fgets( STDIN, 1024 );
+ }
+}
+
+class FakeMaintenance extends Maintenance {
+ protected $mSelf = "FakeMaintenanceScript";
+ public function execute() {
+ return;
+ }
}
+
dépôts / lhc / web / wiklou.git / blobdiff