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