sql.php in interactive no more exit on DBerror
[lhc/web/wiklou.git] / maintenance / sql.php
index ab6546b..e8e8cb4 100644 (file)
  * 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 Database Maintenance
+ * @ingroup Maintenance
  */
 
-require_once( dirname(__FILE__) . '/' . 'commandLine.inc' );
+require_once( __DIR__ . '/Maintenance.php' );
 
-if ( isset( $options['help'] ) ) {
-       echo "Send SQL queries to a MediaWiki database.\nUsage: php sql.php [<file>]\n";
-       exit( 1 );
-}
+/**
+ * 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->mDescription = "Send SQL queries to a MediaWiki database";
+       }
 
-if ( isset( $args[0] ) ) {
-       $fileName = $args[0];
-       $file = fopen( $fileName, 'r' );
-       $promptCallback = false;
-} else {
-       $file = STDIN;
-       $promptObject = new SqlPromptPrinter( "> " );
-       $promptCallback = $promptObject->cb();
-}
+       public function execute() {
+               $dbw = wfGetDB( DB_MASTER );
+               if ( $this->hasArg() ) {
+                       $fileName = $this->getArg();
+                       $file = fopen( $fileName, 'r' );
+                       if ( !$file ) {
+                               $this->error( "Unable to open input file", true );
+                       }
 
-if ( !$file  ) {
-       echo "Unable to open input file\n";
-       exit( 1 );
-}
+                       $error = $dbw->sourceStream( $file, false, array( $this, 'sqlPrintResult' ) );
+                       if ( $error !== true ) {
+                               $this->error( $error, true );
+                       } else {
+                               exit( 0 );
+                       }
+               }
 
-$dbw =& wfGetDB( DB_MASTER );
-$error = $dbw->sourceStream( $file, $promptCallback, 'sqlPrintResult' );
-if ( $error !== true ) {
-       echo $error;
-       exit( 1 );
-} else {
-       exit( 0 );
-}
+               $useReadline = function_exists( 'readline_add_history' )
+                               && Maintenance::posix_isatty( 0 /*STDIN*/ );
 
-//-----------------------------------------------------------------------------
-class SqlPromptPrinter {
-       function __construct( $prompt ) {
-               $this->prompt = $prompt;
-       }
+               if ( $useReadline ) {
+                       global $IP;
+                       $historyFile = isset( $_ENV['HOME'] ) ?
+                                       "{$_ENV['HOME']}/.mwsql_history" : "$IP/maintenance/.mwsql_history";
+                       readline_read_history( $historyFile );
+               }
 
-       function cb() {
-               return array( $this, 'printPrompt' );
-       }
+               $wholeLine = '';
+               while ( ( $line = Maintenance::readconsole() ) !== false ) {
+                       $done = $dbw->streamStatementEnd( $wholeLine, $line );
+
+                       $wholeLine .= $line;
 
-       function printPrompt() {
-               echo $this->prompt;
+                       if ( !$done ) {
+                               continue;
+                       }
+                       if ( $useReadline ) {
+                               readline_add_history( $wholeLine );
+                               readline_write_history( $historyFile );
+                       }
+                       try{
+                               $res = $dbw->query( $wholeLine );
+                               $this->sqlPrintResult( $res, $dbw );
+                               $wholeLine = '';
+                       } catch (DBQueryError $e) {
+                               $doDie = ! Maintenance::posix_isatty( 0 );
+                               $this->error( $e, $doDie );
+                       }
+               }
        }
-}
 
-function sqlPrintResult( $res, $db ) {
-       if ( !$res ) {
-               // Do nothing
-       } elseif ( is_object( $res ) && $res->numRows() ) {
-               while ( $row = $res->fetchObject() ) {
-                       print_r( $row );
+       /**
+        * Print the results, callback for $db->sourceStream()
+        * @param $res ResultWrapper The results object
+        * @param $db DatabaseBase object
+        */
+       public function sqlPrintResult( $res, $db ) {
+               if ( !$res ) {
+                       // Do nothing
+               } elseif ( is_object( $res ) && $res->numRows() ) {
+                       foreach ( $res as $row ) {
+                               $this->output( print_r( $row, true ) );
+                       }
+               } else {
+                       $affected = $db->affectedRows();
+                       $this->output( "Query OK, $affected row(s) affected\n" );
                }
-       } else {
-               $affected = $db->affectedRows();
-               echo "Query OK, $affected row(s) affected\n";
        }
-}
 
+       /**
+        * @return int DB_TYPE constant
+        */
+       public function getDbType() {
+               return Maintenance::DB_ADMIN;
+       }
+}
 
+$maintClass = "MwSql";
+require_once( RUN_MAINTENANCE_IF_MAIN );