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