123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206 |
- <?php
- /**
- * Send SQL queries from the specified file to the database, performing
- * variable replacement along the way.
- *
- * 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
- */
- require_once __DIR__ . '/Maintenance.php';
- use MediaWiki\MediaWikiServices;
- use Wikimedia\Rdbms\ResultWrapper;
- use Wikimedia\Rdbms\IDatabase;
- use Wikimedia\Rdbms\DBQueryError;
- /**
- * Maintenance script that sends SQL queries from the specified file to the database.
- *
- * @ingroup Maintenance
- */
- class MwSql extends Maintenance {
- public function __construct() {
- parent::__construct();
- $this->addDescription( 'Send SQL queries to a MediaWiki database. ' .
- 'Takes a file name containing SQL as argument or runs interactively.' );
- $this->addOption( 'query',
- 'Run a single query instead of running interactively', false, true );
- $this->addOption( 'json', 'Output the results as JSON instead of PHP objects' );
- $this->addOption( 'cluster', 'Use an external cluster by name', false, true );
- $this->addOption( 'wikidb',
- 'The database wiki ID to use if not the current one', false, true );
- $this->addOption( 'replicadb',
- 'Replica DB server to use instead of the master DB (can be "any")', false, true );
- }
- public function execute() {
- global $IP;
- // We wan't to allow "" for the wikidb, meaning don't call select_db()
- $wiki = $this->hasOption( 'wikidb' ) ? $this->getOption( 'wikidb' ) : false;
- // Get the appropriate load balancer (for this wiki)
- $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
- if ( $this->hasOption( 'cluster' ) ) {
- $lb = $lbFactory->getExternalLB( $this->getOption( 'cluster' ) );
- } else {
- $lb = $lbFactory->getMainLB( $wiki );
- }
- // Figure out which server to use
- $replicaDB = $this->getOption( 'replicadb', $this->getOption( 'slave', '' ) );
- if ( $replicaDB === 'any' ) {
- $index = DB_REPLICA;
- } elseif ( $replicaDB != '' ) {
- $index = null;
- $serverCount = $lb->getServerCount();
- for ( $i = 0; $i < $serverCount; ++$i ) {
- if ( $lb->getServerName( $i ) === $replicaDB ) {
- $index = $i;
- break;
- }
- }
- if ( $index === null ) {
- $this->fatalError( "No replica DB server configured with the name '$replicaDB'." );
- }
- } else {
- $index = DB_MASTER;
- }
- /** @var IDatabase $db DB handle for the appropriate cluster/wiki */
- $db = $lb->getConnection( $index, [], $wiki );
- if ( $replicaDB != '' && $db->getLBInfo( 'master' ) !== null ) {
- $this->fatalError( "The server selected ({$db->getServer()}) is not a replica DB." );
- }
- if ( $index === DB_MASTER ) {
- $updater = DatabaseUpdater::newForDB( $db, true, $this );
- $db->setSchemaVars( $updater->getSchemaVars() );
- }
- if ( $this->hasArg( 0 ) ) {
- $file = fopen( $this->getArg( 0 ), 'r' );
- if ( !$file ) {
- $this->fatalError( "Unable to open input file" );
- }
- $error = $db->sourceStream( $file, null, [ $this, 'sqlPrintResult' ] );
- if ( $error !== true ) {
- $this->fatalError( $error );
- } else {
- exit( 0 );
- }
- }
- if ( $this->hasOption( 'query' ) ) {
- $query = $this->getOption( 'query' );
- $this->sqlDoQuery( $db, $query, /* dieOnError */ true );
- wfWaitForSlaves();
- return;
- }
- if (
- function_exists( 'readline_add_history' ) &&
- Maintenance::posix_isatty( 0 /*STDIN*/ )
- ) {
- $historyFile = isset( $_ENV['HOME'] ) ?
- "{$_ENV['HOME']}/.mwsql_history" : "$IP/maintenance/.mwsql_history";
- readline_read_history( $historyFile );
- } else {
- $historyFile = null;
- }
- $wholeLine = '';
- $newPrompt = '> ';
- $prompt = $newPrompt;
- $doDie = !Maintenance::posix_isatty( 0 );
- while ( ( $line = Maintenance::readconsole( $prompt ) ) !== false ) {
- if ( !$line ) {
- # User simply pressed return key
- continue;
- }
- $done = $db->streamStatementEnd( $wholeLine, $line );
- $wholeLine .= $line;
- if ( !$done ) {
- $wholeLine .= ' ';
- $prompt = ' -> ';
- continue;
- }
- if ( $historyFile ) {
- # Delimiter is eated by streamStatementEnd, we add it
- # up in the history (T39020)
- readline_add_history( $wholeLine . ';' );
- readline_write_history( $historyFile );
- }
- $this->sqlDoQuery( $db, $wholeLine, $doDie );
- $prompt = $newPrompt;
- $wholeLine = '';
- }
- wfWaitForSlaves();
- }
- protected function sqlDoQuery( IDatabase $db, $line, $dieOnError ) {
- try {
- $res = $db->query( $line );
- $this->sqlPrintResult( $res, $db );
- } catch ( DBQueryError $e ) {
- if ( $dieOnError ) {
- $this->fatalError( $e );
- } else {
- $this->error( $e );
- }
- }
- }
- /**
- * Print the results, callback for $db->sourceStream()
- * @param ResultWrapper|bool $res
- * @param IDatabase $db
- */
- public function sqlPrintResult( $res, $db ) {
- if ( !$res ) {
- // Do nothing
- return;
- } elseif ( is_object( $res ) && $res->numRows() ) {
- $out = '';
- foreach ( $res as $row ) {
- $out .= print_r( $row, true );
- $rows[] = $row;
- }
- if ( $this->hasOption( 'json' ) ) {
- $out = json_encode( $rows, JSON_PRETTY_PRINT );
- }
- $this->output( $out . "\n" );
- } else {
- $affected = $db->affectedRows();
- $this->output( "Query OK, $affected row(s) affected\n" );
- }
- }
- /**
- * @return int DB_TYPE constant
- */
- public function getDbType() {
- return Maintenance::DB_ADMIN;
- }
- }
- $maintClass = MwSql::class;
- require_once RUN_MAINTENANCE_IF_MAIN;
|