Maintenance script to wrap the mysql binary
authorTim Starling <tstarling@wikimedia.org>
Sun, 20 May 2018 14:50:41 +0000 (16:50 +0200)
committerTim Starling <tstarling@wikimedia.org>
Thu, 31 May 2018 05:42:51 +0000 (15:42 +1000)
This is more or less equivalent to the WMF shell script "sql", but it is
reasonably portable and written in a less hackish way.

Change-Id: I240d8d4e65ce46680cac257ee376a9b026c13f92

.phpcs.xml
autoload.php
includes/libs/rdbms/database/DatabaseMysqli.php
includes/libs/rdbms/loadbalancer/ILoadBalancer.php
includes/libs/rdbms/loadbalancer/LoadBalancer.php
maintenance/mysql.php [new file with mode: 0644]

index 14bb494..e52c3fd 100644 (file)
                <exclude-pattern>*/maintenance/language/date-formats\.php</exclude-pattern>
                <exclude-pattern>*/maintenance/language/languages.inc</exclude-pattern>
                <exclude-pattern>*/maintenance/minify\.php</exclude-pattern>
+               <exclude-pattern>*/maintenance/mysql\.php</exclude-pattern>
                <exclude-pattern>*/maintenance/parse\.php</exclude-pattern>
                <exclude-pattern>*/maintenance/preprocessorFuzzTest\.php</exclude-pattern>
                <exclude-pattern>*/maintenance/rebuildImages\.php</exclude-pattern>
