includes/db/DatabaseMysql.php

   1 <?php
   2 /**
   3  * This is the MySQL database abstraction layer.
   4  *
   5  * @file
   6  * @ingroup Database
   7  */
   8
   9 /**
  10  * Database abstraction object for mySQL
  11  * Inherit all methods and properties of Database::Database()
  12  *
  13  * @ingroup Database
  14  * @see Database
  15  */
  16 class DatabaseMysql extends DatabaseBase {
  17         function getType() {
  18                 return 'mysql';
  19         }
  20
  21         /*private*/ function doQuery( $sql ) {
  22                 if( $this->bufferResults() ) {
  23                         $ret = mysql_query( $sql, $this->mConn );
  24                 } else {
  25                         $ret = mysql_unbuffered_query( $sql, $this->mConn );
  26                 }
  27                 return $ret;
  28         }
  29
  30         function open( $server, $user, $password, $dbName ) {
  31                 global $wgAllDBsAreLocalhost;
  32                 wfProfileIn( __METHOD__ );
  33
  34                 # Test for missing mysql.so
  35                 # First try to load it
  36                 wfDl( 'mysql' );
  37
  38                 # Fail now
  39                 # Otherwise we get a suppressed fatal error, which is very hard to track down
  40                 if ( !function_exists( 'mysql_connect' ) ) {
  41                         throw new DBConnectionError( $this, "MySQL functions missing, have you compiled PHP with the --with-mysql option?\n" );
  42                 }
  43
  44                 # Debugging hack -- fake cluster
  45                 if ( $wgAllDBsAreLocalhost ) {
  46                         $realServer = 'localhost';
  47                 } else {
  48                         $realServer = $server;
  49                 }
  50                 $this->close();
  51                 $this->mServer = $server;
  52                 $this->mUser = $user;
  53                 $this->mPassword = $password;
  54                 $this->mDBname = $dbName;
  55
  56                 $success = false;
  57
  58                 wfProfileIn("dbconnect-$server");
  59
  60                 # The kernel's default SYN retransmission period is far too slow for us,
  61                 # so we use a short timeout plus a manual retry. Retrying means that a small
  62                 # but finite rate of SYN packet loss won't cause user-visible errors.
  63                 $this->mConn = false;
  64                 if ( ini_get( 'mysql.connect_timeout' ) <= 3 ) {
  65                         $numAttempts = 2;
  66                 } else {
  67                         $numAttempts = 1;
  68                 }
  69                 $this->installErrorHandler();
  70                 for ( $i = 0; $i < $numAttempts && !$this->mConn; $i++ ) {
  71                         if ( $i > 1 ) {
  72                                 usleep( 1000 );
  73                         }
  74                         if ( $this->mFlags & DBO_PERSISTENT ) {
  75                                 $this->mConn = mysql_pconnect( $realServer, $user, $password );
  76                         } else {
  77                                 # Create a new connection...
  78                                 $this->mConn = mysql_connect( $realServer, $user, $password, true );
  79                         }
  80                         if ($this->mConn === false) {
  81                                 #$iplus = $i + 1;
  82                                 #wfLogDBError("Connect loop error $iplus of $max ($server): " . mysql_errno() . " - " . mysql_error()."\n");
  83                         }
  84                 }
  85                 $phpError = $this->restoreErrorHandler();
  86                 # Always log connection errors
  87                 if ( !$this->mConn ) {
  88                         $error = $this->lastError();
  89                         if ( !$error ) {
  90                                 $error = $phpError;
  91                         }
  92                         wfLogDBError( "Error connecting to {$this->mServer}: $error\n" );
  93                         wfDebug( "DB connection error\n" );
  94                         wfDebug( "Server: $server, User: $user, Password: " .
  95                                 substr( $password, 0, 3 ) . "..., error: " . mysql_error() . "\n" );
  96                         $success = false;
  97                 }
  98
  99                 wfProfileOut("dbconnect-$server");
 100
 101                 if ( $dbName != '' && $this->mConn !== false ) {
 102                         $success = @/**/mysql_select_db( $dbName, $this->mConn );
 103                         if ( !$success ) {
 104                                 $error = "Error selecting database $dbName on server {$this->mServer} " .
 105                                         "from client host " . wfHostname() . "\n";
 106                                 wfLogDBError(" Error selecting database $dbName on server {$this->mServer} \n");
 107                                 wfDebug( $error );
 108                         }
 109                 } else {
 110                         # Delay USE query
 111                         $success = (bool)$this->mConn;
 112                 }
 113
 114                 if ( $success ) {
 115                         $version = $this->getServerVersion();
 116                         if ( version_compare( $version, '4.1' ) >= 0 ) {
 117                                 // Tell the server we're communicating with it in UTF-8.
 118                                 // This may engage various charset conversions.
 119                                 global $wgDBmysql5;
 120                                 if( $wgDBmysql5 ) {
 121                                         $this->query( 'SET NAMES utf8', __METHOD__ );
 122                                 } else {
 123                                         $this->query( 'SET NAMES binary', __METHOD__ );
 124                                 }
 125                                 // Set SQL mode, default is turning them all off, can be overridden or skipped with null
 126                                 global $wgSQLMode;
 127                                 if ( is_string( $wgSQLMode ) ) {
 128                                         $mode = $this->addQuotes( $wgSQLMode );
 129                                         $this->query( "SET sql_mode = $mode", __METHOD__ );
 130                                 }
 131                         }
 132
 133                         // Turn off strict mode if it is on
 134                 } else {
 135                         $this->reportConnectionError( $phpError );
 136                 }
 137
 138                 $this->mOpened = $success;
 139                 wfProfileOut( __METHOD__ );
 140                 return $success;
 141         }
 142
 143         function close() {
 144                 $this->mOpened = false;
 145                 if ( $this->mConn ) {
 146                         if ( $this->trxLevel() ) {
 147                                 $this->commit();
 148                         }
 149                         return mysql_close( $this->mConn );
 150                 } else {
 151                         return true;
 152                 }
 153         }
 154
 155         function freeResult( $res ) {
 156                 if ( $res instanceof ResultWrapper ) {
 157                         $res = $res->result;
 158                 }
 159                 if ( !@/**/mysql_free_result( $res ) ) {
 160                         throw new DBUnexpectedError( $this, "Unable to free MySQL result" );
 161                 }
 162         }
 163
 164         function fetchObject( $res ) {
 165                 if ( $res instanceof ResultWrapper ) {
 166                         $res = $res->result;
 167                 }
 168                 @/**/$row = mysql_fetch_object( $res );
 169                 if( $this->lastErrno() ) {
 170                         throw new DBUnexpectedError( $this, 'Error in fetchObject(): ' . htmlspecialchars( $this->lastError() ) );
 171                 }
 172                 return $row;
 173         }
 174
 175         function fetchRow( $res ) {
 176                 if ( $res instanceof ResultWrapper ) {
 177                         $res = $res->result;
 178                 }
 179                 @/**/$row = mysql_fetch_array( $res );
 180                 if ( $this->lastErrno() ) {
 181                         throw new DBUnexpectedError( $this, 'Error in fetchRow(): ' . htmlspecialchars( $this->lastError() ) );
 182                 }
 183                 return $row;
 184         }
 185
 186         function numRows( $res ) {
 187                 if ( $res instanceof ResultWrapper ) {
 188                         $res = $res->result;
 189                 }
 190                 @/**/$n = mysql_num_rows( $res );
 191                 if( $this->lastErrno() ) {
 192                         throw new DBUnexpectedError( $this, 'Error in numRows(): ' . htmlspecialchars( $this->lastError() ) );
 193                 }
 194                 return $n;
 195         }
 196
 197         function numFields( $res ) {
 198                 if ( $res instanceof ResultWrapper ) {
 199                         $res = $res->result;
 200                 }
 201                 return mysql_num_fields( $res );
 202         }
 203
 204         function fieldName( $res, $n ) {
 205                 if ( $res instanceof ResultWrapper ) {
 206                         $res = $res->result;
 207                 }
 208                 return mysql_field_name( $res, $n );
 209         }
 210
 211         function insertId() { return mysql_insert_id( $this->mConn ); }
 212
 213         function dataSeek( $res, $row ) {
 214                 if ( $res instanceof ResultWrapper ) {
 215                         $res = $res->result;
 216                 }
 217                 return mysql_data_seek( $res, $row );
 218         }
 219
 220         function lastErrno() {
 221                 if ( $this->mConn ) {
 222                         return mysql_errno( $this->mConn );
 223                 } else {
 224                         return mysql_errno();
 225                 }
 226         }
 227
 228         function lastError() {
 229                 if ( $this->mConn ) {
 230                         # Even if it's non-zero, it can still be invalid
 231                         wfSuppressWarnings();
 232                         $error = mysql_error( $this->mConn );
 233                         if ( !$error ) {
 234                                 $error = mysql_error();
 235                         }
 236                         wfRestoreWarnings();
 237                 } else {
 238                         $error = mysql_error();
 239                 }
 240                 if( $error ) {
 241                         $error .= ' (' . $this->mServer . ')';
 242                 }
 243                 return $error;
 244         }
 245
 246         function affectedRows() { return mysql_affected_rows( $this->mConn ); }
 247
 248         /**
 249          * Estimate rows in dataset
 250          * Returns estimated count, based on EXPLAIN output
 251          * Takes same arguments as Database::select()
 252          */
 253         public function estimateRowCount( $table, $vars='*', $conds='', $fname = 'Database::estimateRowCount', $options = array() ) {
 254                 $options['EXPLAIN'] = true;
 255                 $res = $this->select( $table, $vars, $conds, $fname, $options );
 256                 if ( $res === false )
 257                         return false;
 258                 if ( !$this->numRows( $res ) ) {
 259                         return 0;
 260                 }
 261
 262                 $rows = 1;
 263                 while( $plan = $this->fetchObject( $res ) ) {
 264                         $rows *= $plan->rows > 0 ? $plan->rows : 1; // avoid resetting to zero
 265                 }
 266                 return $rows;
 267         }
 268
 269         function fieldInfo( $table, $field ) {
 270                 $table = $this->tableName( $table );
 271                 $res = $this->query( "SELECT * FROM $table LIMIT 1", __METHOD__, true );
 272                 if ( !$res ) {
 273                         return false;
 274                 }
 275                 $n = mysql_num_fields( $res->result );
 276                 for( $i = 0; $i < $n; $i++ ) {
 277                         $meta = mysql_fetch_field( $res->result, $i );
 278                         if( $field == $meta->name ) {
 279                                 return new MySQLField($meta);
 280                         }
 281                 }
 282                 return false;
 283         }
 284
 285         function selectDB( $db ) {
 286                 $this->mDBname = $db;
 287                 return mysql_select_db( $db, $this->mConn );
 288         }
 289
 290         function strencode( $s ) {
 291                 $sQuoted = mysql_real_escape_string( $s, $this->mConn );
 292
 293                 if($sQuoted === false) {
 294                         $this->ping();
 295                         $sQuoted = mysql_real_escape_string( $s, $this->mConn );
 296                 }
 297                 return $sQuoted;
 298         }
 299
 300         function ping() {
 301                 $ping = mysql_ping( $this->mConn );
 302                 if ( $ping ) {
 303                         return true;
 304                 }
 305
 306                 mysql_close( $this->mConn );
 307                 $this->mOpened = false;
 308                 $this->mConn = false;
 309                 $this->open( $this->mServer, $this->mUser, $this->mPassword, $this->mDBname );
 310                 return true;
 311         }
 312
 313         /**
 314          * Returns slave lag.
 315          * At the moment, this will only work if the DB user has the PROCESS privilege
 316          * @result int
 317          */
 318         function getLag() {
 319                 if ( !is_null( $this->mFakeSlaveLag ) ) {
 320                         wfDebug( "getLag: fake slave lagged {$this->mFakeSlaveLag} seconds\n" );
 321                         return $this->mFakeSlaveLag;
 322                 }
 323                 $res = $this->query( 'SHOW PROCESSLIST', __METHOD__ );
 324                 # Find slave SQL thread
 325                 while ( $row = $this->fetchObject( $res ) ) {
 326                         /* This should work for most situations - when default db
 327                          * for thread is not specified, it had no events executed,
 328                          * and therefore it doesn't know yet how lagged it is.
 329                          *
 330                          * Relay log I/O thread does not select databases.
 331                          */
 332                         if ( $row->User == 'system user' &&
 333                                 $row->State != 'Waiting for master to send event' &&
 334                                 $row->State != 'Connecting to master' &&
 335                                 $row->State != 'Queueing master event to the relay log' &&
 336                                 $row->State != 'Waiting for master update' &&
 337                                 $row->State != 'Requesting binlog dump' &&
 338                                 $row->State != 'Waiting to reconnect after a failed master event read' &&
 339                                 $row->State != 'Reconnecting after a failed master event read' &&
 340                                 $row->State != 'Registering slave on master'
 341                                 ) {
 342                                 # This is it, return the time (except -ve)
 343                                 if ( $row->Time > 0x7fffffff ) {
 344                                         return false;
 345                                 } else {
 346                                         return $row->Time;
 347                                 }
 348                         }
 349                 }
 350                 return false;
 351         }
 352
 353         function getServerVersion() {
 354                 return mysql_get_server_info( $this->mConn );
 355         }
 356
 357         function useIndexClause( $index ) {
 358                 return "FORCE INDEX (" . $this->indexName( $index ) . ")";
 359         }
 360
 361         function lowPriorityOption() {
 362                 return 'LOW_PRIORITY';
 363         }
 364
 365         function getSoftwareLink() {
 366                 return '[http://www.mysql.com/ MySQL]';
 367         }
 368
 369         function standardSelectDistinct() {
 370                 return false;
 371         }
 372
 373         public function setTimeout( $timeout ) {
 374                 $this->query( "SET net_read_timeout=$timeout" );
 375                 $this->query( "SET net_write_timeout=$timeout" );
 376         }
 377
 378         public function lock( $lockName, $method, $timeout = 5 ) {
 379                 $lockName = $this->addQuotes( $lockName );
 380                 $result = $this->query( "SELECT GET_LOCK($lockName, $timeout) AS lockstatus", $method );
 381                 $row = $this->fetchObject( $result );
 382
 383                 if( $row->lockstatus == 1 ) {
 384                         return true;
 385                 } else {
 386                         wfDebug( __METHOD__." failed to acquire lock\n" );
 387                         return false;
 388                 }
 389         }
 390
 391         /**
 392          * FROM MYSQL DOCS: http://dev.mysql.com/doc/refman/5.0/en/miscellaneous-functions.html#function_release-lock
 393          */
 394         public function unlock( $lockName, $method ) {
 395                 $lockName = $this->addQuotes( $lockName );
 396                 $result = $this->query( "SELECT RELEASE_LOCK($lockName) as lockstatus", $method );
 397                 $row = $this->fetchObject( $result );
 398                 return $row->lockstatus;
 399         }
 400
 401         public function lockTables( $read, $write, $method, $lowPriority = true ) {
 402                 $items = array();
 403
 404                 foreach( $write as $table ) {
 405                         $tbl = $this->tableName( $table ) .
 406                                         ( $lowPriority ? ' LOW_PRIORITY' : '' ) .
 407                                         ' WRITE';
 408                         $items[] = $tbl;
 409                 }
 410                 foreach( $read as $table ) {
 411                         $items[] = $this->tableName( $table ) . ' READ';
 412                 }
 413                 $sql = "LOCK TABLES " . implode( ',', $items );
 414                 $this->query( $sql, $method );
 415         }
 416
 417         public function unlockTables( $method ) {
 418                 $this->query( "UNLOCK TABLES", $method );
 419         }
 420
 421         /**
 422          * Get search engine class. All subclasses of this
 423          * need to implement this if they wish to use searching.
 424          *
 425          * @return String
 426          */
 427         public function getSearchEngine() {
 428                 return 'SearchMySQL';
 429         }
 430
 431         public function setBigSelects( $value = true ) {
 432                 if ( $value === 'default' ) {
 433                         if ( $this->mDefaultBigSelects === null ) {
 434                                 # Function hasn't been called before so it must already be set to the default
 435                                 return;
 436                         } else {
 437                                 $value = $this->mDefaultBigSelects;
 438                         }
 439                 } elseif ( $this->mDefaultBigSelects === null ) {
 440                         $this->mDefaultBigSelects = (bool)$this->selectField( false, '@@sql_big_selects' );
 441                 }
 442                 $encValue = $value ? '1' : '0';
 443                 $this->query( "SET sql_big_selects=$encValue", __METHOD__ );
 444         }
 445
 446
 447         /**
 448          * Determines if the last failure was due to a deadlock
 449          */
 450         function wasDeadlock() {
 451                 return $this->lastErrno() == 1213;
 452         }
 453
 454         /**
 455          * Determines if the last query error was something that should be dealt
 456          * with by pinging the connection and reissuing the query
 457          */
 458         function wasErrorReissuable() {
 459                 return $this->lastErrno() == 2013 || $this->lastErrno() == 2006;
 460         }
 461
 462         /**
 463          * Determines if the last failure was due to the database being read-only.
 464          */
 465         function wasReadOnlyError() {
 466                 return $this->lastErrno() == 1223 ||
 467                         ( $this->lastErrno() == 1290 && strpos( $this->lastError(), '--read-only' ) !== false );
 468         }
 469
 470         function duplicateTableStructure( $oldName, $newName, $temporary = false, $fname = 'DatabaseMysql::duplicateTableStructure' ) {
 471                 $tmp = $temporary ? 'TEMPORARY ' : '';
 472                 if ( strcmp( $this->getServerVersion(), '4.1' ) < 0 ) {
 473                         # Hack for MySQL versions < 4.1, which don't support
 474                         # "CREATE TABLE ... LIKE". Note that
 475                         # "CREATE TEMPORARY TABLE ... SELECT * FROM ... LIMIT 0"
 476                         # would not create the indexes we need....
 477                         #
 478                         # Note that we don't bother changing around the prefixes here be-
 479                         # cause we know we're using MySQL anyway.
 480
 481                         $res = $this->query( "SHOW CREATE TABLE $oldName" );
 482                         $row = $this->fetchRow( $res );
 483                         $oldQuery = $row[1];
 484                         $query = preg_replace( '/CREATE TABLE `(.*?)`/',
 485                                 "CREATE $tmp TABLE `$newName`", $oldQuery );
 486                         if ($oldQuery === $query) {
 487                                 # Couldn't do replacement
 488                                 throw new MWException( "could not create temporary table $newName" );
 489                         }
 490                 } else {
 491                         $query = "CREATE $tmp TABLE $newName (LIKE $oldName)";
 492                 }
 493                 $this->query( $query, $fname );
 494         }
 495
 496 }
 497
 498 /**
 499  * Legacy support: Database == DatabaseMysql
 500  */
 501 class Database extends DatabaseMysql {}
 502
 503 class MySQLMasterPos {
 504         var $file, $pos;
 505
 506         function __construct( $file, $pos ) {
 507                 $this->file = $file;
 508                 $this->pos = $pos;
 509         }
 510
 511         function __toString() {
 512                 return "{$this->file}/{$this->pos}";
 513         }
 514 }