includes/db/Database.php

   1 <?php
   2 /**
   3  * @defgroup Database Database
   4  *
   5  * This file deals with database interface functions
   6  * and query specifics/optimisations.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License along
  19  * with this program; if not, write to the Free Software Foundation, Inc.,
  20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  21  * http://www.gnu.org/copyleft/gpl.html
  22  *
  23  * @file
  24  * @ingroup Database
  25  */
  26
  27 /** Number of times to re-try an operation in case of deadlock */
  28 define( 'DEADLOCK_TRIES', 4 );
  29 /** Minimum time to wait before retry, in microseconds */
  30 define( 'DEADLOCK_DELAY_MIN', 500000 );
  31 /** Maximum time to wait before retry */
  32 define( 'DEADLOCK_DELAY_MAX', 1500000 );
  33
  34 /**
  35  * Base interface for all DBMS-specific code. At a bare minimum, all of the
  36  * following must be implemented to support MediaWiki
  37  *
  38  * @file
  39  * @ingroup Database
  40  */
  41 interface DatabaseType {
  42         /**
  43          * Get the type of the DBMS, as it appears in $wgDBtype.
  44          *
  45          * @return string
  46          */
  47         function getType();
  48
  49         /**
  50          * Open a connection to the database. Usually aborts on failure
  51          *
  52          * @param $server String: database server host
  53          * @param $user String: database user name
  54          * @param $password String: database user password
  55          * @param $dbName String: database name
  56          * @return bool
  57          * @throws DBConnectionError
  58          */
  59         function open( $server, $user, $password, $dbName );
  60
  61         /**
  62          * Fetch the next row from the given result object, in object form.
  63          * Fields can be retrieved with $row->fieldname, with fields acting like
  64          * member variables.
  65          *
  66          * @param $res ResultWrapper|object as returned from DatabaseBase::query(), etc.
  67          * @return Row object
  68          * @throws DBUnexpectedError Thrown if the database returns an error
  69          */
  70         function fetchObject( $res );
  71
  72         /**
  73          * Fetch the next row from the given result object, in associative array
  74          * form.  Fields are retrieved with $row['fieldname'].
  75          *
  76          * @param $res ResultWrapper result object as returned from DatabaseBase::query(), etc.
  77          * @return Row object
  78          * @throws DBUnexpectedError Thrown if the database returns an error
  79          */
  80         function fetchRow( $res );
  81
  82         /**
  83          * Get the number of rows in a result object
  84          *
  85          * @param $res Mixed: A SQL result
  86          * @return int
  87          */
  88         function numRows( $res );
  89
  90         /**
  91          * Get the number of fields in a result object
  92          * @see http://www.php.net/mysql_num_fields
  93          *
  94          * @param $res Mixed: A SQL result
  95          * @return int
  96          */
  97         function numFields( $res );
  98
  99         /**
 100          * Get a field name in a result object
 101          * @see http://www.php.net/mysql_field_name
 102          *
 103          * @param $res Mixed: A SQL result
 104          * @param $n Integer
 105          * @return string
 106          */
 107         function fieldName( $res, $n );
 108
 109         /**
 110          * Get the inserted value of an auto-increment row
 111          *
 112          * The value inserted should be fetched from nextSequenceValue()
 113          *
 114          * Example:
 115          * $id = $dbw->nextSequenceValue('page_page_id_seq');
 116          * $dbw->insert('page',array('page_id' => $id));
 117          * $id = $dbw->insertId();
 118          *
 119          * @return int
 120          */
 121         function insertId();
 122
 123         /**
 124          * Change the position of the cursor in a result object
 125          * @see http://www.php.net/mysql_data_seek
 126          *
 127          * @param $res Mixed: A SQL result
 128          * @param $row Mixed: Either MySQL row or ResultWrapper
 129          */
 130         function dataSeek( $res, $row );
 131
 132         /**
 133          * Get the last error number
 134          * @see http://www.php.net/mysql_errno
 135          *
 136          * @return int
 137          */
 138         function lastErrno();
 139
 140         /**
 141          * Get a description of the last error
 142          * @see http://www.php.net/mysql_error
 143          *
 144          * @return string
 145          */
 146         function lastError();
 147
 148         /**
 149          * mysql_fetch_field() wrapper
 150          * Returns false if the field doesn't exist
 151          *
 152          * @param $table string: table name
 153          * @param $field string: field name
 154          *
 155          * @return Field
 156          */
 157         function fieldInfo( $table, $field );
 158
 159         /**
 160          * Get information about an index into an object
 161          * @param $table string: Table name
 162          * @param $index string: Index name
 163          * @param $fname string: Calling function name
 164          * @return Mixed: Database-specific index description class or false if the index does not exist
 165          */
 166         function indexInfo( $table, $index, $fname = 'Database::indexInfo' );
 167
 168         /**
 169          * Get the number of rows affected by the last write query
 170          * @see http://www.php.net/mysql_affected_rows
 171          *
 172          * @return int
 173          */
 174         function affectedRows();
 175
 176         /**
 177          * Wrapper for addslashes()
 178          *
 179          * @param $s string: to be slashed.
 180          * @return string: slashed string.
 181          */
 182         function strencode( $s );
 183
 184         /**
 185          * Returns a wikitext link to the DB's website, e.g.,
 186          *     return "[http://www.mysql.com/ MySQL]";
 187          * Should at least contain plain text, if for some reason
 188          * your database has no website.
 189          *
 190          * @return string: wikitext of a link to the server software's web site
 191          */
 192         static function getSoftwareLink();
 193
 194         /**
 195          * A string describing the current software version, like from
 196          * mysql_get_server_info().
 197          *
 198          * @return string: Version information from the database server.
 199          */
 200         function getServerVersion();
 201
 202         /**
 203          * A string describing the current software version, and possibly
 204          * other details in a user-friendly way.  Will be listed on Special:Version, etc.
 205          * Use getServerVersion() to get machine-friendly information.
 206          *
 207          * @return string: Version information from the database server
 208          */
 209         function getServerInfo();
 210 }
 211
 212 /**
 213  * Database abstraction object
 214  * @ingroup Database
 215  */
 216 abstract class DatabaseBase implements DatabaseType {
 217
 218 # ------------------------------------------------------------------------------
 219 # Variables
 220 # ------------------------------------------------------------------------------
 221
 222         protected $mLastQuery = '';
 223         protected $mDoneWrites = false;
 224         protected $mPHPError = false;
 225
 226         protected $mServer, $mUser, $mPassword, $mDBname;
 227
 228         protected $mConn = null;
 229         protected $mOpened = false;
 230
 231         /**
 232          * @since 1.20
 233          * @var array of Closure
 234          */
 235         protected $mTrxIdleCallbacks = array();
 236
 237         protected $mTablePrefix;
 238         protected $mFlags;
 239         protected $mTrxLevel = 0;
 240         protected $mErrorCount = 0;
 241         protected $mLBInfo = array();
 242         protected $mFakeSlaveLag = null, $mFakeMaster = false;
 243         protected $mDefaultBigSelects = null;
 244         protected $mSchemaVars = false;
 245
 246         protected $preparedArgs;
 247
 248         protected $htmlErrors;
 249
 250         protected $delimiter = ';';
 251
 252         /**
 253          * Remembers the function name given for starting the most recent transaction via begin().
 254          * Used to provide additional context for error reporting.
 255          *
 256          * @var String
 257          * @see DatabaseBase::mTrxLevel
 258          */
 259         private $mTrxFname = null;
 260
 261         /**
 262          * Record if possible write queries were done in the last transaction started
 263          *
 264          * @var Bool
 265          * @see DatabaseBase::mTrxLevel
 266          */
 267         private $mTrxDoneWrites = false;
 268
 269         /**
 270          * Record if the current transaction was started implicitly due to DBO_TRX being set.
 271          *
 272          * @var Bool
 273          * @see DatabaseBase::mTrxLevel
 274          */
 275         private $mTrxAutomatic = false;
 276
 277         /**
 278          * @since 1.21
 279          * @var file handle for upgrade
 280          */
 281         protected $fileHandle = null;
 282
 283
 284 # ------------------------------------------------------------------------------
 285 # Accessors
 286 # ------------------------------------------------------------------------------
 287         # These optionally set a variable and return the previous state
 288
 289         /**
 290          * A string describing the current software version, and possibly
 291          * other details in a user-friendly way.  Will be listed on Special:Version, etc.
 292          * Use getServerVersion() to get machine-friendly information.
 293          *
 294          * @return string: Version information from the database server
 295          */
 296         public function getServerInfo() {
 297                 return $this->getServerVersion();
 298         }
 299
 300         /**
 301          * @return string: command delimiter used by this database engine
 302          */
 303         public function getDelimiter() {
 304                 return $this->delimiter;
 305         }
 306
 307         /**
 308          * Boolean, controls output of large amounts of debug information.
 309          * @param $debug bool|null
 310          *   - true to enable debugging
 311          *   - false to disable debugging
 312          *   - omitted or null to do nothing
 313          *
 314          * @return bool|null previous value of the flag
 315          */
 316         public function debug( $debug = null ) {
 317                 return wfSetBit( $this->mFlags, DBO_DEBUG, $debug );
 318         }
 319
 320         /**
 321          * Turns buffering of SQL result sets on (true) or off (false). Default is
 322          * "on".
 323          *
 324          * Unbuffered queries are very troublesome in MySQL:
 325          *
 326          *   - If another query is executed while the first query is being read
 327          *     out, the first query is killed. This means you can't call normal
 328          *     MediaWiki functions while you are reading an unbuffered query result
 329          *     from a normal wfGetDB() connection.
 330          *
 331          *   - Unbuffered queries cause the MySQL server to use large amounts of
 332          *     memory and to hold broad locks which block other queries.
 333          *
 334          * If you want to limit client-side memory, it's almost always better to
 335          * split up queries into batches using a LIMIT clause than to switch off
 336          * buffering.
 337          *
 338          * @param $buffer null|bool
 339          *
 340          * @return null|bool The previous value of the flag
 341          */
 342         public function bufferResults( $buffer = null ) {
 343                 if ( is_null( $buffer ) ) {
 344                         return !(bool)( $this->mFlags & DBO_NOBUFFER );
 345                 } else {
 346                         return !wfSetBit( $this->mFlags, DBO_NOBUFFER, !$buffer );
 347                 }
 348         }
 349
 350         /**
 351          * Turns on (false) or off (true) the automatic generation and sending
 352          * of a "we're sorry, but there has been a database error" page on
 353          * database errors. Default is on (false). When turned off, the
 354          * code should use lastErrno() and lastError() to handle the
 355          * situation as appropriate.
 356          *
 357          * @param $ignoreErrors bool|null
 358          *
 359          * @return bool The previous value of the flag.
 360          */
 361         public function ignoreErrors( $ignoreErrors = null ) {
 362                 return wfSetBit( $this->mFlags, DBO_IGNORE, $ignoreErrors );
 363         }
 364
 365         /**
 366          * Gets or sets the current transaction level.
 367          *
 368          * Historically, transactions were allowed to be "nested". This is no
 369          * longer supported, so this function really only returns a boolean.
 370          *
 371          * @param $level int An integer (0 or 1), or omitted to leave it unchanged.
 372          * @return int The previous value
 373          */
 374         public function trxLevel( $level = null ) {
 375                 return wfSetVar( $this->mTrxLevel, $level );
 376         }
 377
 378         /**
 379          * Get/set the number of errors logged. Only useful when errors are ignored
 380          * @param $count int The count to set, or omitted to leave it unchanged.
 381          * @return int The error count
 382          */
 383         public function errorCount( $count = null ) {
 384                 return wfSetVar( $this->mErrorCount, $count );
 385         }
 386
 387         /**
 388          * Get/set the table prefix.
 389          * @param $prefix string The table prefix to set, or omitted to leave it unchanged.
 390          * @return string The previous table prefix.
 391          */
 392         public function tablePrefix( $prefix = null ) {
 393                 return wfSetVar( $this->mTablePrefix, $prefix );
 394         }
 395
 396         /**
 397          * Set the filehandle to copy write statements to.
 398          *
 399          * @param $fh filehandle
 400          */
 401         public function setFileHandle( $fh ) {
 402                 $this->fileHandle = $fh;
 403         }
 404
 405         /**
 406          * Get properties passed down from the server info array of the load
 407          * balancer.
 408          *
 409          * @param $name string The entry of the info array to get, or null to get the
 410          *   whole array
 411          *
 412          * @return LoadBalancer|null
 413          */
 414         public function getLBInfo( $name = null ) {
 415                 if ( is_null( $name ) ) {
 416                         return $this->mLBInfo;
 417                 } else {
 418                         if ( array_key_exists( $name, $this->mLBInfo ) ) {
 419                                 return $this->mLBInfo[$name];
 420                         } else {
 421                                 return null;
 422                         }
 423                 }
 424         }
 425
 426         /**
 427          * Set the LB info array, or a member of it. If called with one parameter,
 428          * the LB info array is set to that parameter. If it is called with two
 429          * parameters, the member with the given name is set to the given value.
 430          *
 431          * @param $name
 432          * @param $value
 433          */
 434         public function setLBInfo( $name, $value = null ) {
 435                 if ( is_null( $value ) ) {
 436                         $this->mLBInfo = $name;
 437                 } else {
 438                         $this->mLBInfo[$name] = $value;
 439                 }
 440         }
 441
 442         /**
 443          * Set lag time in seconds for a fake slave
 444          *
 445          * @param $lag int
 446          */
 447         public function setFakeSlaveLag( $lag ) {
 448                 $this->mFakeSlaveLag = $lag;
 449         }
 450
 451         /**
 452          * Make this connection a fake master
 453          *
 454          * @param $enabled bool
 455          */
 456         public function setFakeMaster( $enabled = true ) {
 457                 $this->mFakeMaster = $enabled;
 458         }
 459
 460         /**
 461          * Returns true if this database supports (and uses) cascading deletes
 462          *
 463          * @return bool
 464          */
 465         public function cascadingDeletes() {
 466                 return false;
 467         }
 468
 469         /**
 470          * Returns true if this database supports (and uses) triggers (e.g. on the page table)
 471          *
 472          * @return bool
 473          */
 474         public function cleanupTriggers() {
 475                 return false;
 476         }
 477
 478         /**
 479          * Returns true if this database is strict about what can be put into an IP field.
 480          * Specifically, it uses a NULL value instead of an empty string.
 481          *
 482          * @return bool
 483          */
 484         public function strictIPs() {
 485                 return false;
 486         }
 487
 488         /**
 489          * Returns true if this database uses timestamps rather than integers
 490          *
 491          * @return bool
 492         */
 493         public function realTimestamps() {
 494                 return false;
 495         }
 496
 497         /**
 498          * Returns true if this database does an implicit sort when doing GROUP BY
 499          *
 500          * @return bool
 501          */
 502         public function implicitGroupby() {
 503                 return true;
 504         }
 505
 506         /**
 507          * Returns true if this database does an implicit order by when the column has an index
 508          * For example: SELECT page_title FROM page LIMIT 1
 509          *
 510          * @return bool
 511          */
 512         public function implicitOrderby() {
 513                 return true;
 514         }
 515
 516         /**
 517          * Returns true if this database can do a native search on IP columns
 518          * e.g. this works as expected: .. WHERE rc_ip = '127.42.12.102/32';
 519          *
 520          * @return bool
 521          */
 522         public function searchableIPs() {
 523                 return false;
 524         }
 525
 526         /**
 527          * Returns true if this database can use functional indexes
 528          *
 529          * @return bool
 530          */
 531         public function functionalIndexes() {
 532                 return false;
 533         }
 534
 535         /**
 536          * Return the last query that went through DatabaseBase::query()
 537          * @return String
 538          */
 539         public function lastQuery() {
 540                 return $this->mLastQuery;
 541         }
 542
 543         /**
 544          * Returns true if the connection may have been used for write queries.
 545          * Should return true if unsure.
 546          *
 547          * @return bool
 548          */
 549         public function doneWrites() {
 550                 return $this->mDoneWrites;
 551         }
 552
 553         /**
 554          * Returns true if there is a transaction open with possible write
 555          * queries or transaction idle callbacks waiting on it to finish.
 556          *
 557          * @return bool
 558          */
 559         public function writesOrCallbacksPending() {
 560                 return $this->mTrxLevel && ( $this->mTrxDoneWrites || $this->mTrxIdleCallbacks );
 561         }
 562
 563         /**
 564          * Is a connection to the database open?
 565          * @return Boolean
 566          */
 567         public function isOpen() {
 568                 return $this->mOpened;
 569         }
 570
 571         /**
 572          * Set a flag for this connection
 573          *
 574          * @param $flag Integer: DBO_* constants from Defines.php:
 575          *   - DBO_DEBUG: output some debug info (same as debug())
 576          *   - DBO_NOBUFFER: don't buffer results (inverse of bufferResults())
 577          *   - DBO_IGNORE: ignore errors (same as ignoreErrors())
 578          *   - DBO_TRX: automatically start transactions
 579          *   - DBO_DEFAULT: automatically sets DBO_TRX if not in command line mode
 580          *       and removes it in command line mode
 581          *   - DBO_PERSISTENT: use persistant database connection
 582          */
 583         public function setFlag( $flag ) {
 584                 global $wgDebugDBTransactions;
 585                 $this->mFlags |= $flag;
 586                 if ( ( $flag & DBO_TRX) & $wgDebugDBTransactions ) {
 587                         wfDebug("Implicit transactions are now  disabled.\n");
 588                 }
 589         }
 590
 591         /**
 592          * Clear a flag for this connection
 593          *
 594          * @param $flag: same as setFlag()'s $flag param
 595          */
 596         public function clearFlag( $flag ) {
 597                 global $wgDebugDBTransactions;
 598                 $this->mFlags &= ~$flag;
 599                 if ( ( $flag & DBO_TRX ) && $wgDebugDBTransactions ) {
 600                         wfDebug("Implicit transactions are now disabled.\n");
 601                 }
 602         }
 603
 604         /**
 605          * Returns a boolean whether the flag $flag is set for this connection
 606          *
 607          * @param $flag: same as setFlag()'s $flag param
 608          * @return Boolean
 609          */
 610         public function getFlag( $flag ) {
 611                 return !!( $this->mFlags & $flag );
 612         }
 613
 614         /**
 615          * General read-only accessor
 616          *
 617          * @param $name string
 618          *
 619          * @return string
 620          */
 621         public function getProperty( $name ) {
 622                 return $this->$name;
 623         }
 624
 625         /**
 626          * @return string
 627          */
 628         public function getWikiID() {
 629                 if ( $this->mTablePrefix ) {
 630                         return "{$this->mDBname}-{$this->mTablePrefix}";
 631                 } else {
 632                         return $this->mDBname;
 633                 }
 634         }
 635
 636         /**
 637          * Return a path to the DBMS-specific schema file, otherwise default to tables.sql
 638          *
 639          * @return string
 640          */
 641         public function getSchemaPath() {
 642                 global $IP;
 643                 if ( file_exists( "$IP/maintenance/" . $this->getType() . "/tables.sql" ) ) {
 644                         return "$IP/maintenance/" . $this->getType() . "/tables.sql";
 645                 } else {
 646                         return "$IP/maintenance/tables.sql";
 647                 }
 648         }
 649
 650 # ------------------------------------------------------------------------------
 651 # Other functions
 652 # ------------------------------------------------------------------------------
 653
 654         /**
 655          * Constructor.
 656          * @param $server String: database server host
 657          * @param $user String: database user name
 658          * @param $password String: database user password
 659          * @param $dbName String: database name
 660          * @param $flags
 661          * @param $tablePrefix String: database table prefixes. By default use the prefix gave in LocalSettings.php
 662          */
 663         function __construct( $server = false, $user = false, $password = false, $dbName = false,
 664                 $flags = 0, $tablePrefix = 'get from global'
 665         ) {
 666                 global $wgDBprefix, $wgCommandLineMode, $wgDebugDBTransactions;
 667
 668                 $this->mFlags = $flags;
 669
 670                 if ( $this->mFlags & DBO_DEFAULT ) {
 671                         if ( $wgCommandLineMode ) {
 672                                 $this->mFlags &= ~DBO_TRX;
 673                                 if ( $wgDebugDBTransactions ) {
 674                                         wfDebug("Implicit transaction open disabled.\n");
 675                                 }
 676                         } else {
 677                                 $this->mFlags |= DBO_TRX;
 678                                 if ( $wgDebugDBTransactions ) {
 679                                         wfDebug("Implicit transaction open enabled.\n");
 680                                 }
 681                         }
 682                 }
 683
 684                 /** Get the default table prefix*/
 685                 if ( $tablePrefix == 'get from global' ) {
 686                         $this->mTablePrefix = $wgDBprefix;
 687                 } else {
 688                         $this->mTablePrefix = $tablePrefix;
 689                 }
 690
 691                 if ( $user ) {
 692                         $this->open( $server, $user, $password, $dbName );
 693                 }
 694         }
 695
 696         /**
 697          * Called by serialize. Throw an exception when DB connection is serialized.
 698          * This causes problems on some database engines because the connection is
 699          * not restored on unserialize.
 700          */
 701         public function __sleep() {
 702                 throw new MWException( 'Database serialization may cause problems, since the connection is not restored on wakeup.' );
 703         }
 704
 705         /**
 706          * Given a DB type, construct the name of the appropriate child class of
 707          * DatabaseBase. This is designed to replace all of the manual stuff like:
 708          *      $class = 'Database' . ucfirst( strtolower( $type ) );
 709          * as well as validate against the canonical list of DB types we have
 710          *
 711          * This factory function is mostly useful for when you need to connect to a
 712          * database other than the MediaWiki default (such as for external auth,
 713          * an extension, et cetera). Do not use this to connect to the MediaWiki
 714          * database. Example uses in core:
 715          * @see LoadBalancer::reallyOpenConnection()
 716          * @see ExternalUser_MediaWiki::initFromCond()
 717          * @see ForeignDBRepo::getMasterDB()
 718          * @see WebInstaller_DBConnect::execute()
 719          *
 720          * @since 1.18
 721          *
 722          * @param $dbType String A possible DB type
 723          * @param $p Array An array of options to pass to the constructor.
 724          *    Valid options are: host, user, password, dbname, flags, tablePrefix
 725          * @return DatabaseBase subclass or null
 726          */
 727         public final static function factory( $dbType, $p = array() ) {
 728                 $canonicalDBTypes = array(
 729                         'mysql', 'postgres', 'sqlite', 'oracle', 'mssql', 'ibm_db2'
 730                 );
 731                 $dbType = strtolower( $dbType );
 732                 $class = 'Database' . ucfirst( $dbType );
 733
 734                 if( in_array( $dbType, $canonicalDBTypes ) || ( class_exists( $class ) && is_subclass_of( $class, 'DatabaseBase' ) ) ) {
 735                         return new $class(
 736                                 isset( $p['host'] ) ? $p['host'] : false,
 737                                 isset( $p['user'] ) ? $p['user'] : false,
 738                                 isset( $p['password'] ) ? $p['password'] : false,
 739                                 isset( $p['dbname'] ) ? $p['dbname'] : false,
 740                                 isset( $p['flags'] ) ? $p['flags'] : 0,
 741                                 isset( $p['tablePrefix'] ) ? $p['tablePrefix'] : 'get from global'
 742                         );
 743                 } else {
 744                         return null;
 745                 }
 746         }
 747
 748         protected function installErrorHandler() {
 749                 $this->mPHPError = false;
 750                 $this->htmlErrors = ini_set( 'html_errors', '0' );
 751                 set_error_handler( array( $this, 'connectionErrorHandler' ) );
 752         }
 753
 754         /**
 755          * @return bool|string
 756          */
 757         protected function restoreErrorHandler() {
 758                 restore_error_handler();
 759                 if ( $this->htmlErrors !== false ) {
 760                         ini_set( 'html_errors', $this->htmlErrors );
 761                 }
 762                 if ( $this->mPHPError ) {
 763                         $error = preg_replace( '!\[<a.*</a>\]!', '', $this->mPHPError );
 764                         $error = preg_replace( '!^.*?:\s?(.*)$!', '$1', $error );
 765                         return $error;
 766                 } else {
 767                         return false;
 768                 }
 769         }
 770
 771         /**
 772          * @param $errno
 773          * @param $errstr
 774          */
 775         protected function connectionErrorHandler( $errno,  $errstr ) {
 776                 $this->mPHPError = $errstr;
 777         }
 778
 779         /**
 780          * Closes a database connection.
 781          * if it is open : commits any open transactions
 782          *
 783          * @throws MWException
 784          * @return Bool operation success. true if already closed.
 785          */
 786         public function close() {
 787                 if ( count( $this->mTrxIdleCallbacks ) ) { // sanity
 788                         throw new MWException( "Transaction idle callbacks still pending." );
 789                 }
 790                 $this->mOpened = false;
 791                 if ( $this->mConn ) {
 792                         if ( $this->trxLevel() ) {
 793                                 if ( !$this->mTrxAutomatic ) {
 794                                         wfWarn( "Transaction still in progress (from {$this->mTrxFname}), " .
 795                                                 " performing implicit commit before closing connection!" );
 796                                 }
 797
 798                                 $this->commit( __METHOD__, 'flush' );
 799                         }
 800
 801                         $ret = $this->closeConnection();
 802                         $this->mConn = false;
 803                         return $ret;
 804                 } else {
 805                         return true;
 806                 }
 807         }
 808
 809         /**
 810          * Closes underlying database connection
 811          * @since 1.20
 812          * @return bool: Whether connection was closed successfully
 813          */
 814         protected abstract function closeConnection();
 815
 816         /**
 817          * @param $error String: fallback error message, used if none is given by DB
 818          * @throws DBConnectionError
 819          */
 820         function reportConnectionError( $error = 'Unknown error' ) {
 821                 $myError = $this->lastError();
 822                 if ( $myError ) {
 823                         $error = $myError;
 824                 }
 825
 826                 # New method
 827                 throw new DBConnectionError( $this, $error );
 828         }
 829
 830         /**
 831          * The DBMS-dependent part of query()
 832          *
 833          * @param  $sql String: SQL query.
 834          * @return ResultWrapper Result object to feed to fetchObject, fetchRow, ...; or false on failure
 835          */
 836         protected abstract function doQuery( $sql );
 837
 838         /**
 839          * Determine whether a query writes to the DB.
 840          * Should return true if unsure.
 841          *
 842          * @param $sql string
 843          *
 844          * @return bool
 845          */
 846         public function isWriteQuery( $sql ) {
 847                 return !preg_match( '/^(?:SELECT|BEGIN|ROLLBACK|COMMIT|SET|SHOW|EXPLAIN|\(SELECT)\b/i', $sql );
 848         }
 849
 850         /**
 851          * Run an SQL query and return the result. Normally throws a DBQueryError
 852          * on failure. If errors are ignored, returns false instead.
 853          *
 854          * In new code, the query wrappers select(), insert(), update(), delete(),
 855          * etc. should be used where possible, since they give much better DBMS
 856          * independence and automatically quote or validate user input in a variety
 857          * of contexts. This function is generally only useful for queries which are
 858          * explicitly DBMS-dependent and are unsupported by the query wrappers, such
 859          * as CREATE TABLE.
 860          *
 861          * However, the query wrappers themselves should call this function.
 862          *
 863          * @param  $sql        String: SQL query
 864          * @param  $fname      String: Name of the calling function, for profiling/SHOW PROCESSLIST
 865          *     comment (you can use __METHOD__ or add some extra info)
 866          * @param  $tempIgnore Boolean:   Whether to avoid throwing an exception on errors...
 867          *     maybe best to catch the exception instead?
 868          * @throws MWException
 869          * @return boolean|ResultWrapper. true for a successful write query, ResultWrapper object
 870          *     for a successful read query, or false on failure if $tempIgnore set
 871          */
 872         public function query( $sql, $fname = '', $tempIgnore = false ) {
 873                 $isMaster = !is_null( $this->getLBInfo( 'master' ) );
 874                 if ( !Profiler::instance()->isStub() ) {
 875                         # generalizeSQL will probably cut down the query to reasonable
 876                         # logging size most of the time. The substr is really just a sanity check.
 877
 878                         if ( $isMaster ) {
 879                                 $queryProf = 'query-m: ' . substr( DatabaseBase::generalizeSQL( $sql ), 0, 255 );
 880                                 $totalProf = 'DatabaseBase::query-master';
 881                         } else {
 882                                 $queryProf = 'query: ' . substr( DatabaseBase::generalizeSQL( $sql ), 0, 255 );
 883                                 $totalProf = 'DatabaseBase::query';
 884                         }
 885
 886                         wfProfileIn( $totalProf );
 887                         wfProfileIn( $queryProf );
 888                 }
 889
 890                 $this->mLastQuery = $sql;
 891                 if ( !$this->mDoneWrites && $this->isWriteQuery( $sql ) ) {
 892                         # Set a flag indicating that writes have been done
 893                         wfDebug( __METHOD__ . ": Writes done: $sql\n" );
 894                         $this->mDoneWrites = true;
 895                 }
 896
 897                 # Add a comment for easy SHOW PROCESSLIST interpretation
 898                 global $wgUser;
 899                 if ( is_object( $wgUser ) && $wgUser->isItemLoaded( 'name' ) ) {
 900                         $userName = $wgUser->getName();
 901                         if ( mb_strlen( $userName ) > 15 ) {
 902                                 $userName = mb_substr( $userName, 0, 15 ) . '...';
 903                         }
 904                         $userName = str_replace( '/', '', $userName );
 905                 } else {
 906                         $userName = '';
 907                 }
 908
 909                 // Add trace comment to the begin of the sql string, right after the operator.
 910                 // Or, for one-word queries (like "BEGIN" or COMMIT") add it to the end (bug 42598)
 911                 $commentedSql = preg_replace( '/\s|$/', " /* $fname $userName */ ", $sql, 1 );
 912
 913                 # If DBO_TRX is set, start a transaction
 914                 if ( ( $this->mFlags & DBO_TRX ) && !$this->mTrxLevel &&
 915                         $sql != 'BEGIN' && $sql != 'COMMIT' && $sql != 'ROLLBACK' )
 916                 {
 917                         # Avoid establishing transactions for SHOW and SET statements too -
 918                         # that would delay transaction initializations to once connection
 919                         # is really used by application
 920                         $sqlstart = substr( $sql, 0, 10 ); // very much worth it, benchmark certified(tm)
 921                         if ( strpos( $sqlstart, "SHOW " ) !== 0 && strpos( $sqlstart, "SET " ) !== 0 ) {
 922                                 global $wgDebugDBTransactions;
 923                                 if ( $wgDebugDBTransactions ) {
 924                                         wfDebug("Implicit transaction start.\n");
 925                                 }
 926                                 $this->begin( __METHOD__ . " ($fname)" );
 927                                 $this->mTrxAutomatic = true;
 928                         }
 929                 }
 930
 931                 # Keep track of whether the transaction has write queries pending
 932                 if ( $this->mTrxLevel && !$this->mTrxDoneWrites && $this->isWriteQuery( $sql ) ) {
 933                         $this->mTrxDoneWrites = true;
 934                 }
 935
 936                 if ( $this->debug() ) {
 937                         static $cnt = 0;
 938
 939                         $cnt++;
 940                         $sqlx = substr( $commentedSql, 0, 500 );
 941                         $sqlx = strtr( $sqlx, "\t\n", '  ' );
 942
 943                         $master = $isMaster ? 'master' : 'slave';
 944                         wfDebug( "Query {$this->mDBname} ($cnt) ($master): $sqlx\n" );
 945                 }
 946
 947                 if ( istainted( $sql ) & TC_MYSQL ) {
 948                         throw new MWException( 'Tainted query found' );
 949                 }
 950
 951                 $queryId = MWDebug::query( $sql, $fname, $isMaster );
 952
 953                 # Do the query and handle errors
 954                 $ret = $this->doQuery( $commentedSql );
 955
 956                 MWDebug::queryTime( $queryId );
 957
 958                 # Try reconnecting if the connection was lost
 959                 if ( false === $ret && $this->wasErrorReissuable() ) {
 960                         # Transaction is gone, like it or not
 961                         $this->mTrxLevel = 0;
 962                         $this->mTrxIdleCallbacks = array(); // cancel
 963                         wfDebug( "Connection lost, reconnecting...\n" );
 964
 965                         if ( $this->ping() ) {
 966                                 wfDebug( "Reconnected\n" );
 967                                 $sqlx = substr( $commentedSql, 0, 500 );
 968                                 $sqlx = strtr( $sqlx, "\t\n", '  ' );
 969                                 global $wgRequestTime;
 970                                 $elapsed = round( microtime( true ) - $wgRequestTime, 3 );
 971                                 if ( $elapsed < 300 ) {
 972                                         # Not a database error to lose a transaction after a minute or two
 973                                         wfLogDBError( "Connection lost and reconnected after {$elapsed}s, query: $sqlx\n" );
 974                                 }
 975                                 $ret = $this->doQuery( $commentedSql );
 976                         } else {
 977                                 wfDebug( "Failed\n" );
 978                         }
 979                 }
 980
 981                 if ( false === $ret ) {
 982                         $this->reportQueryError( $this->lastError(), $this->lastErrno(), $sql, $fname, $tempIgnore );
 983                 }
 984
 985                 if ( !Profiler::instance()->isStub() ) {
 986                         wfProfileOut( $queryProf );
 987                         wfProfileOut( $totalProf );
 988                 }
 989
 990                 return $this->resultObject( $ret );
 991         }
 992
 993         /**
 994          * Report a query error. Log the error, and if neither the object ignore
 995          * flag nor the $tempIgnore flag is set, throw a DBQueryError.
 996          *
 997          * @param $error String
 998          * @param $errno Integer
 999          * @param $sql String
1000          * @param $fname String
1001          * @param $tempIgnore Boolean
1002          * @throws DBQueryError
1003          */
1004         public function reportQueryError( $error, $errno, $sql, $fname, $tempIgnore = false ) {
1005                 # Ignore errors during error handling to avoid infinite recursion
1006                 $ignore = $this->ignoreErrors( true );
1007                 ++$this->mErrorCount;
1008
1009                 if ( $ignore || $tempIgnore ) {
1010                         wfDebug( "SQL ERROR (ignored): $error\n" );
1011                         $this->ignoreErrors( $ignore );
1012                 } else {
1013                         $sql1line = str_replace( "\n", "\\n", $sql );
1014                         wfLogDBError( "$fname\t{$this->mServer}\t$errno\t$error\t$sql1line\n" );
1015                         wfDebug( "SQL ERROR: " . $error . "\n" );
1016                         throw new DBQueryError( $this, $error, $errno, $sql, $fname );
1017                 }
1018         }
1019
1020         /**
1021          * Intended to be compatible with the PEAR::DB wrapper functions.
1022          * http://pear.php.net/manual/en/package.database.db.intro-execute.php
1023          *
1024          * ? = scalar value, quoted as necessary
1025          * ! = raw SQL bit (a function for instance)
1026          * & = filename; reads the file and inserts as a blob
1027          *     (we don't use this though...)
1028          *
1029          * @param $sql string
1030          * @param $func string
1031          *
1032          * @return array
1033          */
1034         protected function prepare( $sql, $func = 'DatabaseBase::prepare' ) {
1035                 /* MySQL doesn't support prepared statements (yet), so just
1036                    pack up the query for reference. We'll manually replace
1037                    the bits later. */
1038                 return array( 'query' => $sql, 'func' => $func );
1039         }
1040
1041         /**
1042          * Free a prepared query, generated by prepare().
1043          * @param $prepared
1044          */
1045         protected function freePrepared( $prepared ) {
1046                 /* No-op by default */
1047         }
1048
1049         /**
1050          * Execute a prepared query with the various arguments
1051          * @param $prepared String: the prepared sql
1052          * @param $args Mixed: Either an array here, or put scalars as varargs
1053          *
1054          * @return ResultWrapper
1055          */
1056         public function execute( $prepared, $args = null ) {
1057                 if ( !is_array( $args ) ) {
1058                         # Pull the var args
1059                         $args = func_get_args();
1060                         array_shift( $args );
1061                 }
1062
1063                 $sql = $this->fillPrepared( $prepared['query'], $args );
1064
1065                 return $this->query( $sql, $prepared['func'] );
1066         }
1067
1068         /**
1069          * For faking prepared SQL statements on DBs that don't support it directly.
1070          *
1071          * @param $preparedQuery String: a 'preparable' SQL statement
1072          * @param $args Array of arguments to fill it with
1073          * @return string executable SQL
1074          */
1075         public function fillPrepared( $preparedQuery, $args ) {
1076                 reset( $args );
1077                 $this->preparedArgs =& $args;
1078
1079                 return preg_replace_callback( '/(\\\\[?!&]|[?!&])/',
1080                         array( &$this, 'fillPreparedArg' ), $preparedQuery );
1081         }
1082
1083         /**
1084          * preg_callback func for fillPrepared()
1085          * The arguments should be in $this->preparedArgs and must not be touched
1086          * while we're doing this.
1087          *
1088          * @param $matches Array
1089          * @throws DBUnexpectedError
1090          * @return String
1091          */
1092         protected function fillPreparedArg( $matches ) {
1093                 switch( $matches[1] ) {
1094                         case '\\?': return '?';
1095                         case '\\!': return '!';
1096                         case '\\&': return '&';
1097                 }
1098
1099                 list( /* $n */ , $arg ) = each( $this->preparedArgs );
1100
1101                 switch( $matches[1] ) {
1102                         case '?': return $this->addQuotes( $arg );
1103                         case '!': return $arg;
1104                         case '&':
1105                                 # return $this->addQuotes( file_get_contents( $arg ) );
1106                                 throw new DBUnexpectedError( $this, '& mode is not implemented. If it\'s really needed, uncomment the line above.' );
1107                         default:
1108                                 throw new DBUnexpectedError( $this, 'Received invalid match. This should never happen!' );
1109                 }
1110         }
1111
1112         /**
1113          * Free a result object returned by query() or select(). It's usually not
1114          * necessary to call this, just use unset() or let the variable holding
1115          * the result object go out of scope.
1116          *
1117          * @param $res Mixed: A SQL result
1118          */
1119         public function freeResult( $res ) {}
1120
1121         /**
1122          * A SELECT wrapper which returns a single field from a single result row.
1123          *
1124          * Usually throws a DBQueryError on failure. If errors are explicitly
1125          * ignored, returns false on failure.
1126          *
1127          * If no result rows are returned from the query, false is returned.
1128          *
1129          * @param $table string|array Table name. See DatabaseBase::select() for details.
1130          * @param $var string The field name to select. This must be a valid SQL
1131          *   fragment: do not use unvalidated user input.
1132          * @param $cond string|array The condition array. See DatabaseBase::select() for details.
1133          * @param $fname string The function name of the caller.
1134          * @param $options string|array The query options. See DatabaseBase::select() for details.
1135          *
1136          * @return bool|mixed The value from the field, or false on failure.
1137          */
1138         public function selectField( $table, $var, $cond = '', $fname = 'DatabaseBase::selectField',
1139                 $options = array() )
1140         {
1141                 if ( !is_array( $options ) ) {
1142                         $options = array( $options );
1143                 }
1144
1145                 $options['LIMIT'] = 1;
1146
1147                 $res = $this->select( $table, $var, $cond, $fname, $options );
1148
1149                 if ( $res === false || !$this->numRows( $res ) ) {
1150                         return false;
1151                 }
1152
1153                 $row = $this->fetchRow( $res );
1154
1155                 if ( $row !== false ) {
1156                         return reset( $row );
1157                 } else {
1158                         return false;
1159                 }
1160         }
1161
1162         /**
1163          * Returns an optional USE INDEX clause to go after the table, and a
1164          * string to go at the end of the query.
1165          *
1166          * @param $options Array: associative array of options to be turned into
1167          *              an SQL query, valid keys are listed in the function.
1168          * @return Array
1169          * @see DatabaseBase::select()
1170          */
1171         public function makeSelectOptions( $options ) {
1172                 $preLimitTail = $postLimitTail = '';
1173                 $startOpts = '';
1174
1175                 $noKeyOptions = array();
1176
1177                 foreach ( $options as $key => $option ) {
1178                         if ( is_numeric( $key ) ) {
1179                                 $noKeyOptions[$option] = true;
1180                         }
1181                 }
1182
1183                 if ( isset( $options['GROUP BY'] ) ) {
1184                         $gb = is_array( $options['GROUP BY'] )
1185                                 ? implode( ',', $options['GROUP BY'] )
1186                                 : $options['GROUP BY'];
1187                         $preLimitTail .= " GROUP BY {$gb}";
1188                 }
1189
1190                 if ( isset( $options['HAVING'] ) ) {
1191                         $having = is_array( $options['HAVING'] )
1192                                 ? $this->makeList( $options['HAVING'], LIST_AND )
1193                                 : $options['HAVING'];
1194                         $preLimitTail .= " HAVING {$having}";
1195                 }
1196
1197                 if ( isset( $options['ORDER BY'] ) ) {
1198                         $ob = is_array( $options['ORDER BY'] )
1199                                 ? implode( ',', $options['ORDER BY'] )
1200                                 : $options['ORDER BY'];
1201                         $preLimitTail .= " ORDER BY {$ob}";
1202                 }
1203
1204                 // if (isset($options['LIMIT'])) {
1205                 //      $tailOpts .= $this->limitResult('', $options['LIMIT'],
1206                 //              isset($options['OFFSET']) ? $options['OFFSET']
1207                 //              : false);
1208                 // }
1209
1210                 if ( isset( $noKeyOptions['FOR UPDATE'] ) ) {
1211                         $postLimitTail .= ' FOR UPDATE';
1212                 }
1213
1214                 if ( isset( $noKeyOptions['LOCK IN SHARE MODE'] ) ) {
1215                         $postLimitTail .= ' LOCK IN SHARE MODE';
1216                 }
1217
1218                 if ( isset( $noKeyOptions['DISTINCT'] ) || isset( $noKeyOptions['DISTINCTROW'] ) ) {
1219                         $startOpts .= 'DISTINCT';
1220                 }
1221
1222                 # Various MySQL extensions
1223                 if ( isset( $noKeyOptions['STRAIGHT_JOIN'] ) ) {
1224                         $startOpts .= ' /*! STRAIGHT_JOIN */';
1225                 }
1226
1227                 if ( isset( $noKeyOptions['HIGH_PRIORITY'] ) ) {
1228                         $startOpts .= ' HIGH_PRIORITY';
1229                 }
1230
1231                 if ( isset( $noKeyOptions['SQL_BIG_RESULT'] ) ) {
1232                         $startOpts .= ' SQL_BIG_RESULT';
1233                 }
1234
1235                 if ( isset( $noKeyOptions['SQL_BUFFER_RESULT'] ) ) {
1236                         $startOpts .= ' SQL_BUFFER_RESULT';
1237                 }
1238
1239                 if ( isset( $noKeyOptions['SQL_SMALL_RESULT'] ) ) {
1240                         $startOpts .= ' SQL_SMALL_RESULT';
1241                 }
1242
1243                 if ( isset( $noKeyOptions['SQL_CALC_FOUND_ROWS'] ) ) {
1244                         $startOpts .= ' SQL_CALC_FOUND_ROWS';
1245                 }
1246
1247                 if ( isset( $noKeyOptions['SQL_CACHE'] ) ) {
1248                         $startOpts .= ' SQL_CACHE';
1249                 }
1250
1251                 if ( isset( $noKeyOptions['SQL_NO_CACHE'] ) ) {
1252                         $startOpts .= ' SQL_NO_CACHE';
1253                 }
1254
1255                 if ( isset( $options['USE INDEX'] ) && ! is_array( $options['USE INDEX'] ) ) {
1256                         $useIndex = $this->useIndexClause( $options['USE INDEX'] );
1257                 } else {
1258                         $useIndex = '';
1259                 }
1260
1261                 return array( $startOpts, $useIndex, $preLimitTail, $postLimitTail );
1262         }
1263
1264         /**
1265          * Execute a SELECT query constructed using the various parameters provided.
1266          * See below for full details of the parameters.
1267          *
1268          * @param $table String|Array Table name
1269          * @param $vars String|Array Field names
1270          * @param $conds String|Array Conditions
1271          * @param $fname String Caller function name
1272          * @param $options Array Query options
1273          * @param $join_conds Array Join conditions
1274          *
1275          * @param $table string|array
1276          *
1277          * May be either an array of table names, or a single string holding a table
1278          * name. If an array is given, table aliases can be specified, for example:
1279          *
1280          *    array( 'a' => 'user' )
1281          *
1282          * This includes the user table in the query, with the alias "a" available
1283          * for use in field names (e.g. a.user_name).
1284          *
1285          * All of the table names given here are automatically run through
1286          * DatabaseBase::tableName(), which causes the table prefix (if any) to be
1287          * added, and various other table name mappings to be performed.
1288          *
1289          *
1290          * @param $vars string|array
1291          *
1292          * May be either a field name or an array of field names. The field names
1293          * can be complete fragments of SQL, for direct inclusion into the SELECT
1294          * query. If an array is given, field aliases can be specified, for example:
1295          *
1296          *   array( 'maxrev' => 'MAX(rev_id)' )
1297          *
1298          * This includes an expression with the alias "maxrev" in the query.
1299          *
1300          * If an expression is given, care must be taken to ensure that it is
1301          * DBMS-independent.
1302          *
1303          *
1304          * @param $conds string|array
1305          *
1306          * May be either a string containing a single condition, or an array of
1307          * conditions. If an array is given, the conditions constructed from each
1308          * element are combined with AND.
1309          *
1310          * Array elements may take one of two forms:
1311          *
1312          *   - Elements with a numeric key are interpreted as raw SQL fragments.
1313          *   - Elements with a string key are interpreted as equality conditions,
1314          *     where the key is the field name.
1315          *     - If the value of such an array element is a scalar (such as a
1316          *       string), it will be treated as data and thus quoted appropriately.
1317          *       If it is null, an IS NULL clause will be added.
1318          *     - If the value is an array, an IN(...) clause will be constructed,
1319          *       such that the field name may match any of the elements in the
1320          *       array. The elements of the array will be quoted.
1321          *
1322          * Note that expressions are often DBMS-dependent in their syntax.
1323          * DBMS-independent wrappers are provided for constructing several types of
1324          * expression commonly used in condition queries. See:
1325          *    - DatabaseBase::buildLike()
1326          *    - DatabaseBase::conditional()
1327          *
1328          *
1329          * @param $options string|array
1330          *
1331          * Optional: Array of query options. Boolean options are specified by
1332          * including them in the array as a string value with a numeric key, for
1333          * example:
1334          *
1335          *    array( 'FOR UPDATE' )
1336          *
1337          * The supported options are:
1338          *
1339          *   - OFFSET: Skip this many rows at the start of the result set. OFFSET
1340          *     with LIMIT can theoretically be used for paging through a result set,
1341          *     but this is discouraged in MediaWiki for performance reasons.
1342          *
1343          *   - LIMIT: Integer: return at most this many rows. The rows are sorted
1344          *     and then the first rows are taken until the limit is reached. LIMIT
1345          *     is applied to a result set after OFFSET.
1346          *
1347          *   - FOR UPDATE: Boolean: lock the returned rows so that they can't be
1348          *     changed until the next COMMIT.
1349          *
1350          *   - DISTINCT: Boolean: return only unique result rows.
1351          *
1352          *   - GROUP BY: May be either an SQL fragment string naming a field or
1353          *     expression to group by, or an array of such SQL fragments.
1354          *
1355          *   - HAVING: May be either an string containing a HAVING clause or an array of
1356          *     conditions building the HAVING clause. If an array is given, the conditions
1357          *     constructed from each element are combined with AND.
1358          *
1359          *   - ORDER BY: May be either an SQL fragment giving a field name or
1360          *     expression to order by, or an array of such SQL fragments.
1361          *
1362          *   - USE INDEX: This may be either a string giving the index name to use
1363          *     for the query, or an array. If it is an associative array, each key
1364          *     gives the table name (or alias), each value gives the index name to
1365          *     use for that table. All strings are SQL fragments and so should be
1366          *     validated by the caller.
1367          *
1368          *   - EXPLAIN: In MySQL, this causes an EXPLAIN SELECT query to be run,
1369          *     instead of SELECT.
1370          *
1371          * And also the following boolean MySQL extensions, see the MySQL manual
1372          * for documentation:
1373          *
1374          *    - LOCK IN SHARE MODE
1375          *    - STRAIGHT_JOIN
1376          *    - HIGH_PRIORITY
1377          *    - SQL_BIG_RESULT
1378          *    - SQL_BUFFER_RESULT
1379          *    - SQL_SMALL_RESULT
1380          *    - SQL_CALC_FOUND_ROWS
1381          *    - SQL_CACHE
1382          *    - SQL_NO_CACHE
1383          *
1384          *
1385          * @param $join_conds string|array
1386          *
1387          * Optional associative array of table-specific join conditions. In the
1388          * most common case, this is unnecessary, since the join condition can be
1389          * in $conds. However, it is useful for doing a LEFT JOIN.
1390          *
1391          * The key of the array contains the table name or alias. The value is an
1392          * array with two elements, numbered 0 and 1. The first gives the type of
1393          * join, the second is an SQL fragment giving the join condition for that
1394          * table. For example:
1395          *
1396          *    array( 'page' => array('LEFT JOIN','page_latest=rev_id') )
1397          *
1398          * @return ResultWrapper. If the query returned no rows, a ResultWrapper
1399          *   with no rows in it will be returned. If there was a query error, a
1400          *   DBQueryError exception will be thrown, except if the "ignore errors"
1401          *   option was set, in which case false will be returned.
1402          */
1403         public function select( $table, $vars, $conds = '', $fname = 'DatabaseBase::select',
1404                 $options = array(), $join_conds = array() ) {
1405                 $sql = $this->selectSQLText( $table, $vars, $conds, $fname, $options, $join_conds );
1406
1407                 return $this->query( $sql, $fname );
1408         }
1409
1410         /**
1411          * The equivalent of DatabaseBase::select() except that the constructed SQL
1412          * is returned, instead of being immediately executed. This can be useful for
1413          * doing UNION queries, where the SQL text of each query is needed. In general,
1414          * however, callers outside of Database classes should just use select().
1415          *
1416          * @param $table string|array Table name
1417          * @param $vars string|array Field names
1418          * @param $conds string|array Conditions
1419          * @param $fname string Caller function name
1420          * @param $options string|array Query options
1421          * @param $join_conds string|array Join conditions
1422          *
1423          * @return string SQL query string.
1424          * @see DatabaseBase::select()
1425          */
1426         public function selectSQLText( $table, $vars, $conds = '', $fname = 'DatabaseBase::select',
1427                 $options = array(), $join_conds = array() )
1428         {
1429                 if ( is_array( $vars ) ) {
1430                         $vars = implode( ',', $this->fieldNamesWithAlias( $vars ) );
1431                 }
1432
1433                 $options = (array)$options;
1434
1435                 if ( is_array( $table ) ) {
1436                         $useIndex = ( isset( $options['USE INDEX'] ) && is_array( $options['USE INDEX'] ) )
1437                                 ? $options['USE INDEX']
1438                                 : array();
1439                         if ( count( $join_conds ) || count( $useIndex ) ) {
1440                                 $from = ' FROM ' .
1441                                         $this->tableNamesWithUseIndexOrJOIN( $table, $useIndex, $join_conds );
1442                         } else {
1443                                 $from = ' FROM ' . implode( ',', $this->tableNamesWithAlias( $table ) );
1444                         }
1445                 } elseif ( $table != '' ) {
1446                         if ( $table[0] == ' ' ) {
1447                                 $from = ' FROM ' . $table;
1448                         } else {
1449                                 $from = ' FROM ' . $this->tableName( $table );
1450                         }
1451                 } else {
1452                         $from = '';
1453                 }
1454
1455                 list( $startOpts, $useIndex, $preLimitTail, $postLimitTail ) = $this->makeSelectOptions( $options );
1456
1457                 if ( !empty( $conds ) ) {
1458                         if ( is_array( $conds ) ) {
1459                                 $conds = $this->makeList( $conds, LIST_AND );
1460                         }
1461                         $sql = "SELECT $startOpts $vars $from $useIndex WHERE $conds $preLimitTail";
1462                 } else {
1463                         $sql = "SELECT $startOpts $vars $from $useIndex $preLimitTail";
1464                 }
1465
1466                 if ( isset( $options['LIMIT'] ) ) {
1467                         $sql = $this->limitResult( $sql, $options['LIMIT'],
1468                                 isset( $options['OFFSET'] ) ? $options['OFFSET'] : false );
1469                 }
1470                 $sql = "$sql $postLimitTail";
1471
1472                 if ( isset( $options['EXPLAIN'] ) ) {
1473                         $sql = 'EXPLAIN ' . $sql;
1474                 }
1475
1476                 return $sql;
1477         }
1478
1479         /**
1480          * Single row SELECT wrapper. Equivalent to DatabaseBase::select(), except
1481          * that a single row object is returned. If the query returns no rows,
1482          * false is returned.
1483          *
1484          * @param $table string|array Table name
1485          * @param $vars string|array Field names
1486          * @param $conds array Conditions
1487          * @param $fname string Caller function name
1488          * @param $options string|array Query options
1489          * @param $join_conds array|string Join conditions
1490          *
1491          * @return object|bool
1492          */
1493         public function selectRow( $table, $vars, $conds, $fname = 'DatabaseBase::selectRow',
1494                 $options = array(), $join_conds = array() )
1495         {
1496                 $options = (array)$options;
1497                 $options['LIMIT'] = 1;
1498                 $res = $this->select( $table, $vars, $conds, $fname, $options, $join_conds );
1499
1500                 if ( $res === false ) {
1501                         return false;
1502                 }
1503
1504                 if ( !$this->numRows( $res ) ) {
1505                         return false;
1506                 }
1507
1508                 $obj = $this->fetchObject( $res );
1509
1510                 return $obj;
1511         }
1512
1513         /**
1514          * Estimate rows in dataset.
1515          *
1516          * MySQL allows you to estimate the number of rows that would be returned
1517          * by a SELECT query, using EXPLAIN SELECT. The estimate is provided using
1518          * index cardinality statistics, and is notoriously inaccurate, especially
1519          * when large numbers of rows have recently been added or deleted.
1520          *
1521          * For DBMSs that don't support fast result size estimation, this function
1522          * will actually perform the SELECT COUNT(*).
1523          *
1524          * Takes the same arguments as DatabaseBase::select().
1525          *
1526          * @param $table String: table name
1527          * @param Array|string $vars : unused
1528          * @param Array|string $conds : filters on the table
1529          * @param $fname String: function name for profiling
1530          * @param $options Array: options for select
1531          * @return Integer: row count
1532          */
1533         public function estimateRowCount( $table, $vars = '*', $conds = '',
1534                 $fname = 'DatabaseBase::estimateRowCount', $options = array() )
1535         {
1536                 $rows = 0;
1537                 $res = $this->select( $table, array( 'rowcount' => 'COUNT(*)' ), $conds, $fname, $options );
1538
1539                 if ( $res ) {
1540                         $row = $this->fetchRow( $res );
1541                         $rows = ( isset( $row['rowcount'] ) ) ? $row['rowcount'] : 0;
1542                 }
1543
1544                 return $rows;
1545         }
1546
1547         /**
1548          * Removes most variables from an SQL query and replaces them with X or N for numbers.
1549          * It's only slightly flawed. Don't use for anything important.
1550          *
1551          * @param $sql String A SQL Query
1552          *
1553          * @return string
1554          */
1555         static function generalizeSQL( $sql ) {
1556                 # This does the same as the regexp below would do, but in such a way
1557                 # as to avoid crashing php on some large strings.
1558                 # $sql = preg_replace ( "/'([^\\\\']|\\\\.)*'|\"([^\\\\\"]|\\\\.)*\"/", "'X'", $sql);
1559
1560                 $sql = str_replace ( "\\\\", '', $sql );
1561                 $sql = str_replace ( "\\'", '', $sql );
1562                 $sql = str_replace ( "\\\"", '', $sql );
1563                 $sql = preg_replace ( "/'.*'/s", "'X'", $sql );
1564                 $sql = preg_replace ( '/".*"/s', "'X'", $sql );
1565
1566                 # All newlines, tabs, etc replaced by single space
1567                 $sql = preg_replace ( '/\s+/', ' ', $sql );
1568
1569                 # All numbers => N
1570                 $sql = preg_replace ( '/-?[0-9]+/s', 'N', $sql );
1571
1572                 return $sql;
1573         }
1574
1575         /**
1576          * Determines whether a field exists in a table
1577          *
1578          * @param $table String: table name
1579          * @param $field String: filed to check on that table
1580          * @param $fname String: calling function name (optional)
1581          * @return Boolean: whether $table has filed $field
1582          */
1583         public function fieldExists( $table, $field, $fname = 'DatabaseBase::fieldExists' ) {
1584                 $info = $this->fieldInfo( $table, $field );
1585
1586                 return (bool)$info;
1587         }
1588
1589         /**
1590          * Determines whether an index exists
1591          * Usually throws a DBQueryError on failure
1592          * If errors are explicitly ignored, returns NULL on failure
1593          *
1594          * @param $table
1595          * @param $index
1596          * @param $fname string
1597          *
1598          * @return bool|null
1599          */
1600         public function indexExists( $table, $index, $fname = 'DatabaseBase::indexExists' ) {
1601                 if( !$this->tableExists( $table ) ) {
1602                         return null;
1603                 }
1604
1605                 $info = $this->indexInfo( $table, $index, $fname );
1606                 if ( is_null( $info ) ) {
1607                         return null;
1608                 } else {
1609                         return $info !== false;
1610                 }
1611         }
1612
1613         /**
1614          * Query whether a given table exists
1615          *
1616          * @param $table string
1617          * @param $fname string
1618          *
1619          * @return bool
1620          */
1621         public function tableExists( $table, $fname = __METHOD__ ) {
1622                 $table = $this->tableName( $table );
1623                 $old = $this->ignoreErrors( true );
1624                 $res = $this->query( "SELECT 1 FROM $table LIMIT 1", $fname );
1625                 $this->ignoreErrors( $old );
1626
1627                 return (bool)$res;
1628         }
1629
1630         /**
1631          * mysql_field_type() wrapper
1632          * @param $res
1633          * @param $index
1634          * @return string
1635          */
1636         public function fieldType( $res, $index ) {
1637                 if ( $res instanceof ResultWrapper ) {
1638                         $res = $res->result;
1639                 }
1640
1641                 return mysql_field_type( $res, $index );
1642         }
1643
1644         /**
1645          * Determines if a given index is unique
1646          *
1647          * @param $table string
1648          * @param $index string
1649          *
1650          * @return bool
1651          */
1652         public function indexUnique( $table, $index ) {
1653                 $indexInfo = $this->indexInfo( $table, $index );
1654
1655                 if ( !$indexInfo ) {
1656                         return null;
1657                 }
1658
1659                 return !$indexInfo[0]->Non_unique;
1660         }
1661
1662         /**
1663          * Helper for DatabaseBase::insert().
1664          *
1665          * @param $options array
1666          * @return string
1667          */
1668         protected function makeInsertOptions( $options ) {
1669                 return implode( ' ', $options );
1670         }
1671
1672         /**
1673          * INSERT wrapper, inserts an array into a table.
1674          *
1675          * $a may be either:
1676          *
1677          *   - A single associative array. The array keys are the field names, and
1678          *     the values are the values to insert. The values are treated as data
1679          *     and will be quoted appropriately. If NULL is inserted, this will be
1680          *     converted to a database NULL.
1681          *   - An array with numeric keys, holding a list of associative arrays.
1682          *     This causes a multi-row INSERT on DBMSs that support it. The keys in
1683          *     each subarray must be identical to each other, and in the same order.
1684          *
1685          * Usually throws a DBQueryError on failure. If errors are explicitly ignored,
1686          * returns success.
1687          *
1688          * $options is an array of options, with boolean options encoded as values
1689          * with numeric keys, in the same style as $options in
1690          * DatabaseBase::select(). Supported options are:
1691          *
1692          *   - IGNORE: Boolean: if present, duplicate key errors are ignored, and
1693          *     any rows which cause duplicate key errors are not inserted. It's
1694          *     possible to determine how many rows were successfully inserted using
1695          *     DatabaseBase::affectedRows().
1696          *
1697          * @param $table   String Table name. This will be passed through
1698          *                 DatabaseBase::tableName().
1699          * @param $a       Array of rows to insert
1700          * @param $fname   String Calling function name (use __METHOD__) for logs/profiling
1701          * @param $options Array of options
1702          *
1703          * @return bool
1704          */
1705         public function insert( $table, $a, $fname = 'DatabaseBase::insert', $options = array() ) {
1706                 # No rows to insert, easy just return now
1707                 if ( !count( $a ) ) {
1708                         return true;
1709                 }
1710
1711                 $table = $this->tableName( $table );
1712
1713                 if ( !is_array( $options ) ) {
1714                         $options = array( $options );
1715                 }
1716
1717                 $fh = null;
1718                 if ( isset( $options['fileHandle'] ) ) {
1719                         $fh = $options['fileHandle'];
1720                 }
1721                 $options = $this->makeInsertOptions( $options );
1722
1723                 if ( isset( $a[0] ) && is_array( $a[0] ) ) {
1724                         $multi = true;
1725                         $keys = array_keys( $a[0] );
1726                 } else {
1727                         $multi = false;
1728                         $keys = array_keys( $a );
1729                 }
1730
1731                 $sql = 'INSERT ' . $options .
1732                         " INTO $table (" . implode( ',', $keys ) . ') VALUES ';
1733
1734                 if ( $multi ) {
1735                         $first = true;
1736                         foreach ( $a as $row ) {
1737                                 if ( $first ) {
1738                                         $first = false;
1739                                 } else {
1740                                         $sql .= ',';
1741                                 }
1742                                 $sql .= '(' . $this->makeList( $row ) . ')';
1743                         }
1744                 } else {
1745                         $sql .= '(' . $this->makeList( $a ) . ')';
1746                 }
1747
1748                 if ( $fh !== null && false === fwrite( $fh, $sql ) ) {
1749                         return false;
1750                 } elseif ( $fh !== null ) {
1751                         return true;
1752                 }
1753
1754                 return (bool)$this->query( $sql, $fname );
1755         }
1756
1757         /**
1758          * Make UPDATE options for the DatabaseBase::update function
1759          *
1760          * @param $options Array: The options passed to DatabaseBase::update
1761          * @return string
1762          */
1763         protected function makeUpdateOptions( $options ) {
1764                 if ( !is_array( $options ) ) {
1765                         $options = array( $options );
1766                 }
1767
1768                 $opts = array();
1769
1770                 if ( in_array( 'LOW_PRIORITY', $options ) ) {
1771                         $opts[] = $this->lowPriorityOption();
1772                 }
1773
1774                 if ( in_array( 'IGNORE', $options ) ) {
1775                         $opts[] = 'IGNORE';
1776                 }
1777
1778                 return implode( ' ', $opts );
1779         }
1780
1781         /**
1782          * UPDATE wrapper. Takes a condition array and a SET array.
1783          *
1784          * @param $table  String name of the table to UPDATE. This will be passed through
1785          *                DatabaseBase::tableName().
1786          *
1787          * @param $values Array:  An array of values to SET. For each array element,
1788          *                the key gives the field name, and the value gives the data
1789          *                to set that field to. The data will be quoted by
1790          *                DatabaseBase::addQuotes().
1791          *
1792          * @param $conds  Array:  An array of conditions (WHERE). See
1793          *                DatabaseBase::select() for the details of the format of
1794          *                condition arrays. Use '*' to update all rows.
1795          *
1796          * @param $fname  String: The function name of the caller (from __METHOD__),
1797          *                for logging and profiling.
1798          *
1799          * @param $options Array: An array of UPDATE options, can be:
1800          *                   - IGNORE: Ignore unique key conflicts
1801          *                   - LOW_PRIORITY: MySQL-specific, see MySQL manual.
1802          * @return Boolean
1803          */
1804         function update( $table, $values, $conds, $fname = 'DatabaseBase::update', $options = array() ) {
1805                 $table = $this->tableName( $table );
1806                 $opts = $this->makeUpdateOptions( $options );
1807                 $sql = "UPDATE $opts $table SET " . $this->makeList( $values, LIST_SET );
1808
1809                 if ( $conds !== array() && $conds !== '*' ) {
1810                         $sql .= " WHERE " . $this->makeList( $conds, LIST_AND );
1811                 }
1812
1813                 return $this->query( $sql, $fname );
1814         }
1815
1816         /**
1817          * Makes an encoded list of strings from an array
1818          * @param $a Array containing the data
1819          * @param int $mode Constant
1820          *      - LIST_COMMA:          comma separated, no field names
1821          *      - LIST_AND:            ANDed WHERE clause (without the WHERE). See
1822          *        the documentation for $conds in DatabaseBase::select().
1823          *      - LIST_OR:             ORed WHERE clause (without the WHERE)
1824          *      - LIST_SET:            comma separated with field names, like a SET clause
1825          *      - LIST_NAMES:          comma separated field names
1826          *
1827          * @throws MWException|DBUnexpectedError
1828          * @return string
1829          */
1830         public function makeList( $a, $mode = LIST_COMMA ) {
1831                 if ( !is_array( $a ) ) {
1832                         throw new DBUnexpectedError( $this, 'DatabaseBase::makeList called with incorrect parameters' );
1833                 }
1834
1835                 $first = true;
1836                 $list = '';
1837
1838                 foreach ( $a as $field => $value ) {
1839                         if ( !$first ) {
1840                                 if ( $mode == LIST_AND ) {
1841                                         $list .= ' AND ';
1842                                 } elseif ( $mode == LIST_OR ) {
1843                                         $list .= ' OR ';
1844                                 } else {
1845                                         $list .= ',';
1846                                 }
1847                         } else {
1848                                 $first = false;
1849                         }
1850
1851                         if ( ( $mode == LIST_AND || $mode == LIST_OR ) && is_numeric( $field ) ) {
1852                                 $list .= "($value)";
1853                         } elseif ( ( $mode == LIST_SET ) && is_numeric( $field ) ) {
1854                                 $list .= "$value";
1855                         } elseif ( ( $mode == LIST_AND || $mode == LIST_OR ) && is_array( $value ) ) {
1856                                 if ( count( $value ) == 0 ) {
1857                                         throw new MWException( __METHOD__ . ": empty input for field $field" );
1858                                 } elseif ( count( $value ) == 1 ) {
1859                                         // Special-case single values, as IN isn't terribly efficient
1860                                         // Don't necessarily assume the single key is 0; we don't
1861                                         // enforce linear numeric ordering on other arrays here.
1862                                         $value = array_values( $value );
1863                                         $list .= $field . " = " . $this->addQuotes( $value[0] );
1864                                 } else {
1865                                         $list .= $field . " IN (" . $this->makeList( $value ) . ") ";
1866                                 }
1867                         } elseif ( $value === null ) {
1868                                 if ( $mode == LIST_AND || $mode == LIST_OR ) {
1869                                         $list .= "$field IS ";
1870                                 } elseif ( $mode == LIST_SET ) {
1871                                         $list .= "$field = ";
1872                                 }
1873                                 $list .= 'NULL';
1874                         } else {
1875                                 if ( $mode == LIST_AND || $mode == LIST_OR || $mode == LIST_SET ) {
1876                                         $list .= "$field = ";
1877                                 }
1878                                 $list .= $mode == LIST_NAMES ? $value : $this->addQuotes( $value );
1879                         }
1880                 }
1881
1882                 return $list;
1883         }
1884
1885         /**
1886          * Build a partial where clause from a 2-d array such as used for LinkBatch.
1887          * The keys on each level may be either integers or strings.
1888          *
1889          * @param $data Array: organized as 2-d
1890          *              array(baseKeyVal => array(subKeyVal => [ignored], ...), ...)
1891          * @param $baseKey String: field name to match the base-level keys to (eg 'pl_namespace')
1892          * @param $subKey String: field name to match the sub-level keys to (eg 'pl_title')
1893          * @return Mixed: string SQL fragment, or false if no items in array.
1894          */
1895         public function makeWhereFrom2d( $data, $baseKey, $subKey ) {
1896                 $conds = array();
1897
1898                 foreach ( $data as $base => $sub ) {
1899                         if ( count( $sub ) ) {
1900                                 $conds[] = $this->makeList(
1901                                         array( $baseKey => $base, $subKey => array_keys( $sub ) ),
1902                                         LIST_AND );
1903                         }
1904                 }
1905
1906                 if ( $conds ) {
1907                         return $this->makeList( $conds, LIST_OR );
1908                 } else {
1909                         // Nothing to search for...
1910                         return false;
1911                 }
1912         }
1913
1914         /**
1915          * Return aggregated value alias
1916          *
1917          * @param $valuedata
1918          * @param $valuename string
1919          *
1920          * @return string
1921          */
1922         public function aggregateValue( $valuedata, $valuename = 'value' ) {
1923                 return $valuename;
1924         }
1925
1926         /**
1927          * @param $field
1928          * @return string
1929          */
1930         public function bitNot( $field ) {
1931                 return "(~$field)";
1932         }
1933
1934         /**
1935          * @param $fieldLeft
1936          * @param $fieldRight
1937          * @return string
1938          */
1939         public function bitAnd( $fieldLeft, $fieldRight ) {
1940                 return "($fieldLeft & $fieldRight)";
1941         }
1942
1943         /**
1944          * @param  $fieldLeft
1945          * @param  $fieldRight
1946          * @return string
1947          */
1948         public function bitOr( $fieldLeft, $fieldRight ) {
1949                 return "($fieldLeft | $fieldRight)";
1950         }
1951
1952         /**
1953          * Build a concatenation list to feed into a SQL query
1954          * @param $stringList Array: list of raw SQL expressions; caller is responsible for any quoting
1955          * @return String
1956          */
1957         public function buildConcat( $stringList ) {
1958                 return 'CONCAT(' . implode( ',', $stringList ) . ')';
1959         }
1960
1961         /**
1962          * Change the current database
1963          *
1964          * @todo Explain what exactly will fail if this is not overridden.
1965          *
1966          * @param $db
1967          *
1968          * @return bool Success or failure
1969          */
1970         public function selectDB( $db ) {
1971                 # Stub.  Shouldn't cause serious problems if it's not overridden, but
1972                 # if your database engine supports a concept similar to MySQL's
1973                 # databases you may as well.
1974                 $this->mDBname = $db;
1975                 return true;
1976         }
1977
1978         /**
1979          * Get the current DB name
1980          */
1981         public function getDBname() {
1982                 return $this->mDBname;
1983         }
1984
1985         /**
1986          * Get the server hostname or IP address
1987          */
1988         public function getServer() {
1989                 return $this->mServer;
1990         }
1991
1992         /**
1993          * Format a table name ready for use in constructing an SQL query
1994          *
1995          * This does two important things: it quotes the table names to clean them up,
1996          * and it adds a table prefix if only given a table name with no quotes.
1997          *
1998          * All functions of this object which require a table name call this function
1999          * themselves. Pass the canonical name to such functions. This is only needed
2000          * when calling query() directly.
2001          *
2002          * @param $name String: database table name
2003          * @param $format String One of:
2004          *   quoted - Automatically pass the table name through addIdentifierQuotes()
2005          *            so that it can be used in a query.
2006          *   raw - Do not add identifier quotes to the table name
2007          * @return String: full database name
2008          */
2009         public function tableName( $name, $format = 'quoted' ) {
2010                 global $wgSharedDB, $wgSharedPrefix, $wgSharedTables;
2011                 # Skip the entire process when we have a string quoted on both ends.
2012                 # Note that we check the end so that we will still quote any use of
2013                 # use of `database`.table. But won't break things if someone wants
2014                 # to query a database table with a dot in the name.
2015                 if ( $this->isQuotedIdentifier( $name ) ) {
2016                         return $name;
2017                 }
2018
2019                 # Lets test for any bits of text that should never show up in a table
2020                 # name. Basically anything like JOIN or ON which are actually part of
2021                 # SQL queries, but may end up inside of the table value to combine
2022                 # sql. Such as how the API is doing.
2023                 # Note that we use a whitespace test rather than a \b test to avoid
2024                 # any remote case where a word like on may be inside of a table name
2025                 # surrounded by symbols which may be considered word breaks.
2026                 if ( preg_match( '/(^|\s)(DISTINCT|JOIN|ON|AS)(\s|$)/i', $name ) !== 0 ) {
2027                         return $name;
2028                 }
2029
2030                 # Split database and table into proper variables.
2031                 # We reverse the explode so that database.table and table both output
2032                 # the correct table.
2033                 $dbDetails = array_reverse( explode( '.', $name, 2 ) );
2034                 if ( isset( $dbDetails[1] ) ) {
2035                         list( $table, $database ) = $dbDetails;
2036                 } else {
2037                         list( $table ) = $dbDetails;
2038                 }
2039                 $prefix = $this->mTablePrefix; # Default prefix
2040
2041                 # A database name has been specified in input. We don't want any
2042                 # prefixes added.
2043                 if ( isset( $database ) ) {
2044                         $prefix = '';
2045                 }
2046
2047                 # Note that we use the long format because php will complain in in_array if
2048                 # the input is not an array, and will complain in is_array if it is not set.
2049                 if ( !isset( $database ) # Don't use shared database if pre selected.
2050                  && isset( $wgSharedDB ) # We have a shared database
2051                  && !$this->isQuotedIdentifier( $table ) # Paranoia check to prevent shared tables listing '`table`'
2052                  && isset( $wgSharedTables )
2053                  && is_array( $wgSharedTables )
2054                  && in_array( $table, $wgSharedTables ) ) { # A shared table is selected
2055                         $database = $wgSharedDB;
2056                         $prefix   = isset( $wgSharedPrefix ) ? $wgSharedPrefix : $prefix;
2057                 }
2058
2059                 # Quote the $database and $table and apply the prefix if not quoted.
2060                 if ( isset( $database ) ) {
2061                         if ( $format == 'quoted' && !$this->isQuotedIdentifier( $database ) ) {
2062                                 $database = $this->addIdentifierQuotes( $database );
2063                         }
2064                 }
2065
2066                 $table = "{$prefix}{$table}";
2067                 if ( $format == 'quoted' && !$this->isQuotedIdentifier( $table ) ) {
2068                         $table = $this->addIdentifierQuotes( "{$table}" );
2069                 }
2070
2071                 # Merge our database and table into our final table name.
2072                 $tableName = ( isset( $database ) ? "{$database}.{$table}" : "{$table}" );
2073
2074                 return $tableName;
2075         }
2076
2077         /**
2078          * Fetch a number of table names into an array
2079          * This is handy when you need to construct SQL for joins
2080          *
2081          * Example:
2082          * extract($dbr->tableNames('user','watchlist'));
2083          * $sql = "SELECT wl_namespace,wl_title FROM $watchlist,$user
2084          *         WHERE wl_user=user_id AND wl_user=$nameWithQuotes";
2085          *
2086          * @return array
2087          */
2088         public function tableNames() {
2089                 $inArray = func_get_args();
2090                 $retVal = array();
2091
2092                 foreach ( $inArray as $name ) {
2093                         $retVal[$name] = $this->tableName( $name );
2094                 }
2095
2096                 return $retVal;
2097         }
2098
2099         /**
2100          * Fetch a number of table names into an zero-indexed numerical array
2101          * This is handy when you need to construct SQL for joins
2102          *
2103          * Example:
2104          * list( $user, $watchlist ) = $dbr->tableNamesN('user','watchlist');
2105          * $sql = "SELECT wl_namespace,wl_title FROM $watchlist,$user
2106          *         WHERE wl_user=user_id AND wl_user=$nameWithQuotes";
2107          *
2108          * @return array
2109          */
2110         public function tableNamesN() {
2111                 $inArray = func_get_args();
2112                 $retVal = array();
2113
2114                 foreach ( $inArray as $name ) {
2115                         $retVal[] = $this->tableName( $name );
2116                 }
2117
2118                 return $retVal;
2119         }
2120
2121         /**
2122          * Get an aliased table name
2123          * e.g. tableName AS newTableName
2124          *
2125          * @param $name string Table name, see tableName()
2126          * @param $alias string|bool Alias (optional)
2127          * @return string SQL name for aliased table. Will not alias a table to its own name
2128          */
2129         public function tableNameWithAlias( $name, $alias = false ) {
2130                 if ( !$alias || $alias == $name ) {
2131                         return $this->tableName( $name );
2132                 } else {
2133                         return $this->tableName( $name ) . ' ' . $this->addIdentifierQuotes( $alias );
2134                 }
2135         }
2136
2137         /**
2138          * Gets an array of aliased table names
2139          *
2140          * @param $tables array( [alias] => table )
2141          * @return array of strings, see tableNameWithAlias()
2142          */
2143         public function tableNamesWithAlias( $tables ) {
2144                 $retval = array();
2145                 foreach ( $tables as $alias => $table ) {
2146                         if ( is_numeric( $alias ) ) {
2147                                 $alias = $table;
2148                         }
2149                         $retval[] = $this->tableNameWithAlias( $table, $alias );
2150                 }
2151                 return $retval;
2152         }
2153
2154         /**
2155          * Get an aliased field name
2156          * e.g. fieldName AS newFieldName
2157          *
2158          * @param $name string Field name
2159          * @param $alias string|bool Alias (optional)
2160          * @return string SQL name for aliased field. Will not alias a field to its own name
2161          */
2162         public function fieldNameWithAlias( $name, $alias = false ) {
2163                 if ( !$alias || (string)$alias === (string)$name ) {
2164                         return $name;
2165                 } else {
2166                         return $name . ' AS ' . $alias; //PostgreSQL needs AS
2167                 }
2168         }
2169
2170         /**
2171          * Gets an array of aliased field names
2172          *
2173          * @param $fields array( [alias] => field )
2174          * @return array of strings, see fieldNameWithAlias()
2175          */
2176         public function fieldNamesWithAlias( $fields ) {
2177                 $retval = array();
2178                 foreach ( $fields as $alias => $field ) {
2179                         if ( is_numeric( $alias ) ) {
2180                                 $alias = $field;
2181                         }
2182                         $retval[] = $this->fieldNameWithAlias( $field, $alias );
2183                 }
2184                 return $retval;
2185         }
2186
2187         /**
2188          * Get the aliased table name clause for a FROM clause
2189          * which might have a JOIN and/or USE INDEX clause
2190          *
2191          * @param $tables array ( [alias] => table )
2192          * @param $use_index array Same as for select()
2193          * @param $join_conds array Same as for select()
2194          * @return string
2195          */
2196         protected function tableNamesWithUseIndexOrJOIN(
2197                 $tables, $use_index = array(), $join_conds = array()
2198         ) {
2199                 $ret = array();
2200                 $retJOIN = array();
2201                 $use_index = (array)$use_index;
2202                 $join_conds = (array)$join_conds;
2203
2204                 foreach ( $tables as $alias => $table ) {
2205                         if ( !is_string( $alias ) ) {
2206                                 // No alias? Set it equal to the table name
2207                                 $alias = $table;
2208                         }
2209                         // Is there a JOIN clause for this table?
2210                         if ( isset( $join_conds[$alias] ) ) {
2211                                 list( $joinType, $conds ) = $join_conds[$alias];
2212                                 $tableClause = $joinType;
2213                                 $tableClause .= ' ' . $this->tableNameWithAlias( $table, $alias );
2214                                 if ( isset( $use_index[$alias] ) ) { // has USE INDEX?
2215                                         $use = $this->useIndexClause( implode( ',', (array)$use_index[$alias] ) );
2216                                         if ( $use != '' ) {
2217                                                 $tableClause .= ' ' . $use;
2218                                         }
2219                                 }
2220                                 $on = $this->makeList( (array)$conds, LIST_AND );
2221                                 if ( $on != '' ) {
2222                                         $tableClause .= ' ON (' . $on . ')';
2223                                 }
2224
2225                                 $retJOIN[] = $tableClause;
2226                         // Is there an INDEX clause for this table?
2227                         } elseif ( isset( $use_index[$alias] ) ) {
2228                                 $tableClause = $this->tableNameWithAlias( $table, $alias );
2229                                 $tableClause .= ' ' . $this->useIndexClause(
2230                                         implode( ',', (array)$use_index[$alias] ) );
2231
2232                                 $ret[] = $tableClause;
2233                         } else {
2234                                 $tableClause = $this->tableNameWithAlias( $table, $alias );
2235
2236                                 $ret[] = $tableClause;
2237                         }
2238                 }
2239
2240                 // We can't separate explicit JOIN clauses with ',', use ' ' for those
2241                 $straightJoins = !empty( $ret ) ? implode( ',', $ret ) : "";
2242                 $otherJoins = !empty( $retJOIN ) ? implode( ' ', $retJOIN ) : "";
2243
2244                 // Compile our final table clause
2245                 return implode( ' ', array( $straightJoins, $otherJoins ) );
2246         }
2247
2248         /**
2249          * Get the name of an index in a given table
2250          *
2251          * @param $index
2252          *
2253          * @return string
2254          */
2255         protected function indexName( $index ) {
2256                 // Backwards-compatibility hack
2257                 $renamed = array(
2258                         'ar_usertext_timestamp' => 'usertext_timestamp',
2259                         'un_user_id'            => 'user_id',
2260                         'un_user_ip'            => 'user_ip',
2261                 );
2262
2263                 if ( isset( $renamed[$index] ) ) {
2264                         return $renamed[$index];
2265                 } else {
2266                         return $index;
2267                 }
2268         }
2269
2270         /**
2271          * If it's a string, adds quotes and backslashes
2272          * Otherwise returns as-is
2273          *
2274          * @param $s string
2275          *
2276          * @return string
2277          */
2278         public function addQuotes( $s ) {
2279                 if ( $s === null ) {
2280                         return 'NULL';
2281                 } else {
2282                         # This will also quote numeric values. This should be harmless,
2283                         # and protects against weird problems that occur when they really
2284                         # _are_ strings such as article titles and string->number->string
2285                         # conversion is not 1:1.
2286                         return "'" . $this->strencode( $s ) . "'";
2287                 }
2288         }
2289
2290         /**
2291          * Quotes an identifier using `backticks` or "double quotes" depending on the database type.
2292          * MySQL uses `backticks` while basically everything else uses double quotes.
2293          * Since MySQL is the odd one out here the double quotes are our generic
2294          * and we implement backticks in DatabaseMysql.
2295          *
2296          * @param $s string
2297          *
2298          * @return string
2299          */
2300         public function addIdentifierQuotes( $s ) {
2301                 return '"' . str_replace( '"', '""', $s ) . '"';
2302         }
2303
2304         /**
2305          * Returns if the given identifier looks quoted or not according to
2306          * the database convention for quoting identifiers .
2307          *
2308          * @param $name string
2309          *
2310          * @return boolean
2311          */
2312         public function isQuotedIdentifier( $name ) {
2313                 return $name[0] == '"' && substr( $name, -1, 1 ) == '"';
2314         }
2315
2316         /**
2317          * @param $s string
2318          * @return string
2319          */
2320         protected function escapeLikeInternal( $s ) {
2321                 $s = str_replace( '\\', '\\\\', $s );
2322                 $s = $this->strencode( $s );
2323                 $s = str_replace( array( '%', '_' ), array( '\%', '\_' ), $s );
2324
2325                 return $s;
2326         }
2327
2328         /**
2329          * LIKE statement wrapper, receives a variable-length argument list with parts of pattern to match
2330          * containing either string literals that will be escaped or tokens returned by anyChar() or anyString().
2331          * Alternatively, the function could be provided with an array of aforementioned parameters.
2332          *
2333          * Example: $dbr->buildLike( 'My_page_title/', $dbr->anyString() ) returns a LIKE clause that searches
2334          * for subpages of 'My page title'.
2335          * Alternatively: $pattern = array( 'My_page_title/', $dbr->anyString() ); $query .= $dbr->buildLike( $pattern );
2336          *
2337          * @since 1.16
2338          * @return String: fully built LIKE statement
2339          */
2340         public function buildLike() {
2341                 $params = func_get_args();
2342
2343                 if ( count( $params ) > 0 && is_array( $params[0] ) ) {
2344                         $params = $params[0];
2345                 }
2346
2347                 $s = '';
2348
2349                 foreach ( $params as $value ) {
2350                         if ( $value instanceof LikeMatch ) {
2351                                 $s .= $value->toString();
2352                         } else {
2353                                 $s .= $this->escapeLikeInternal( $value );
2354                         }
2355                 }
2356
2357                 return " LIKE '" . $s . "' ";
2358         }
2359
2360         /**
2361          * Returns a token for buildLike() that denotes a '_' to be used in a LIKE query
2362          *
2363          * @return LikeMatch
2364          */
2365         public function anyChar() {
2366                 return new LikeMatch( '_' );
2367         }
2368
2369         /**
2370          * Returns a token for buildLike() that denotes a '%' to be used in a LIKE query
2371          *
2372          * @return LikeMatch
2373          */
2374         public function anyString() {
2375                 return new LikeMatch( '%' );
2376         }
2377
2378         /**
2379          * Returns an appropriately quoted sequence value for inserting a new row.
2380          * MySQL has autoincrement fields, so this is just NULL. But the PostgreSQL
2381          * subclass will return an integer, and save the value for insertId()
2382          *
2383          * Any implementation of this function should *not* involve reusing
2384          * sequence numbers created for rolled-back transactions.
2385          * See http://bugs.mysql.com/bug.php?id=30767 for details.
2386          * @param $seqName string
2387          * @return null
2388          */
2389         public function nextSequenceValue( $seqName ) {
2390                 return null;
2391         }
2392
2393         /**
2394          * USE INDEX clause.  Unlikely to be useful for anything but MySQL.  This
2395          * is only needed because a) MySQL must be as efficient as possible due to
2396          * its use on Wikipedia, and b) MySQL 4.0 is kind of dumb sometimes about
2397          * which index to pick.  Anyway, other databases might have different
2398          * indexes on a given table.  So don't bother overriding this unless you're
2399          * MySQL.
2400          * @param $index
2401          * @return string
2402          */
2403         public function useIndexClause( $index ) {
2404                 return '';
2405         }
2406
2407         /**
2408          * REPLACE query wrapper.
2409          *
2410          * REPLACE is a very handy MySQL extension, which functions like an INSERT
2411          * except that when there is a duplicate key error, the old row is deleted
2412          * and the new row is inserted in its place.
2413          *
2414          * We simulate this with standard SQL with a DELETE followed by INSERT. To
2415          * perform the delete, we need to know what the unique indexes are so that
2416          * we know how to find the conflicting rows.
2417          *
2418          * It may be more efficient to leave off unique indexes which are unlikely
2419          * to collide. However if you do this, you run the risk of encountering
2420          * errors which wouldn't have occurred in MySQL.
2421          *
2422          * @param $table String: The table to replace the row(s) in.
2423          * @param $rows array Can be either a single row to insert, or multiple rows,
2424          *    in the same format as for DatabaseBase::insert()
2425          * @param $uniqueIndexes array is an array of indexes. Each element may be either
2426          *    a field name or an array of field names
2427          * @param $fname String: Calling function name (use __METHOD__) for logs/profiling
2428          */
2429         public function replace( $table, $uniqueIndexes, $rows, $fname = 'DatabaseBase::replace' ) {
2430                 $quotedTable = $this->tableName( $table );
2431
2432                 if ( count( $rows ) == 0 ) {
2433                         return;
2434                 }
2435
2436                 # Single row case
2437                 if ( !is_array( reset( $rows ) ) ) {
2438                         $rows = array( $rows );
2439                 }
2440
2441                 foreach( $rows as $row ) {
2442                         # Delete rows which collide
2443                         if ( $uniqueIndexes ) {
2444                                 $sql = "DELETE FROM $quotedTable WHERE ";
2445                                 $first = true;
2446                                 foreach ( $uniqueIndexes as $index ) {
2447                                         if ( $first ) {
2448                                                 $first = false;
2449                                                 $sql .= '( ';
2450                                         } else {
2451                                                 $sql .= ' ) OR ( ';
2452                                         }
2453                                         if ( is_array( $index ) ) {
2454                                                 $first2 = true;
2455                                                 foreach ( $index as $col ) {
2456                                                         if ( $first2 ) {
2457                                                                 $first2 = false;
2458                                                         } else {
2459                                                                 $sql .= ' AND ';
2460                                                         }
2461                                                         $sql .= $col . '=' . $this->addQuotes( $row[$col] );
2462                                                 }
2463                                         } else {
2464                                                 $sql .= $index . '=' . $this->addQuotes( $row[$index] );
2465                                         }
2466                                 }
2467                                 $sql .= ' )';
2468                                 $this->query( $sql, $fname );
2469                         }
2470
2471                         # Now insert the row
2472                         $this->insert( $table, $row );
2473                 }
2474         }
2475
2476         /**
2477          * REPLACE query wrapper for MySQL and SQLite, which have a native REPLACE
2478          * statement.
2479          *
2480          * @param $table string Table name
2481          * @param $rows array Rows to insert
2482          * @param $fname string Caller function name
2483          *
2484          * @return ResultWrapper
2485          */
2486         protected function nativeReplace( $table, $rows, $fname ) {
2487                 $table = $this->tableName( $table );
2488
2489                 # Single row case
2490                 if ( !is_array( reset( $rows ) ) ) {
2491                         $rows = array( $rows );
2492                 }
2493
2494                 $sql = "REPLACE INTO $table (" . implode( ',', array_keys( $rows[0] ) ) . ') VALUES ';
2495                 $first = true;
2496
2497                 foreach ( $rows as $row ) {
2498                         if ( $first ) {
2499                                 $first = false;
2500                         } else {
2501                                 $sql .= ',';
2502                         }
2503
2504                         $sql .= '(' . $this->makeList( $row ) . ')';
2505                 }
2506
2507                 return $this->query( $sql, $fname );
2508         }
2509
2510         /**
2511          * DELETE where the condition is a join.
2512          *
2513          * MySQL overrides this to use a multi-table DELETE syntax, in other databases
2514          * we use sub-selects
2515          *
2516          * For safety, an empty $conds will not delete everything. If you want to
2517          * delete all rows where the join condition matches, set $conds='*'.
2518          *
2519          * DO NOT put the join condition in $conds.
2520          *
2521          * @param $delTable   String: The table to delete from.
2522          * @param $joinTable  String: The other table.
2523          * @param $delVar     String: The variable to join on, in the first table.
2524          * @param $joinVar    String: The variable to join on, in the second table.
2525          * @param $conds      Array: Condition array of field names mapped to variables,
2526          *                    ANDed together in the WHERE clause
2527          * @param $fname      String: Calling function name (use __METHOD__) for
2528          *                    logs/profiling
2529          * @throws DBUnexpectedError
2530          */
2531         public function deleteJoin( $delTable, $joinTable, $delVar, $joinVar, $conds,
2532                 $fname = 'DatabaseBase::deleteJoin' )
2533         {
2534                 if ( !$conds ) {
2535                         throw new DBUnexpectedError( $this,
2536                                 'DatabaseBase::deleteJoin() called with empty $conds' );
2537                 }
2538
2539                 $delTable = $this->tableName( $delTable );
2540                 $joinTable = $this->tableName( $joinTable );
2541                 $sql = "DELETE FROM $delTable WHERE $delVar IN (SELECT $joinVar FROM $joinTable ";
2542                 if ( $conds != '*' ) {
2543                         $sql .= 'WHERE ' . $this->makeList( $conds, LIST_AND );
2544                 }
2545                 $sql .= ')';
2546
2547                 $this->query( $sql, $fname );
2548         }
2549
2550         /**
2551          * Returns the size of a text field, or -1 for "unlimited"
2552          *
2553          * @param $table string
2554          * @param $field string
2555          *
2556          * @return int
2557          */
2558         public function textFieldSize( $table, $field ) {
2559                 $table = $this->tableName( $table );
2560                 $sql = "SHOW COLUMNS FROM $table LIKE \"$field\";";
2561                 $res = $this->query( $sql, 'DatabaseBase::textFieldSize' );
2562                 $row = $this->fetchObject( $res );
2563
2564                 $m = array();
2565
2566                 if ( preg_match( '/\((.*)\)/', $row->Type, $m ) ) {
2567                         $size = $m[1];
2568                 } else {
2569                         $size = -1;
2570                 }
2571
2572                 return $size;
2573         }
2574
2575         /**
2576          * A string to insert into queries to show that they're low-priority, like
2577          * MySQL's LOW_PRIORITY.  If no such feature exists, return an empty
2578          * string and nothing bad should happen.
2579          *
2580          * @return string Returns the text of the low priority option if it is
2581          *   supported, or a blank string otherwise
2582          */
2583         public function lowPriorityOption() {
2584                 return '';
2585         }
2586
2587         /**
2588          * DELETE query wrapper.
2589          *
2590          * @param $table Array Table name
2591          * @param $conds String|Array of conditions. See $conds in DatabaseBase::select() for
2592          *               the format. Use $conds == "*" to delete all rows
2593          * @param $fname String name of the calling function
2594          *
2595          * @throws DBUnexpectedError
2596          * @return bool|ResultWrapper
2597          */
2598         public function delete( $table, $conds, $fname = 'DatabaseBase::delete' ) {
2599                 if ( !$conds ) {
2600                         throw new DBUnexpectedError( $this, 'DatabaseBase::delete() called with no conditions' );
2601                 }
2602
2603                 $table = $this->tableName( $table );
2604                 $sql = "DELETE FROM $table";
2605
2606                 if ( $conds != '*' ) {
2607                         $sql .= ' WHERE ' . $this->makeList( $conds, LIST_AND );
2608                 }
2609
2610                 return $this->query( $sql, $fname );
2611         }
2612
2613         /**
2614          * INSERT SELECT wrapper. Takes data from a SELECT query and inserts it
2615          * into another table.
2616          *
2617          * @param $destTable string The table name to insert into
2618          * @param $srcTable string|array May be either a table name, or an array of table names
2619          *    to include in a join.
2620          *
2621          * @param $varMap array must be an associative array of the form
2622          *    array( 'dest1' => 'source1', ...). Source items may be literals
2623          *    rather than field names, but strings should be quoted with
2624          *    DatabaseBase::addQuotes()
2625          *
2626          * @param $conds array Condition array. See $conds in DatabaseBase::select() for
2627          *    the details of the format of condition arrays. May be "*" to copy the
2628          *    whole table.
2629          *
2630          * @param $fname string The function name of the caller, from __METHOD__
2631          *
2632          * @param $insertOptions array Options for the INSERT part of the query, see
2633          *    DatabaseBase::insert() for details.
2634          * @param $selectOptions array Options for the SELECT part of the query, see
2635          *    DatabaseBase::select() for details.
2636          *
2637          * @return ResultWrapper
2638          */
2639         public function insertSelect( $destTable, $srcTable, $varMap, $conds,
2640                 $fname = 'DatabaseBase::insertSelect',
2641                 $insertOptions = array(), $selectOptions = array() )
2642         {
2643                 $destTable = $this->tableName( $destTable );
2644
2645                 if ( is_array( $insertOptions ) ) {
2646                         $insertOptions = implode( ' ', $insertOptions );
2647                 }
2648
2649                 if ( !is_array( $selectOptions ) ) {
2650                         $selectOptions = array( $selectOptions );
2651                 }
2652
2653                 list( $startOpts, $useIndex, $tailOpts ) = $this->makeSelectOptions( $selectOptions );
2654
2655                 if ( is_array( $srcTable ) ) {
2656                         $srcTable =  implode( ',', array_map( array( &$this, 'tableName' ), $srcTable ) );
2657                 } else {
2658                         $srcTable = $this->tableName( $srcTable );
2659                 }
2660
2661                 $sql = "INSERT $insertOptions INTO $destTable (" . implode( ',', array_keys( $varMap ) ) . ')' .
2662                         " SELECT $startOpts " . implode( ',', $varMap ) .
2663                         " FROM $srcTable $useIndex ";
2664
2665                 if ( $conds != '*' ) {
2666                         if ( is_array( $conds ) ) {
2667                                 $conds = $this->makeList( $conds, LIST_AND );
2668                         }
2669                         $sql .= " WHERE $conds";
2670                 }
2671
2672                 $sql .= " $tailOpts";
2673
2674                 return $this->query( $sql, $fname );
2675         }
2676
2677         /**
2678          * Construct a LIMIT query with optional offset.  This is used for query
2679          * pages.  The SQL should be adjusted so that only the first $limit rows
2680          * are returned.  If $offset is provided as well, then the first $offset
2681          * rows should be discarded, and the next $limit rows should be returned.
2682          * If the result of the query is not ordered, then the rows to be returned
2683          * are theoretically arbitrary.
2684          *
2685          * $sql is expected to be a SELECT, if that makes a difference.
2686          *
2687          * The version provided by default works in MySQL and SQLite.  It will very
2688          * likely need to be overridden for most other DBMSes.
2689          *
2690          * @param $sql String SQL query we will append the limit too
2691          * @param $limit Integer the SQL limit
2692          * @param $offset Integer|bool the SQL offset (default false)
2693          *
2694          * @throws DBUnexpectedError
2695          * @return string
2696          */
2697         public function limitResult( $sql, $limit, $offset = false ) {
2698                 if ( !is_numeric( $limit ) ) {
2699                         throw new DBUnexpectedError( $this, "Invalid non-numeric limit passed to limitResult()\n" );
2700                 }
2701                 return "$sql LIMIT "
2702                         . ( ( is_numeric( $offset ) && $offset != 0 ) ? "{$offset}," : "" )
2703                         . "{$limit} ";
2704         }
2705
2706         /**
2707          * Returns true if current database backend supports ORDER BY or LIMIT for separate subqueries
2708          * within the UNION construct.
2709          * @return Boolean
2710          */
2711         public function unionSupportsOrderAndLimit() {
2712                 return true; // True for almost every DB supported
2713         }
2714
2715         /**
2716          * Construct a UNION query
2717          * This is used for providing overload point for other DB abstractions
2718          * not compatible with the MySQL syntax.
2719          * @param $sqls Array: SQL statements to combine
2720          * @param $all Boolean: use UNION ALL
2721          * @return String: SQL fragment
2722          */
2723         public function unionQueries( $sqls, $all ) {
2724                 $glue = $all ? ') UNION ALL (' : ') UNION (';
2725                 return '(' . implode( $glue, $sqls ) . ')';
2726         }
2727
2728         /**
2729          * Returns an SQL expression for a simple conditional.  This doesn't need
2730          * to be overridden unless CASE isn't supported in your DBMS.
2731          *
2732          * @param $cond string|array SQL expression which will result in a boolean value
2733          * @param $trueVal String: SQL expression to return if true
2734          * @param $falseVal String: SQL expression to return if false
2735          * @return String: SQL fragment
2736          */
2737         public function conditional( $cond, $trueVal, $falseVal ) {
2738                 if ( is_array( $cond ) ) {
2739                         $cond = $this->makeList( $cond, LIST_AND );
2740                 }
2741                 return " (CASE WHEN $cond THEN $trueVal ELSE $falseVal END) ";
2742         }
2743
2744         /**
2745          * Returns a comand for str_replace function in SQL query.
2746          * Uses REPLACE() in MySQL
2747          *
2748          * @param $orig String: column to modify
2749          * @param $old String: column to seek
2750          * @param $new String: column to replace with
2751          *
2752          * @return string
2753          */
2754         public function strreplace( $orig, $old, $new ) {
2755                 return "REPLACE({$orig}, {$old}, {$new})";
2756         }
2757
2758         /**
2759          * Determines how long the server has been up
2760          * STUB
2761          *
2762          * @return int
2763          */
2764         public function getServerUptime() {
2765                 return 0;
2766         }
2767
2768         /**
2769          * Determines if the last failure was due to a deadlock
2770          * STUB
2771          *
2772          * @return bool
2773          */
2774         public function wasDeadlock() {
2775                 return false;
2776         }
2777
2778         /**
2779          * Determines if the last failure was due to a lock timeout
2780          * STUB
2781          *
2782          * @return bool
2783          */
2784         public function wasLockTimeout() {
2785                 return false;
2786         }
2787
2788         /**
2789          * Determines if the last query error was something that should be dealt
2790          * with by pinging the connection and reissuing the query.
2791          * STUB
2792          *
2793          * @return bool
2794          */
2795         public function wasErrorReissuable() {
2796                 return false;
2797         }
2798
2799         /**
2800          * Determines if the last failure was due to the database being read-only.
2801          * STUB
2802          *
2803          * @return bool
2804          */
2805         public function wasReadOnlyError() {
2806                 return false;
2807         }
2808
2809         /**
2810          * Perform a deadlock-prone transaction.
2811          *
2812          * This function invokes a callback function to perform a set of write
2813          * queries. If a deadlock occurs during the processing, the transaction
2814          * will be rolled back and the callback function will be called again.
2815          *
2816          * Usage:
2817          *   $dbw->deadlockLoop( callback, ... );
2818          *
2819          * Extra arguments are passed through to the specified callback function.
2820          *
2821          * Returns whatever the callback function returned on its successful,
2822          * iteration, or false on error, for example if the retry limit was
2823          * reached.
2824          *
2825          * @return bool
2826          */
2827         public function deadlockLoop() {
2828                 $this->begin( __METHOD__ );
2829                 $args = func_get_args();
2830                 $function = array_shift( $args );
2831                 $oldIgnore = $this->ignoreErrors( true );
2832                 $tries = DEADLOCK_TRIES;
2833
2834                 if ( is_array( $function ) ) {
2835                         $fname = $function[0];
2836                 } else {
2837                         $fname = $function;
2838                 }
2839
2840                 do {
2841                         $retVal = call_user_func_array( $function, $args );
2842                         $error = $this->lastError();
2843                         $errno = $this->lastErrno();
2844                         $sql = $this->lastQuery();
2845
2846                         if ( $errno ) {
2847                                 if ( $this->wasDeadlock() ) {
2848                                         # Retry
2849                                         usleep( mt_rand( DEADLOCK_DELAY_MIN, DEADLOCK_DELAY_MAX ) );
2850                                 } else {
2851                                         $this->reportQueryError( $error, $errno, $sql, $fname );
2852                                 }
2853                         }
2854                 } while ( $this->wasDeadlock() && --$tries > 0 );
2855
2856                 $this->ignoreErrors( $oldIgnore );
2857
2858                 if ( $tries <= 0 ) {
2859                         $this->rollback( __METHOD__ );
2860                         $this->reportQueryError( $error, $errno, $sql, $fname );
2861                         return false;
2862                 } else {
2863                         $this->commit( __METHOD__ );
2864                         return $retVal;
2865                 }
2866         }
2867
2868         /**
2869          * Wait for the slave to catch up to a given master position.
2870          *
2871          * @param $pos DBMasterPos object
2872          * @param $timeout Integer: the maximum number of seconds to wait for
2873          *   synchronisation
2874          *
2875          * @return integer: zero if the slave was past that position already,
2876          *   greater than zero if we waited for some period of time, less than
2877          *   zero if we timed out.
2878          */
2879         public function masterPosWait( DBMasterPos $pos, $timeout ) {
2880                 wfProfileIn( __METHOD__ );
2881
2882                 if ( !is_null( $this->mFakeSlaveLag ) ) {
2883                         $wait = intval( ( $pos->pos - microtime( true ) + $this->mFakeSlaveLag ) * 1e6 );
2884
2885                         if ( $wait > $timeout * 1e6 ) {
2886                                 wfDebug( "Fake slave timed out waiting for $pos ($wait us)\n" );
2887                                 wfProfileOut( __METHOD__ );
2888                                 return -1;
2889                         } elseif ( $wait > 0 ) {
2890                                 wfDebug( "Fake slave waiting $wait us\n" );
2891                                 usleep( $wait );
2892                                 wfProfileOut( __METHOD__ );
2893                                 return 1;
2894                         } else {
2895                                 wfDebug( "Fake slave up to date ($wait us)\n" );
2896                                 wfProfileOut( __METHOD__ );
2897                                 return 0;
2898                         }
2899                 }
2900
2901                 wfProfileOut( __METHOD__ );
2902
2903                 # Real waits are implemented in the subclass.
2904                 return 0;
2905         }
2906
2907         /**
2908          * Get the replication position of this slave
2909          *
2910          * @return DBMasterPos, or false if this is not a slave.
2911          */
2912         public function getSlavePos() {
2913                 if ( !is_null( $this->mFakeSlaveLag ) ) {
2914                         $pos = new MySQLMasterPos( 'fake', microtime( true ) - $this->mFakeSlaveLag );
2915                         wfDebug( __METHOD__ . ": fake slave pos = $pos\n" );
2916                         return $pos;
2917                 } else {
2918                         # Stub
2919                         return false;
2920                 }
2921         }
2922
2923         /**
2924          * Get the position of this master
2925          *
2926          * @return DBMasterPos, or false if this is not a master
2927          */
2928         public function getMasterPos() {
2929                 if ( $this->mFakeMaster ) {
2930                         return new MySQLMasterPos( 'fake', microtime( true ) );
2931                 } else {
2932                         return false;
2933                 }
2934         }
2935
2936         /**
2937          * Run an anonymous function as soon as there is no transaction pending.
2938          * If there is a transaction and it is rolled back, then the callback is cancelled.
2939          * Callbacks must commit any transactions that they begin.
2940          *
2941          * This is useful for updates to different systems or separate transactions are needed.
2942          *
2943          * @since 1.20
2944          *
2945          * @param Closure $callback
2946          */
2947         final public function onTransactionIdle( Closure $callback ) {
2948                 if ( $this->mTrxLevel ) {
2949                         $this->mTrxIdleCallbacks[] = $callback;
2950                 } else {
2951                         $callback();
2952                 }
2953         }
2954
2955         /**
2956          * Actually run the "on transaction idle" callbacks.
2957          *
2958          * @since 1.20
2959          */
2960         protected function runOnTransactionIdleCallbacks() {
2961                 $autoTrx = $this->getFlag( DBO_TRX ); // automatic begin() enabled?
2962
2963                 $e = null; // last exception
2964                 do { // callbacks may add callbacks :)
2965                         $callbacks = $this->mTrxIdleCallbacks;
2966                         $this->mTrxIdleCallbacks = array(); // recursion guard
2967                         foreach ( $callbacks as $callback ) {
2968                                 try {
2969                                         $this->clearFlag( DBO_TRX ); // make each query its own transaction
2970                                         $callback();
2971                                         $this->setFlag( $autoTrx ? DBO_TRX : 0 ); // restore automatic begin()
2972                                 } catch ( Exception $e ) {}
2973                         }
2974                 } while ( count( $this->mTrxIdleCallbacks ) );
2975
2976                 if ( $e instanceof Exception ) {
2977                         throw $e; // re-throw any last exception
2978                 }
2979         }
2980
2981         /**
2982          * Begin a transaction. If a transaction is already in progress, that transaction will be committed before the
2983          * new transaction is started.
2984          *
2985          * Note that when the DBO_TRX flag is set (which is usually the case for web requests, but not for maintenance scripts),
2986          * any previous database query will have started a transaction automatically.
2987          *
2988          * Nesting of transactions is not supported. Attempts to nest transactions will cause a warning, unless the current
2989          * transaction was started automatically because of the DBO_TRX flag.
2990          *
2991          * @param $fname string
2992          */
2993         final public function begin( $fname = 'DatabaseBase::begin' ) {
2994                 global $wgDebugDBTransactions;
2995
2996                 if ( $this->mTrxLevel ) { // implicit commit
2997                         if ( !$this->mTrxAutomatic ) {
2998                                 // We want to warn about inadvertently nested begin/commit pairs, but not about auto-committing
2999                                 // implicit transactions that were started by query() because DBO_TRX was set.
3000
3001                                 wfWarn( "$fname: Transaction already in progress (from {$this->mTrxFname}), " .
3002                                         " performing implicit commit!" );
3003                         } else {
3004                                 // if the transaction was automatic and has done write operations,
3005                                 // log it if $wgDebugDBTransactions is enabled.
3006
3007                                 if ( $this->mTrxDoneWrites && $wgDebugDBTransactions ) {
3008                                         wfDebug( "$fname: Automatic transaction with writes in progress (from {$this->mTrxFname}), " .
3009                                                 " performing implicit commit!\n" );
3010                                 }
3011                         }
3012
3013                         $this->doCommit( $fname );
3014                         $this->runOnTransactionIdleCallbacks();
3015                 }
3016
3017                 $this->doBegin( $fname );
3018                 $this->mTrxFname = $fname;
3019                 $this->mTrxDoneWrites = false;
3020                 $this->mTrxAutomatic = false;
3021         }
3022
3023         /**
3024          * Issues the BEGIN command to the database server.
3025          *
3026          * @see DatabaseBase::begin()
3027          * @param type $fname
3028          */
3029         protected function doBegin( $fname ) {
3030                 $this->query( 'BEGIN', $fname );
3031                 $this->mTrxLevel = 1;
3032         }
3033
3034         /**
3035          * Commits a transaction previously started using begin().
3036          * If no transaction is in progress, a warning is issued.
3037          *
3038          * Nesting of transactions is not supported.
3039          *
3040          * @param $fname string
3041          * @param $flush String Flush flag, set to 'flush' to disable warnings about explicitly committing implicit
3042          *        transactions, or calling commit when no transaction is in progress.
3043          *        This will silently break any ongoing explicit transaction. Only set the flush flag if you are sure
3044          *        that it is safe to ignore these warnings in your context.
3045          */
3046         final public function commit( $fname = 'DatabaseBase::commit', $flush = '' ) {
3047                 if ( $flush != 'flush' ) {
3048                         if ( !$this->mTrxLevel ) {
3049                                 wfWarn( "$fname: No transaction to commit, something got out of sync!" );
3050                         } elseif( $this->mTrxAutomatic ) {
3051                                 wfWarn( "$fname: Explicit commit of implicit transaction. Something may be out of sync!" );
3052                         }
3053                 } else {
3054                         if ( !$this->mTrxLevel ) {
3055                                 return; // nothing to do
3056                         } elseif( !$this->mTrxAutomatic ) {
3057                                 wfWarn( "$fname: Flushing an explicit transaction, getting out of sync!" );
3058                         }
3059                 }
3060
3061                 $this->doCommit( $fname );
3062                 $this->runOnTransactionIdleCallbacks();
3063         }
3064
3065         /**
3066          * Issues the COMMIT command to the database server.
3067          *
3068          * @see DatabaseBase::commit()
3069          * @param type $fname
3070          */
3071         protected function doCommit( $fname ) {
3072                 if ( $this->mTrxLevel ) {
3073                         $this->query( 'COMMIT', $fname );
3074                         $this->mTrxLevel = 0;
3075                 }
3076         }
3077
3078         /**
3079          * Rollback a transaction previously started using begin().
3080          * If no transaction is in progress, a warning is issued.
3081          *
3082          * No-op on non-transactional databases.
3083          *
3084          * @param $fname string
3085          */
3086         final public function rollback( $fname = 'DatabaseBase::rollback' ) {
3087                 if ( !$this->mTrxLevel ) {
3088                         wfWarn( "$fname: No transaction to rollback, something got out of sync!" );
3089                 }
3090                 $this->doRollback( $fname );
3091                 $this->mTrxIdleCallbacks = array(); // cancel
3092         }
3093
3094         /**
3095          * Issues the ROLLBACK command to the database server.
3096          *
3097          * @see DatabaseBase::rollback()
3098          * @param type $fname
3099          */
3100         protected function doRollback( $fname ) {
3101                 if ( $this->mTrxLevel ) {
3102                         $this->query( 'ROLLBACK', $fname, true );
3103                         $this->mTrxLevel = 0;
3104                 }
3105         }
3106
3107         /**
3108          * Creates a new table with structure copied from existing table
3109          * Note that unlike most database abstraction functions, this function does not
3110          * automatically append database prefix, because it works at a lower
3111          * abstraction level.
3112          * The table names passed to this function shall not be quoted (this
3113          * function calls addIdentifierQuotes when needed).
3114          *
3115          * @param $oldName String: name of table whose structure should be copied
3116          * @param $newName String: name of table to be created
3117          * @param $temporary Boolean: whether the new table should be temporary
3118          * @param $fname String: calling function name
3119          * @throws MWException
3120          * @return Boolean: true if operation was successful
3121          */
3122         public function duplicateTableStructure( $oldName, $newName, $temporary = false,
3123                 $fname = 'DatabaseBase::duplicateTableStructure' )
3124         {
3125                 throw new MWException(
3126                         'DatabaseBase::duplicateTableStructure is not implemented in descendant class' );
3127         }
3128
3129         /**
3130          * List all tables on the database
3131          *
3132          * @param $prefix string Only show tables with this prefix, e.g. mw_
3133          * @param $fname String: calling function name
3134          * @throws MWException
3135          */
3136         function listTables( $prefix = null, $fname = 'DatabaseBase::listTables' ) {
3137                 throw new MWException( 'DatabaseBase::listTables is not implemented in descendant class' );
3138         }
3139
3140         /**
3141          * Convert a timestamp in one of the formats accepted by wfTimestamp()
3142          * to the format used for inserting into timestamp fields in this DBMS.
3143          *
3144          * The result is unquoted, and needs to be passed through addQuotes()
3145          * before it can be included in raw SQL.
3146          *
3147          * @param $ts string|int
3148          *
3149          * @return string
3150          */
3151         public function timestamp( $ts = 0 ) {
3152                 return wfTimestamp( TS_MW, $ts );
3153         }
3154
3155         /**
3156          * Convert a timestamp in one of the formats accepted by wfTimestamp()
3157          * to the format used for inserting into timestamp fields in this DBMS. If
3158          * NULL is input, it is passed through, allowing NULL values to be inserted
3159          * into timestamp fields.
3160          *
3161          * The result is unquoted, and needs to be passed through addQuotes()
3162          * before it can be included in raw SQL.
3163          *
3164          * @param $ts string|int
3165          *
3166          * @return string
3167          */
3168         public function timestampOrNull( $ts = null ) {
3169                 if ( is_null( $ts ) ) {
3170                         return null;
3171                 } else {
3172                         return $this->timestamp( $ts );
3173                 }
3174         }
3175
3176         /**
3177          * Take the result from a query, and wrap it in a ResultWrapper if
3178          * necessary. Boolean values are passed through as is, to indicate success
3179          * of write queries or failure.
3180          *
3181          * Once upon a time, DatabaseBase::query() returned a bare MySQL result
3182          * resource, and it was necessary to call this function to convert it to
3183          * a wrapper. Nowadays, raw database objects are never exposed to external
3184          * callers, so this is unnecessary in external code. For compatibility with
3185          * old code, ResultWrapper objects are passed through unaltered.
3186          *
3187          * @param $result bool|ResultWrapper
3188          *
3189          * @return bool|ResultWrapper
3190          */
3191         public function resultObject( $result ) {
3192                 if ( empty( $result ) ) {
3193                         return false;
3194                 } elseif ( $result instanceof ResultWrapper ) {
3195                         return $result;
3196                 } elseif ( $result === true ) {
3197                         // Successful write query
3198                         return $result;
3199                 } else {
3200                         return new ResultWrapper( $this, $result );
3201                 }
3202         }
3203
3204         /**
3205          * Ping the server and try to reconnect if it there is no connection
3206          *
3207          * @return bool Success or failure
3208          */
3209         public function ping() {
3210                 # Stub.  Not essential to override.
3211                 return true;
3212         }
3213
3214         /**
3215          * Get slave lag. Currently supported only by MySQL.
3216          *
3217          * Note that this function will generate a fatal error on many
3218          * installations. Most callers should use LoadBalancer::safeGetLag()
3219          * instead.
3220          *
3221          * @return int Database replication lag in seconds
3222          */
3223         public function getLag() {
3224                 return intval( $this->mFakeSlaveLag );
3225         }
3226
3227         /**
3228          * Return the maximum number of items allowed in a list, or 0 for unlimited.
3229          *
3230          * @return int
3231          */
3232         function maxListLen() {
3233                 return 0;
3234         }
3235
3236         /**
3237          * Some DBMSs have a special format for inserting into blob fields, they
3238          * don't allow simple quoted strings to be inserted. To insert into such
3239          * a field, pass the data through this function before passing it to
3240          * DatabaseBase::insert().
3241          * @param $b string
3242          * @return string
3243          */
3244         public function encodeBlob( $b ) {
3245                 return $b;
3246         }
3247
3248         /**
3249          * Some DBMSs return a special placeholder object representing blob fields
3250          * in result objects. Pass the object through this function to return the
3251          * original string.
3252          * @param $b string
3253          * @return string
3254          */
3255         public function decodeBlob( $b ) {
3256                 return $b;
3257         }
3258
3259         /**
3260          * Override database's default behavior. $options include:
3261          *     'connTimeout' : Set the connection timeout value in seconds.
3262          *                     May be useful for very long batch queries such as
3263          *                     full-wiki dumps, where a single query reads out over
3264          *                     hours or days.
3265          *
3266          * @param $options Array
3267          * @return void
3268          */
3269         public function setSessionOptions( array $options ) {}
3270
3271         /**
3272          * Read and execute SQL commands from a file.
3273          *
3274          * Returns true on success, error string or exception on failure (depending
3275          * on object's error ignore settings).
3276          *
3277          * @param $filename String: File name to open
3278          * @param bool|callable $lineCallback Optional function called before reading each line
3279          * @param bool|callable $resultCallback Optional function called for each MySQL result
3280          * @param bool|string $fname Calling function name or false if name should be
3281          *      generated dynamically using $filename
3282          * @param bool|callable $inputCallback Callback: Optional function called for each complete line sent
3283          * @throws MWException
3284          * @throws Exception|MWException
3285          * @return bool|string
3286          */
3287         public function sourceFile(
3288                 $filename, $lineCallback = false, $resultCallback = false, $fname = false, $inputCallback = false
3289         ) {
3290                 wfSuppressWarnings();
3291                 $fp = fopen( $filename, 'r' );
3292                 wfRestoreWarnings();
3293
3294                 if ( false === $fp ) {
3295                         throw new MWException( "Could not open \"{$filename}\".\n" );
3296                 }
3297
3298                 if ( !$fname ) {
3299                         $fname = __METHOD__ . "( $filename )";
3300                 }
3301
3302                 try {
3303                         $error = $this->sourceStream( $fp, $lineCallback, $resultCallback, $fname, $inputCallback );
3304                 }
3305                 catch ( MWException $e ) {
3306                         fclose( $fp );
3307                         throw $e;
3308                 }
3309
3310                 fclose( $fp );
3311
3312                 return $error;
3313         }
3314
3315         /**
3316          * Get the full path of a patch file. Originally based on archive()
3317          * from updaters.inc. Keep in mind this always returns a patch, as
3318          * it fails back to MySQL if no DB-specific patch can be found
3319          *
3320          * @param $patch String The name of the patch, like patch-something.sql
3321          * @return String Full path to patch file
3322          */
3323         public function patchPath( $patch ) {
3324                 global $IP;
3325
3326                 $dbType = $this->getType();
3327                 if ( file_exists( "$IP/maintenance/$dbType/archives/$patch" ) ) {
3328                         return "$IP/maintenance/$dbType/archives/$patch";
3329                 } else {
3330                         return "$IP/maintenance/archives/$patch";
3331                 }
3332         }
3333
3334         /**
3335          * Set variables to be used in sourceFile/sourceStream, in preference to the
3336          * ones in $GLOBALS. If an array is set here, $GLOBALS will not be used at
3337          * all. If it's set to false, $GLOBALS will be used.
3338          *
3339          * @param $vars bool|array mapping variable name to value.
3340          */
3341         public function setSchemaVars( $vars ) {
3342                 $this->mSchemaVars = $vars;
3343         }
3344
3345         /**
3346          * Read and execute commands from an open file handle.
3347          *
3348          * Returns true on success, error string or exception on failure (depending
3349          * on object's error ignore settings).
3350          *
3351          * @param $fp Resource: File handle
3352          * @param $lineCallback Callback: Optional function called before reading each query
3353          * @param $resultCallback Callback: Optional function called for each MySQL result
3354          * @param $fname String: Calling function name
3355          * @param $inputCallback Callback: Optional function called for each complete query sent
3356          * @return bool|string
3357          */
3358         public function sourceStream( $fp, $lineCallback = false, $resultCallback = false,
3359                 $fname = 'DatabaseBase::sourceStream', $inputCallback = false )
3360         {
3361                 $cmd = '';
3362
3363                 while ( !feof( $fp ) ) {
3364                         if ( $lineCallback ) {
3365                                 call_user_func( $lineCallback );
3366                         }
3367
3368                         $line = trim( fgets( $fp ) );
3369
3370                         if ( $line == '' ) {
3371                                 continue;
3372                         }
3373
3374                         if ( '-' == $line[0] && '-' == $line[1] ) {
3375                                 continue;
3376                         }
3377
3378                         if ( $cmd != '' ) {
3379                                 $cmd .= ' ';
3380                         }
3381
3382                         $done = $this->streamStatementEnd( $cmd, $line );
3383
3384                         $cmd .= "$line\n";
3385
3386                         if ( $done || feof( $fp ) ) {
3387                                 $cmd = $this->replaceVars( $cmd );
3388
3389                                 if ( ( $inputCallback && call_user_func( $inputCallback, $cmd ) ) || !$inputCallback ) {
3390                                         $res = $this->query( $cmd, $fname );
3391
3392                                         if ( $resultCallback ) {
3393                                                 call_user_func( $resultCallback, $res, $this );
3394                                         }
3395
3396                                         if ( false === $res ) {
3397                                                 $err = $this->lastError();
3398                                                 return "Query \"{$cmd}\" failed with error code \"$err\".\n";
3399                                         }
3400                                 }
3401                                 $cmd = '';
3402                         }
3403                 }
3404
3405                 return true;
3406         }
3407
3408         /**
3409          * Called by sourceStream() to check if we've reached a statement end
3410          *
3411          * @param $sql String SQL assembled so far
3412          * @param $newLine String New line about to be added to $sql
3413          * @return Bool Whether $newLine contains end of the statement
3414          */
3415         public function streamStatementEnd( &$sql, &$newLine ) {
3416                 if ( $this->delimiter ) {
3417                         $prev = $newLine;
3418                         $newLine = preg_replace( '/' . preg_quote( $this->delimiter, '/' ) . '$/', '', $newLine );
3419                         if ( $newLine != $prev ) {
3420                                 return true;
3421                         }
3422                 }
3423                 return false;
3424         }
3425
3426         /**
3427          * Database independent variable replacement. Replaces a set of variables
3428          * in an SQL statement with their contents as given by $this->getSchemaVars().
3429          *
3430          * Supports '{$var}' `{$var}` and / *$var* / (without the spaces) style variables.
3431          *
3432          * - '{$var}' should be used for text and is passed through the database's
3433          *   addQuotes method.
3434          * - `{$var}` should be used for identifiers (eg: table and database names),
3435          *   it is passed through the database's addIdentifierQuotes method which
3436          *   can be overridden if the database uses something other than backticks.
3437          * - / *$var* / is just encoded, besides traditional table prefix and
3438          *   table options its use should be avoided.
3439          *
3440          * @param $ins String: SQL statement to replace variables in
3441          * @return String The new SQL statement with variables replaced
3442          */
3443         protected function replaceSchemaVars( $ins ) {
3444                 $vars = $this->getSchemaVars();
3445                 foreach ( $vars as $var => $value ) {
3446                         // replace '{$var}'
3447                         $ins = str_replace( '\'{$' . $var . '}\'', $this->addQuotes( $value ), $ins );
3448                         // replace `{$var}`
3449                         $ins = str_replace( '`{$' . $var . '}`', $this->addIdentifierQuotes( $value ), $ins );
3450                         // replace /*$var*/
3451                         $ins = str_replace( '/*$' . $var . '*/', $this->strencode( $value ) , $ins );
3452                 }
3453                 return $ins;
3454         }
3455
3456         /**
3457          * Replace variables in sourced SQL
3458          *
3459          * @param $ins string
3460          *
3461          * @return string
3462          */
3463         protected function replaceVars( $ins ) {
3464                 $ins = $this->replaceSchemaVars( $ins );
3465
3466                 // Table prefixes
3467                 $ins = preg_replace_callback( '!/\*(?:\$wgDBprefix|_)\*/([a-zA-Z_0-9]*)!',
3468                         array( $this, 'tableNameCallback' ), $ins );
3469
3470                 // Index names
3471                 $ins = preg_replace_callback( '!/\*i\*/([a-zA-Z_0-9]*)!',
3472                         array( $this, 'indexNameCallback' ), $ins );
3473
3474                 return $ins;
3475         }
3476
3477         /**
3478          * Get schema variables. If none have been set via setSchemaVars(), then
3479          * use some defaults from the current object.
3480          *
3481          * @return array
3482          */
3483         protected function getSchemaVars() {
3484                 if ( $this->mSchemaVars ) {
3485                         return $this->mSchemaVars;
3486                 } else {
3487                         return $this->getDefaultSchemaVars();
3488                 }
3489         }
3490
3491         /**
3492          * Get schema variables to use if none have been set via setSchemaVars().
3493          *
3494          * Override this in derived classes to provide variables for tables.sql
3495          * and SQL patch files.
3496          *
3497          * @return array
3498          */
3499         protected function getDefaultSchemaVars() {
3500                 return array();
3501         }
3502
3503         /**
3504          * Table name callback
3505          *
3506          * @param $matches array
3507          *
3508          * @return string
3509          */
3510         protected function tableNameCallback( $matches ) {
3511                 return $this->tableName( $matches[1] );
3512         }
3513
3514         /**
3515          * Index name callback
3516          *
3517          * @param $matches array
3518          *
3519          * @return string
3520          */
3521         protected function indexNameCallback( $matches ) {
3522                 return $this->indexName( $matches[1] );
3523         }
3524
3525         /**
3526          * Check to see if a named lock is available. This is non-blocking.
3527          *
3528          * @param $lockName String: name of lock to poll
3529          * @param $method String: name of method calling us
3530          * @return Boolean
3531          * @since 1.20
3532          */
3533         public function lockIsFree( $lockName, $method ) {
3534                 return true;
3535         }
3536
3537         /**
3538          * Acquire a named lock
3539          *
3540          * Abstracted from Filestore::lock() so child classes can implement for
3541          * their own needs.
3542          *
3543          * @param $lockName String: name of lock to aquire
3544          * @param $method String: name of method calling us
3545          * @param $timeout Integer: timeout
3546          * @return Boolean
3547          */
3548         public function lock( $lockName, $method, $timeout = 5 ) {
3549                 return true;
3550         }
3551
3552         /**
3553          * Release a lock.
3554          *
3555          * @param $lockName String: Name of lock to release
3556          * @param $method String: Name of method calling us
3557          *
3558          * @return int Returns 1 if the lock was released, 0 if the lock was not established
3559          * by this thread (in which case the lock is not released), and NULL if the named
3560          * lock did not exist
3561          */
3562         public function unlock( $lockName, $method ) {
3563                 return true;
3564         }
3565
3566         /**
3567          * Lock specific tables
3568          *
3569          * @param $read Array of tables to lock for read access
3570          * @param $write Array of tables to lock for write access
3571          * @param $method String name of caller
3572          * @param $lowPriority bool Whether to indicate writes to be LOW PRIORITY
3573          *
3574          * @return bool
3575          */
3576         public function lockTables( $read, $write, $method, $lowPriority = true ) {
3577                 return true;
3578         }
3579
3580         /**
3581          * Unlock specific tables
3582          *
3583          * @param $method String the caller
3584          *
3585          * @return bool
3586          */
3587         public function unlockTables( $method ) {
3588                 return true;
3589         }
3590
3591         /**
3592          * Delete a table
3593          * @param $tableName string
3594          * @param $fName string
3595          * @return bool|ResultWrapper
3596          * @since 1.18
3597          */
3598         public function dropTable( $tableName, $fName = 'DatabaseBase::dropTable' ) {
3599                 if( !$this->tableExists( $tableName, $fName ) ) {
3600                         return false;
3601                 }
3602                 $sql = "DROP TABLE " . $this->tableName( $tableName );
3603                 if( $this->cascadingDeletes() ) {
3604                         $sql .= " CASCADE";
3605                 }
3606                 return $this->query( $sql, $fName );
3607         }
3608
3609         /**
3610          * Get search engine class. All subclasses of this need to implement this
3611          * if they wish to use searching.
3612          *
3613          * @return String
3614          */
3615         public function getSearchEngine() {
3616                 return 'SearchEngineDummy';
3617         }
3618
3619         /**
3620          * Find out when 'infinity' is. Most DBMSes support this. This is a special
3621          * keyword for timestamps in PostgreSQL, and works with CHAR(14) as well
3622          * because "i" sorts after all numbers.
3623          *
3624          * @return String
3625          */
3626         public function getInfinity() {
3627                 return 'infinity';
3628         }
3629
3630         /**
3631          * Encode an expiry time into the DBMS dependent format
3632          *
3633          * @param $expiry String: timestamp for expiry, or the 'infinity' string
3634          * @return String
3635          */
3636         public function encodeExpiry( $expiry ) {
3637                 return ( $expiry == '' || $expiry == 'infinity' || $expiry == $this->getInfinity() )
3638                         ? $this->getInfinity()
3639                         : $this->timestamp( $expiry );
3640         }
3641
3642         /**
3643          * Decode an expiry time into a DBMS independent format
3644          *
3645          * @param $expiry String: DB timestamp field value for expiry
3646          * @param $format integer: TS_* constant, defaults to TS_MW
3647          * @return String
3648          */
3649         public function decodeExpiry( $expiry, $format = TS_MW ) {
3650                 return ( $expiry == '' || $expiry == $this->getInfinity() )
3651                         ? 'infinity'
3652                         : wfTimestamp( $format, $expiry );
3653         }
3654
3655         /**
3656          * Allow or deny "big selects" for this session only. This is done by setting
3657          * the sql_big_selects session variable.
3658          *
3659          * This is a MySQL-specific feature.
3660          *
3661          * @param $value Mixed: true for allow, false for deny, or "default" to
3662          *   restore the initial value
3663          */
3664         public function setBigSelects( $value = true ) {
3665                 // no-op
3666         }
3667
3668         /**
3669          * @since 1.19
3670          */
3671         public function __toString() {
3672                 return (string)$this->mConn;
3673         }
3674
3675         public function __destruct() {
3676                 if ( count( $this->mTrxIdleCallbacks ) ) { // sanity
3677                         trigger_error( "Transaction idle callbacks still pending." );
3678                 }
3679         }
3680 }