index 77144df..f1b3ae0 100644 (file)
@@ -994,6 +994,7 @@ $wgAutoloadLocalClasses = [
        'MwSql' => __DIR__ . '/maintenance/sql.php',
        'MySqlLockManager' => __DIR__ . '/includes/filebackend/lockmanager/MySqlLockManager.php',
        'MysqlInstaller' => __DIR__ . '/includes/installer/MysqlInstaller.php',
+       'MysqlMaintenance' => __DIR__ . '/maintenance/mysql.php',
        'MysqlUpdater' => __DIR__ . '/includes/installer/MysqlUpdater.php',
        'NaiveForeignTitleFactory' => __DIR__ . '/includes/title/NaiveForeignTitleFactory.php',
        'NaiveImportTitleFactory' => __DIR__ . '/includes/title/NaiveImportTitleFactory.php',
index 31cdd7c..ec69b9d 100644 (file)
@@ -77,7 +77,7 @@ class DatabaseMysqli extends DatabaseMysqlBase {
                } elseif ( substr_count( $realServer, ':' ) == 1 ) {
                        // If we have a colon and something that's not a port number
                        // inside the hostname, assume it's the socket location
-                       $hostAndSocket = explode( ':', $realServer );
+                       $hostAndSocket = explode( ':', $realServer, 2 );
                        $realServer = $hostAndSocket[0];
                        $socket = $hostAndSocket[1];
                }
index 81ce4ba..04a553c 100644 (file)
@@ -332,6 +332,13 @@ interface ILoadBalancer {
         */
        public function getServerName( $i );
 
+       /**
+        * Return the server info structure for a given index, or false if the index is invalid.
+        * @param int $i
+        * @return array|bool
+        */
+       public function getServerInfo( $i );
+
        /**
         * Get DB type of the server with the specified index
         *
index eabcbbd..d5195ef 100644 (file)
@@ -1195,6 +1195,14 @@ class LoadBalancer implements ILoadBalancer {
                return ( $name != '' ) ? $name : 'localhost';
        }
 
+       public function getServerInfo( $i ) {
+               if ( isset( $this->servers[$i] ) ) {
+                       return $this->servers[$i];
+               } else {
+                       return false;
+               }
+       }
+
        public function getServerType( $i ) {
                return isset( $this->servers[$i]['type'] ) ? $this->servers[$i]['type'] : 'unknown';
        }
diff --git a/maintenance/mysql.php b/maintenance/mysql.php
new file mode 100644 (file)
index 0000000..6d0882a
--- /dev/null
@@ -0,0 +1,184 @@
+<?php
+/**
+ * Execute the MySQL client binary, connecting to the wiki's DB.
+ * Note that this will not do table prefixing or variable substitution.
+ * To safely run schema patches, use sql.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
+ */
+
+use MediaWiki\Shell\Shell;
+use MediaWiki\MediaWikiServices;
+
+require_once __DIR__ . '/Maintenance.php';
+
+/**
+ * @ingroup Maintenance
+ */
+class MysqlMaintenance extends Maintenance {
+       public function __construct() {
+               parent::__construct();
+               $this->addDescription( "Execute the MySQL client binary. " .
+                       "Non-option arguments will be passed through to mysql." );
+               $this->addOption( 'write', 'Connect to the master database', false, false );
+               $this->addOption( 'group', 'Specify query group', false, false );
+               $this->addOption( 'host', 'Connect to a specific MySQL server', false, true );
+               $this->addOption( 'list-hosts', 'List the available DB hosts', false, false );
+               $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 );
+
+               // Fake argument for help message
+               $this->addArg( '-- mysql_option ...', 'Options to pass to mysql', false );
+       }
+
+       public function execute() {
+               $dbName = $this->getOption( 'wikidb', false );
+               $lbf = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
+               if ( $this->hasOption( 'cluster' ) ) {
+                       try {
+                               $lb = $lbf->getExternalLB( $this->getOption( 'cluster' ) );
+                       } catch ( InvalidArgumentException $e ) {
+                               $this->error( "Error: invalid cluster" );
+                               exit( 1 );
+                       }
+               } else {
+                       $lb = $lbf->getMainLB( $dbName );
+               }
+               if ( $this->hasOption( 'list-hosts' ) ) {
+                       $serverCount = $lb->getServerCount();
+                       for ( $index = 0; $index < $serverCount; ++$index ) {
+                               echo $lb->getServerName( $index ) . "\n";
+                       }
+                       exit( 0 );
+               }
+               if ( $this->hasOption( 'host' ) ) {
+                       $host = $this->getOption( 'host' );
+                       $serverCount = $lb->getServerCount();
+                       for ( $index = 0; $index < $serverCount; ++$index ) {
+                               $serverInfo = $lb->getServerInfo( $index );
+
+                               if ( $lb->getServerName( $index ) === $host ) {
+                                       break;
+                               }
+                       }
+                       if ( $index >= $serverCount ) {
+                               $this->error( "Error: Host not configured: \"$host\"" );
+                               exit( 1 );
+                       }
+               } elseif ( $this->hasOption( 'write' ) ) {
+                       $index = $lb->getWriterIndex();
+               } else {
+                       $group = $this->getOption( 'group', false );
+                       $index = $lb->getReaderIndex( $group, $dbName );
+                       if ( $index === false ) {
+                               $this->error( "Error: unable to get reader index" );
+                               exit( 1 );
+                       }
+               }
+
+               if ( $lb->getServerType( $index ) !== 'mysql' ) {
+                       $this->error( "Error: this script only works with MySQL/MariaDB" );
+                       exit( 1 );
+               }
+
+               $status = $this->runMysql( $lb->getServerInfo( $index ), $dbName );
+               exit( $status );
+       }
+
+       /**
+        * Run the mysql client for the given server info
+        *
+        * @param array $info
+        * @param string|false The DB name, or false to use the main wiki DB
+        *
+        * @return The desired exit status
+        */
+       private function runMysql( $info, $dbName ) {
+               // Write the password to an option file to avoid disclosing it to other
+               // processes running on the system
+               $tmpFile = TempFSFile::factory( 'mw-mysql', 'ini' );
+               chmod( $tmpFile->getPath(), 0600 );
+               file_put_contents( $tmpFile->getPath(), "[client]\npassword={$info['password']}\n" );
+
+               // stdin/stdout need to be the actual file descriptors rather than
+               // PHP's pipe wrappers so that mysql can use them as an interactive
+               // terminal.
+               $desc = [
+                       0 => STDIN,
+                       1 => STDOUT,
+                       2 => STDERR,
+               ];
+
+               // Split host and port as in DatabaseMysqli::mysqlConnect()
+               $realServer = $info['host'];
+               $hostAndPort = IP::splitHostAndPort( $realServer );
+               $socket = false;
+               $port = false;
+               if ( $hostAndPort ) {
+                       $realServer = $hostAndPort[0];
+                       if ( $hostAndPort[1] ) {
+                               $port = $hostAndPort[1];
+                       }
+               } elseif ( substr_count( $realServer, ':' ) == 1 ) {
+                       // If we have a colon and something that's not a port number
+                       // inside the hostname, assume it's the socket location
+                       $hostAndSocket = explode( ':', $realServer, 2 );
+                       $realServer = $hostAndSocket[0];
+                       $socket = $hostAndSocket[1];
+               }
+
+               if ( $dbName === false ) {
+                       $dbName = $info['dbname'];
+               }
+
+               $args = [
+                       'mysql',
+                       "--defaults-extra-file={$tmpFile->getPath()}",
+                       "--user={$info['user']}",
+                       "--database={$dbName}",
+               ];
+               if ( $socket !== false ) {
+                       $args[] = "--socket={$socket}";
+               } else {
+                       $args[] = "--host={$realServer}";
+               }
+               if ( $port !== false ) {
+                       $args[] = "--port={$port}";
+               }
+
+               $args = array_merge( $args, $this->mArgs );
+
+               $pipes = [];
+               $proc = proc_open( Shell::escape( $args ), $desc, $pipes );
+               if ( $proc === false ) {
+                       $this->error( "Unable to execute mysql" );
+                       return 1;
+               }
+               $ret = proc_close( $proc );
+               if ( $ret === -1 ) {
+                       $this->error( "proc_close() returned -1" );
+                       return 1;
+               }
+               return $ret;
+       }
+}
+
+$maintClass = MysqlMaintenance::class;
+require_once RUN_MAINTENANCE_IF_MAIN;