dépôts / lhc / web / wiklou.git / blob
? search:


4770293c9f1f2545833589e0fff3cb8762b06fd0
[lhc/web/wiklou.git] / includes / db / Database.php
1 <?php
2 /**
3 * @defgroup Database Database
4 *
5 * @file
6 * @ingroup Database
7 * This file deals with database interface functions
8 * and query specifics/optimisations
9 */
10
11 /** Number of times to re-try an operation in case of deadlock */
12 define( 'DEADLOCK_TRIES', 4 );
13 /** Minimum time to wait before retry, in microseconds */
14 define( 'DEADLOCK_DELAY_MIN', 500000 );
15 /** Maximum time to wait before retry */
16 define( 'DEADLOCK_DELAY_MAX', 1500000 );
17
18 /**
19 * Database abstraction object
20 * @ingroup Database
21 */
22 abstract class DatabaseBase {
23
24 #------------------------------------------------------------------------------
25 # Variables
26 #------------------------------------------------------------------------------
27
28 protected $mLastQuery = '';
29 protected $mDoneWrites = false;
30 protected $mPHPError = false;
31
32 protected $mServer, $mUser, $mPassword, $mConn = null, $mDBname;
33 protected $mOpened = false;
34
35 protected $mFailFunction;
36 protected $mTablePrefix;
37 protected $mFlags;
38 protected $mTrxLevel = 0;
39 protected $mErrorCount = 0;
40 protected $mLBInfo = array();
41 protected $mFakeSlaveLag = null, $mFakeMaster = false;
42 protected $mDefaultBigSelects = null;
43
44 #------------------------------------------------------------------------------
45 # Accessors
46 #------------------------------------------------------------------------------
47 # These optionally set a variable and return the previous state
48
49 /**
50 * Fail function, takes a Database as a parameter
51 * Set to false for default, 1 for ignore errors
52 */
53 function failFunction( $function = null ) {
54 return wfSetVar( $this->mFailFunction, $function );
55 }
56
57 /**
58 * Boolean, controls output of large amounts of debug information
59 */
60 function debug( $debug = null ) {
61 return wfSetBit( $this->mFlags, DBO_DEBUG, $debug );
62 }
63
64 /**
65 * Turns buffering of SQL result sets on (true) or off (false).
66 * Default is "on" and it should not be changed without good reasons.
67 */
68 function bufferResults( $buffer = null ) {
69 if ( is_null( $buffer ) ) {
70 return !(bool)( $this->mFlags & DBO_NOBUFFER );
71 } else {
72 return !wfSetBit( $this->mFlags, DBO_NOBUFFER, !$buffer );
73 }
74 }
75
76 /**
77 * Turns on (false) or off (true) the automatic generation and sending
78 * of a "we're sorry, but there has been a database error" page on
79 * database errors. Default is on (false). When turned off, the
80 * code should use lastErrno() and lastError() to handle the
81 * situation as appropriate.
82 */
83 function ignoreErrors( $ignoreErrors = null ) {
84 return wfSetBit( $this->mFlags, DBO_IGNORE, $ignoreErrors );
85 }
86
87 /**
88 * The current depth of nested transactions
89 * @param $level Integer: , default NULL.
90 */
91 function trxLevel( $level = null ) {
92 return wfSetVar( $this->mTrxLevel, $level );
93 }
94
95 /**
96 * Number of errors logged, only useful when errors are ignored
97 */
98 function errorCount( $count = null ) {
99 return wfSetVar( $this->mErrorCount, $count );
100 }
101
102 function tablePrefix( $prefix = null ) {
103 return wfSetVar( $this->mTablePrefix, $prefix );
104 }
105
106 /**
107 * Properties passed down from the server info array of the load balancer
108 */
109 function getLBInfo( $name = null ) {
110 if ( is_null( $name ) ) {
111 return $this->mLBInfo;
112 } else {
113 if ( array_key_exists( $name, $this->mLBInfo ) ) {
114 return $this->mLBInfo[$name];
115 } else {
116 return null;
117 }
118 }
119 }
120
121 function setLBInfo( $name, $value = null ) {
122 if ( is_null( $value ) ) {
123 $this->mLBInfo = $name;
124 } else {
125 $this->mLBInfo[$name] = $value;
126 }
127 }
128
129 /**
130 * Set lag time in seconds for a fake slave
131 */
132 function setFakeSlaveLag( $lag ) {
133 $this->mFakeSlaveLag = $lag;
134 }
135
136 /**
137 * Make this connection a fake master
138 */
139 function setFakeMaster( $enabled = true ) {
140 $this->mFakeMaster = $enabled;
141 }
142
143 /**
144 * Returns true if this database supports (and uses) cascading deletes
145 */
146 function cascadingDeletes() {
147 return false;
148 }
149
150 /**
151 * Returns true if this database supports (and uses) triggers (e.g. on the page table)
152 */
153 function cleanupTriggers() {
154 return false;
155 }
156
157 /**
158 * Returns true if this database is strict about what can be put into an IP field.
159 * Specifically, it uses a NULL value instead of an empty string.
160 */
161 function strictIPs() {
162 return false;
163 }
164
165 /**
166 * Returns true if this database uses timestamps rather than integers
167 */
168 function realTimestamps() {
169 return false;
170 }
171
172 /**
173 * Returns true if this database does an implicit sort when doing GROUP BY
174 */
175 function implicitGroupby() {
176 return true;
177 }
178
179 /**
180 * Returns true if this database does an implicit order by when the column has an index
181 * For example: SELECT page_title FROM page LIMIT 1
182 */
183 function implicitOrderby() {
184 return true;
185 }
186
187 /**
188 * Returns true if this database requires that SELECT DISTINCT queries require that all
189 ORDER BY expressions occur in the SELECT list per the SQL92 standard
190 */
191 function standardSelectDistinct() {
192 return true;
193 }
194
195 /**
196 * Returns true if this database can do a native search on IP columns
197 * e.g. this works as expected: .. WHERE rc_ip = '127.42.12.102/32';
198 */
199 function searchableIPs() {
200 return false;
201 }
202
203 /**
204 * Returns true if this database can use functional indexes
205 */
206 function functionalIndexes() {
207 return false;
208 }
209
210 /**
211 * Return the last query that went through Database::query()
212 * @return String
213 */
214 function lastQuery() { return $this->mLastQuery; }
215
216
217 /**
218 * Returns true if the connection may have been used for write queries.
219 * Should return true if unsure.
220 */
221 function doneWrites() { return $this->mDoneWrites; }
222
223 /**
224 * Is a connection to the database open?
225 * @return Boolean
226 */
227 function isOpen() { return $this->mOpened; }
228
229 /**
230 * Set a flag for this connection
231 *
232 * @param $flag Integer: DBO_* constants from Defines.php:
233 * - DBO_DEBUG: output some debug info (same as debug())
234 * - DBO_NOBUFFER: don't buffer results (inverse of bufferResults())
235 * - DBO_IGNORE: ignore errors (same as ignoreErrors())
236 * - DBO_TRX: automatically start transactions
237 * - DBO_DEFAULT: automatically sets DBO_TRX if not in command line mode
238 * and removes it in command line mode
239 * - DBO_PERSISTENT: use persistant database connection
240 */
241 function setFlag( $flag ) {
242 $this->mFlags |= $flag;
243 }
244
245 /**
246 * Clear a flag for this connection
247 *
248 * @param $flag: same as setFlag()'s $flag param
249 */
250 function clearFlag( $flag ) {
251 $this->mFlags &= ~$flag;
252 }
253
254 /**
255 * Returns a boolean whether the flag $flag is set for this connection
256 *
257 * @param $flag: same as setFlag()'s $flag param
258 * @return Boolean
259 */
260 function getFlag( $flag ) {
261 return !!($this->mFlags & $flag);
262 }
263
264 /**
265 * General read-only accessor
266 */
267 function getProperty( $name ) {
268 return $this->$name;
269 }
270
271 function getWikiID() {
272 if( $this->mTablePrefix ) {
273 return "{$this->mDBname}-{$this->mTablePrefix}";
274 } else {
275 return $this->mDBname;
276 }
277 }
278
279 /**
280 * Get the type of the DBMS, as it appears in $wgDBtype.
281 */
282 abstract function getType();
283
284 #------------------------------------------------------------------------------
285 # Other functions
286 #------------------------------------------------------------------------------
287
288 /**
289 * Constructor.
290 * @param $server String: database server host
291 * @param $user String: database user name
292 * @param $password String: database user password
293 * @param $dbName String: database name
294 * @param $failFunction
295 * @param $flags
296 * @param $tablePrefix String: database table prefixes. By default use the prefix gave in LocalSettings.php
297 */
298 function __construct( $server = false, $user = false, $password = false, $dbName = false,
299 $failFunction = false, $flags = 0, $tablePrefix = 'get from global' ) {
300
301 global $wgOut, $wgDBprefix, $wgCommandLineMode;
302 # Can't get a reference if it hasn't been set yet
303 if ( !isset( $wgOut ) ) {
304 $wgOut = null;
305 }
306
307 $this->mFailFunction = $failFunction;
308 $this->mFlags = $flags;
309
310 if ( $this->mFlags & DBO_DEFAULT ) {
311 if ( $wgCommandLineMode ) {
312 $this->mFlags &= ~DBO_TRX;
313 } else {
314 $this->mFlags |= DBO_TRX;
315 }
316 }
317
318 /*
319 // Faster read-only access
320 if ( wfReadOnly() ) {
321 $this->mFlags |= DBO_PERSISTENT;
322 $this->mFlags &= ~DBO_TRX;
323 }*/
324
325 /** Get the default table prefix*/
326 if ( $tablePrefix == 'get from global' ) {
327 $this->mTablePrefix = $wgDBprefix;
328 } else {
329 $this->mTablePrefix = $tablePrefix;
330 }
331
332 if ( $server ) {
333 $this->open( $server, $user, $password, $dbName );
334 }
335 }
336
337 /**
338 * Same as new DatabaseMysql( ... ), kept for backward compatibility
339 * @param $server String: database server host
340 * @param $user String: database user name
341 * @param $password String: database user password
342 * @param $dbName String: database name
343 * @param failFunction
344 * @param $flags
345 */
346 static function newFromParams( $server, $user, $password, $dbName, $failFunction = false, $flags = 0 )
347 {
348 wfDeprecated( __METHOD__ );
349 return new DatabaseMysql( $server, $user, $password, $dbName, $failFunction, $flags );
350 }
351
352 /**
353 * Usually aborts on failure
354 * If the failFunction is set to a non-zero integer, returns success
355 * @param $server String: database server host
356 * @param $user String: database user name
357 * @param $password String: database user password
358 * @param $dbName String: database name
359 */
360 abstract function open( $server, $user, $password, $dbName );
361
362 protected function installErrorHandler() {
363 $this->mPHPError = false;
364 $this->htmlErrors = ini_set( 'html_errors', '0' );
365 set_error_handler( array( $this, 'connectionErrorHandler' ) );
366 }
367
368 protected function restoreErrorHandler() {
369 restore_error_handler();
370 if ( $this->htmlErrors !== false ) {
371 ini_set( 'html_errors', $this->htmlErrors );
372 }
373 if ( $this->mPHPError ) {
374 $error = preg_replace( '!\[<a.*</a>\]!', '', $this->mPHPError );
375 $error = preg_replace( '!^.*?:(.*)$!', '$1', $error );
376 return $error;
377 } else {
378 return false;
379 }
380 }
381
382 protected function connectionErrorHandler( $errno, $errstr ) {
383 $this->mPHPError = $errstr;
384 }
385
386 /**
387 * Closes a database connection.
388 * if it is open : commits any open transactions
389 *
390 * @return Bool operation success. true if already closed.
391 */
392 function close() {
393 # Stub, should probably be overridden
394 return true;
395 }
396
397 /**
398 * @param $error String: fallback error message, used if none is given by DB
399 */
400 function reportConnectionError( $error = 'Unknown error' ) {
401 $myError = $this->lastError();
402 if ( $myError ) {
403 $error = $myError;
404 }
405
406 if ( $this->mFailFunction ) {
407 # Legacy error handling method
408 if ( !is_int( $this->mFailFunction ) ) {
409 $ff = $this->mFailFunction;
410 $ff( $this, $error );
411 }
412 } else {
413 # New method
414 throw new DBConnectionError( $this, $error );
415 }
416 }
417
418 /**
419 * Determine whether a query writes to the DB.
420 * Should return true if unsure.
421 */
422 function isWriteQuery( $sql ) {
423 return !preg_match( '/^(?:SELECT|BEGIN|COMMIT|SET|SHOW|\(SELECT)\b/i', $sql );
424 }
425
426 /**
427 * Usually aborts on failure. If errors are explicitly ignored, returns success.
428 *
429 * @param $sql String: SQL query
430 * @param $fname String: Name of the calling function, for profiling/SHOW PROCESSLIST
431 * comment (you can use __METHOD__ or add some extra info)
432 * @param $tempIgnore Boolean: Whether to avoid throwing an exception on errors...
433 * maybe best to catch the exception instead?
434 * @return true for a successful write query, ResultWrapper object for a successful read query,
435 * or false on failure if $tempIgnore set
436 * @throws DBQueryError Thrown when the database returns an error of any kind
437 */
438 public function query( $sql, $fname = '', $tempIgnore = false ) {
439 global $wgProfiler;
440
441 $isMaster = !is_null( $this->getLBInfo( 'master' ) );
442 if ( isset( $wgProfiler ) ) {
443 # generalizeSQL will probably cut down the query to reasonable
444 # logging size most of the time. The substr is really just a sanity check.
445
446 # Who's been wasting my precious column space? -- TS
447 #$profName = 'query: ' . $fname . ' ' . substr( Database::generalizeSQL( $sql ), 0, 255 );
448
449 if ( $isMaster ) {
450 $queryProf = 'query-m: ' . substr( Database::generalizeSQL( $sql ), 0, 255 );
451 $totalProf = 'Database::query-master';
452 } else {
453 $queryProf = 'query: ' . substr( Database::generalizeSQL( $sql ), 0, 255 );
454 $totalProf = 'Database::query';
455 }
456 wfProfileIn( $totalProf );
457 wfProfileIn( $queryProf );
458 }
459
460 $this->mLastQuery = $sql;
461 if ( !$this->mDoneWrites && $this->isWriteQuery( $sql ) ) {
462 // Set a flag indicating that writes have been done
463 wfDebug( __METHOD__.": Writes done: $sql\n" );
464 $this->mDoneWrites = true;
465 }
466
467 # Add a comment for easy SHOW PROCESSLIST interpretation
468 #if ( $fname ) {
469 global $wgUser;
470 if ( is_object( $wgUser ) && !($wgUser instanceof StubObject) ) {
471 $userName = $wgUser->getName();
472 if ( mb_strlen( $userName ) > 15 ) {
473 $userName = mb_substr( $userName, 0, 15 ) . '...';
474 }
475 $userName = str_replace( '/', '', $userName );
476 } else {
477 $userName = '';
478 }
479 $commentedSql = preg_replace('/\s/', " /* $fname $userName */ ", $sql, 1);
480 #} else {
481 # $commentedSql = $sql;
482 #}
483
484 # If DBO_TRX is set, start a transaction
485 if ( ( $this->mFlags & DBO_TRX ) && !$this->trxLevel() &&
486 $sql != 'BEGIN' && $sql != 'COMMIT' && $sql != 'ROLLBACK') {
487 // avoid establishing transactions for SHOW and SET statements too -
488 // that would delay transaction initializations to once connection
489 // is really used by application
490 $sqlstart = substr($sql,0,10); // very much worth it, benchmark certified(tm)
491 if (strpos($sqlstart,"SHOW ")!==0 and strpos($sqlstart,"SET ")!==0)
492 $this->begin();
493 }
494
495 if ( $this->debug() ) {
496 $sqlx = substr( $commentedSql, 0, 500 );
497 $sqlx = strtr( $sqlx, "\t\n", ' ' );
498 if ( $isMaster ) {
499 wfDebug( "SQL-master: $sqlx\n" );
500 } else {
501 wfDebug( "SQL: $sqlx\n" );
502 }
503 }
504
505 if ( istainted( $sql ) & TC_MYSQL ) {
506 throw new MWException( 'Tainted query found' );
507 }
508
509 # Do the query and handle errors
510 $ret = $this->doQuery( $commentedSql );
511
512 # Try reconnecting if the connection was lost
513 if ( false === $ret && $this->wasErrorReissuable() ) {
514 # Transaction is gone, like it or not
515 $this->mTrxLevel = 0;
516 wfDebug( "Connection lost, reconnecting...\n" );
517 if ( $this->ping() ) {
518 wfDebug( "Reconnected\n" );
519 $sqlx = substr( $commentedSql, 0, 500 );
520 $sqlx = strtr( $sqlx, "\t\n", ' ' );
521 global $wgRequestTime;
522 $elapsed = round( microtime(true) - $wgRequestTime, 3 );
523 wfLogDBError( "Connection lost and reconnected after {$elapsed}s, query: $sqlx\n" );
524 $ret = $this->doQuery( $commentedSql );
525 } else {
526 wfDebug( "Failed\n" );
527 }
528 }
529
530 if ( false === $ret ) {
531 $this->reportQueryError( $this->lastError(), $this->lastErrno(), $sql, $fname, $tempIgnore );
532 }
533
534 if ( isset( $wgProfiler ) ) {
535 wfProfileOut( $queryProf );
536 wfProfileOut( $totalProf );
537 }
538 return $this->resultObject( $ret );
539 }
540
541 /**
542 * The DBMS-dependent part of query()
543 * @param $sql String: SQL query.
544 * @return Result object to feed to fetchObject, fetchRow, ...; or false on failure
545 * @private
546 */
547 /*private*/ abstract function doQuery( $sql );
548
549 /**
550 * @param $error String
551 * @param $errno Integer
552 * @param $sql String
553 * @param $fname String
554 * @param $tempIgnore Boolean
555 */
556 function reportQueryError( $error, $errno, $sql, $fname, $tempIgnore = false ) {
557 # Ignore errors during error handling to avoid infinite recursion
558 $ignore = $this->ignoreErrors( true );
559 ++$this->mErrorCount;
560
561 if( $ignore || $tempIgnore ) {
562 wfDebug("SQL ERROR (ignored): $error\n");
563 $this->ignoreErrors( $ignore );
564 } else {
565 $sql1line = str_replace( "\n", "\\n", $sql );
566 wfLogDBError("$fname\t{$this->mServer}\t$errno\t$error\t$sql1line\n");
567 wfDebug("SQL ERROR: " . $error . "\n");
568 throw new DBQueryError( $this, $error, $errno, $sql, $fname );
569 }
570 }
571
572
573 /**
574 * Intended to be compatible with the PEAR::DB wrapper functions.
575 * http://pear.php.net/manual/en/package.database.db.intro-execute.php
576 *
577 * ? = scalar value, quoted as necessary
578 * ! = raw SQL bit (a function for instance)
579 * & = filename; reads the file and inserts as a blob
580 * (we don't use this though...)
581 */
582 function prepare( $sql, $func = 'Database::prepare' ) {
583 /* MySQL doesn't support prepared statements (yet), so just
584 pack up the query for reference. We'll manually replace
585 the bits later. */
586 return array( 'query' => $sql, 'func' => $func );
587 }
588
589 function freePrepared( $prepared ) {
590 /* No-op by default */
591 }
592
593 /**
594 * Execute a prepared query with the various arguments
595 * @param $prepared String: the prepared sql
596 * @param $args Mixed: Either an array here, or put scalars as varargs
597 */
598 function execute( $prepared, $args = null ) {
599 if( !is_array( $args ) ) {
600 # Pull the var args
601 $args = func_get_args();
602 array_shift( $args );
603 }
604 $sql = $this->fillPrepared( $prepared['query'], $args );
605 return $this->query( $sql, $prepared['func'] );
606 }
607
608 /**
609 * Prepare & execute an SQL statement, quoting and inserting arguments
610 * in the appropriate places.
611 * @param $query String
612 * @param $args ...
613 */
614 function safeQuery( $query, $args = null ) {
615 $prepared = $this->prepare( $query, 'Database::safeQuery' );
616 if( !is_array( $args ) ) {
617 # Pull the var args
618 $args = func_get_args();
619 array_shift( $args );
620 }
621 $retval = $this->execute( $prepared, $args );
622 $this->freePrepared( $prepared );
623 return $retval;
624 }
625
626 /**
627 * For faking prepared SQL statements on DBs that don't support
628 * it directly.
629 * @param $preparedQuery String: a 'preparable' SQL statement
630 * @param $args Array of arguments to fill it with
631 * @return string executable SQL
632 */
633 function fillPrepared( $preparedQuery, $args ) {
634 reset( $args );
635 $this->preparedArgs =& $args;
636 return preg_replace_callback( '/(\\\\[?!&]|[?!&])/',
637 array( &$this, 'fillPreparedArg' ), $preparedQuery );
638 }
639
640 /**
641 * preg_callback func for fillPrepared()
642 * The arguments should be in $this->preparedArgs and must not be touched
643 * while we're doing this.
644 *
645 * @param $matches Array
646 * @return String
647 * @private
648 */
649 function fillPreparedArg( $matches ) {
650 switch( $matches[1] ) {
651 case '\\?': return '?';
652 case '\\!': return '!';
653 case '\\&': return '&';
654 }
655 list( /* $n */ , $arg ) = each( $this->preparedArgs );
656 switch( $matches[1] ) {
657 case '?': return $this->addQuotes( $arg );
658 case '!': return $arg;
659 case '&':
660 # return $this->addQuotes( file_get_contents( $arg ) );
661 throw new DBUnexpectedError( $this, '& mode is not implemented. If it\'s really needed, uncomment the line above.' );
662 default:
663 throw new DBUnexpectedError( $this, 'Received invalid match. This should never happen!' );
664 }
665 }
666
667 /**
668 * Free a result object
669 * @param $res Mixed: A SQL result
670 */
671 function freeResult( $res ) {
672 # Stub. Might not really need to be overridden, since results should
673 # be freed by PHP when the variable goes out of scope anyway.
674 }
675
676 /**
677 * Fetch the next row from the given result object, in object form.
678 * Fields can be retrieved with $row->fieldname, with fields acting like
679 * member variables.
680 *
681 * @param $res SQL result object as returned from Database::query(), etc.
682 * @return Row object
683 * @throws DBUnexpectedError Thrown if the database returns an error
684 */
685 abstract function fetchObject( $res );
686
687 /**
688 * Fetch the next row from the given result object, in associative array
689 * form. Fields are retrieved with $row['fieldname'].
690 *
691 * @param $res SQL result object as returned from Database::query(), etc.
692 * @return Row object
693 * @throws DBUnexpectedError Thrown if the database returns an error
694 */
695 abstract function fetchRow( $res );
696
697 /**
698 * Get the number of rows in a result object
699 * @param $res Mixed: A SQL result
700 */
701 abstract function numRows( $res );
702
703 /**
704 * Get the number of fields in a result object
705 * See documentation for mysql_num_fields()
706 * @param $res Mixed: A SQL result
707 */
708 abstract function numFields( $res );
709
710 /**
711 * Get a field name in a result object
712 * See documentation for mysql_field_name():
713 * http://www.php.net/mysql_field_name
714 * @param $res Mixed: A SQL result
715 * @param $n Integer
716 */
717 abstract function fieldName( $res, $n );
718
719 /**
720 * Get the inserted value of an auto-increment row
721 *
722 * The value inserted should be fetched from nextSequenceValue()
723 *
724 * Example:
725 * $id = $dbw->nextSequenceValue('page_page_id_seq');
726 * $dbw->insert('page',array('page_id' => $id));
727 * $id = $dbw->insertId();
728 */
729 abstract function insertId();
730
731 /**
732 * Change the position of the cursor in a result object
733 * See mysql_data_seek()
734 * @param $res Mixed: A SQL result
735 * @param $row Mixed: Either MySQL row or ResultWrapper
736 */
737 abstract function dataSeek( $res, $row );
738
739 /**
740 * Get the last error number
741 * See mysql_errno()
742 */
743 abstract function lastErrno();
744
745 /**
746 * Get a description of the last error
747 * See mysql_error() for more details
748 */
749 abstract function lastError();
750
751 /**
752 * Get the number of rows affected by the last write query
753 * See mysql_affected_rows() for more details
754 */
755 abstract function affectedRows();
756
757 /**
758 * Simple UPDATE wrapper
759 * Usually aborts on failure
760 * If errors are explicitly ignored, returns success
761 *
762 * This function exists for historical reasons, Database::update() has a more standard
763 * calling convention and feature set
764 */
765 function set( $table, $var, $value, $cond, $fname = 'Database::set' ) {
766 $table = $this->tableName( $table );
767 $sql = "UPDATE $table SET $var = '" .
768 $this->strencode( $value ) . "' WHERE ($cond)";
769 return (bool)$this->query( $sql, $fname );
770 }
771
772 /**
773 * Simple SELECT wrapper, returns a single field, input must be encoded
774 * Usually aborts on failure
775 * If errors are explicitly ignored, returns FALSE on failure
776 */
777 function selectField( $table, $var, $cond='', $fname = 'Database::selectField', $options = array() ) {
778 if ( !is_array( $options ) ) {
779 $options = array( $options );
780 }
781 $options['LIMIT'] = 1;
782
783 $res = $this->select( $table, $var, $cond, $fname, $options );
784 if ( $res === false || !$this->numRows( $res ) ) {
785 return false;
786 }
787 $row = $this->fetchRow( $res );
788 if ( $row !== false ) {
789 return reset( $row );
790 } else {
791 return false;
792 }
793 }
794
795 /**
796 * Returns an optional USE INDEX clause to go after the table, and a
797 * string to go at the end of the query
798 *
799 * @private
800 *
801 * @param $options Array: associative array of options to be turned into
802 * an SQL query, valid keys are listed in the function.
803 * @return Array
804 */
805 function makeSelectOptions( $options ) {
806 $preLimitTail = $postLimitTail = '';
807 $startOpts = '';
808
809 $noKeyOptions = array();
810 foreach ( $options as $key => $option ) {
811 if ( is_numeric( $key ) ) {
812 $noKeyOptions[$option] = true;
813 }
814 }
815
816 if ( isset( $options['GROUP BY'] ) ) $preLimitTail .= " GROUP BY {$options['GROUP BY']}";
817 if ( isset( $options['HAVING'] ) ) $preLimitTail .= " HAVING {$options['HAVING']}";
818 if ( isset( $options['ORDER BY'] ) ) $preLimitTail .= " ORDER BY {$options['ORDER BY']}";
819
820 //if (isset($options['LIMIT'])) {
821 // $tailOpts .= $this->limitResult('', $options['LIMIT'],
822 // isset($options['OFFSET']) ? $options['OFFSET']
823 // : false);
824 //}
825
826 if ( isset( $noKeyOptions['FOR UPDATE'] ) ) $postLimitTail .= ' FOR UPDATE';
827 if ( isset( $noKeyOptions['LOCK IN SHARE MODE'] ) ) $postLimitTail .= ' LOCK IN SHARE MODE';
828 if ( isset( $noKeyOptions['DISTINCT'] ) || isset( $noKeyOptions['DISTINCTROW'] ) ) $startOpts .= 'DISTINCT';
829
830 # Various MySQL extensions
831 if ( isset( $noKeyOptions['STRAIGHT_JOIN'] ) ) $startOpts .= ' /*! STRAIGHT_JOIN */';
832 if ( isset( $noKeyOptions['HIGH_PRIORITY'] ) ) $startOpts .= ' HIGH_PRIORITY';
833 if ( isset( $noKeyOptions['SQL_BIG_RESULT'] ) ) $startOpts .= ' SQL_BIG_RESULT';
834 if ( isset( $noKeyOptions['SQL_BUFFER_RESULT'] ) ) $startOpts .= ' SQL_BUFFER_RESULT';
835 if ( isset( $noKeyOptions['SQL_SMALL_RESULT'] ) ) $startOpts .= ' SQL_SMALL_RESULT';
836 if ( isset( $noKeyOptions['SQL_CALC_FOUND_ROWS'] ) ) $startOpts .= ' SQL_CALC_FOUND_ROWS';
837 if ( isset( $noKeyOptions['SQL_CACHE'] ) ) $startOpts .= ' SQL_CACHE';
838 if ( isset( $noKeyOptions['SQL_NO_CACHE'] ) ) $startOpts .= ' SQL_NO_CACHE';
839
840 if ( isset( $options['USE INDEX'] ) && ! is_array( $options['USE INDEX'] ) ) {
841 $useIndex = $this->useIndexClause( $options['USE INDEX'] );
842 } else {
843 $useIndex = '';
844 }
845
846 return array( $startOpts, $useIndex, $preLimitTail, $postLimitTail );
847 }
848
849 /**
850 * SELECT wrapper
851 *
852 * @param $table Mixed: Array or string, table name(s) (prefix auto-added)
853 * @param $vars Mixed: Array or string, field name(s) to be retrieved
854 * @param $conds Mixed: Array or string, condition(s) for WHERE
855 * @param $fname String: Calling function name (use __METHOD__) for logs/profiling
856 * @param $options Array: Associative array of options (e.g. array('GROUP BY' => 'page_title')),
857 * see Database::makeSelectOptions code for list of supported stuff
858 * @param $join_conds Array: Associative array of table join conditions (optional)
859 * (e.g. array( 'page' => array('LEFT JOIN','page_latest=rev_id') )
860 * @return mixed Database result resource (feed to Database::fetchObject or whatever), or false on failure
861 */
862 function select( $table, $vars, $conds='', $fname = 'Database::select', $options = array(), $join_conds = array() )
863 {
864 $sql = $this->selectSQLText( $table, $vars, $conds, $fname, $options, $join_conds );
865 return $this->query( $sql, $fname );
866 }
867
868 /**
869 * SELECT wrapper
870 *
871 * @param $table Mixed: Array or string, table name(s) (prefix auto-added)
872 * @param $vars Mixed: Array or string, field name(s) to be retrieved
873 * @param $conds Mixed: Array or string, condition(s) for WHERE
874 * @param $fname String: Calling function name (use __METHOD__) for logs/profiling
875 * @param $options Array: Associative array of options (e.g. array('GROUP BY' => 'page_title')),
876 * see Database::makeSelectOptions code for list of supported stuff
877 * @param $join_conds Array: Associative array of table join conditions (optional)
878 * (e.g. array( 'page' => array('LEFT JOIN','page_latest=rev_id') )
879 * @return string, the SQL text
880 */
881 function selectSQLText( $table, $vars, $conds='', $fname = 'Database::select', $options = array(), $join_conds = array() ) {
882 if( is_array( $vars ) ) {
883 $vars = implode( ',', $vars );
884 }
885 if( !is_array( $options ) ) {
886 $options = array( $options );
887 }
888 if( is_array( $table ) ) {
889 if ( !empty($join_conds) || ( isset( $options['USE INDEX'] ) && is_array( @$options['USE INDEX'] ) ) )
890 $from = ' FROM ' . $this->tableNamesWithUseIndexOrJOIN( $table, @$options['USE INDEX'], $join_conds );
891 else
892 $from = ' FROM ' . implode( ',', array_map( array( &$this, 'tableName' ), $table ) );
893 } elseif ($table!='') {
894 if ($table{0}==' ') {
895 $from = ' FROM ' . $table;
896 } else {
897 $from = ' FROM ' . $this->tableName( $table );
898 }
899 } else {
900 $from = '';
901 }
902
903 list( $startOpts, $useIndex, $preLimitTail, $postLimitTail ) = $this->makeSelectOptions( $options );
904
905 if( !empty( $conds ) ) {
906 if ( is_array( $conds ) ) {
907 $conds = $this->makeList( $conds, LIST_AND );
908 }
909 $sql = "SELECT $startOpts $vars $from $useIndex WHERE $conds $preLimitTail";
910 } else {
911 $sql = "SELECT $startOpts $vars $from $useIndex $preLimitTail";
912 }
913
914 if (isset($options['LIMIT']))
915 $sql = $this->limitResult($sql, $options['LIMIT'],
916 isset($options['OFFSET']) ? $options['OFFSET'] : false);
917 $sql = "$sql $postLimitTail";
918
919 if (isset($options['EXPLAIN'])) {
920 $sql = 'EXPLAIN ' . $sql;
921 }
922 return $sql;
923 }
924
925 /**
926 * Single row SELECT wrapper
927 * Aborts or returns FALSE on error
928 *
929 * @param $table String: table name
930 * @param $vars String: the selected variables
931 * @param $conds Array: a condition map, terms are ANDed together.
932 * Items with numeric keys are taken to be literal conditions
933 * Takes an array of selected variables, and a condition map, which is ANDed
934 * e.g: selectRow( "page", array( "page_id" ), array( "page_namespace" =>
935 * NS_MAIN, "page_title" => "Astronomy" ) ) would return an object where
936 * $obj- >page_id is the ID of the Astronomy article
937 * @param $fname String: Calling function name
938 * @param $options Array
939 * @param $join_conds Array
940 *
941 * @todo migrate documentation to phpdocumentor format
942 */
943 function selectRow( $table, $vars, $conds, $fname = 'Database::selectRow', $options = array(), $join_conds = array() ) {
944 $options['LIMIT'] = 1;
945 $res = $this->select( $table, $vars, $conds, $fname, $options, $join_conds );
946 if ( $res === false )
947 return false;
948 if ( !$this->numRows($res) ) {
949 return false;
950 }
951 $obj = $this->fetchObject( $res );
952 return $obj;
953 }
954
955 /**
956 * Estimate rows in dataset
957 * Returns estimated count - not necessarily an accurate estimate across different databases,
958 * so use sparingly
959 * Takes same arguments as Database::select()
960 *
961 * @param $table String: table name
962 * @param $vars Array: unused
963 * @param $conds Array: filters on the table
964 * @param $fname String: function name for profiling
965 * @param $options Array: options for select
966 * @return Integer: row count
967 */
968 public function estimateRowCount( $table, $vars='*', $conds='', $fname = 'Database::estimateRowCount', $options = array() ) {
969 $rows = 0;
970 $res = $this->select ( $table, 'COUNT(*) AS rowcount', $conds, $fname, $options );
971 if ( $res ) {
972 $row = $this->fetchRow( $res );
973 $rows = ( isset( $row['rowcount'] ) ) ? $row['rowcount'] : 0;
974 }
975 return $rows;
976 }
977
978 /**
979 * Removes most variables from an SQL query and replaces them with X or N for numbers.
980 * It's only slightly flawed. Don't use for anything important.
981 *
982 * @param $sql String: A SQL Query
983 */
984 static function generalizeSQL( $sql ) {
985 # This does the same as the regexp below would do, but in such a way
986 # as to avoid crashing php on some large strings.
987 # $sql = preg_replace ( "/'([^\\\\']|\\\\.)*'|\"([^\\\\\"]|\\\\.)*\"/", "'X'", $sql);
988
989 $sql = str_replace ( "\\\\", '', $sql);
990 $sql = str_replace ( "\\'", '', $sql);
991 $sql = str_replace ( "\\\"", '', $sql);
992 $sql = preg_replace ("/'.*'/s", "'X'", $sql);
993 $sql = preg_replace ('/".*"/s', "'X'", $sql);
994
995 # All newlines, tabs, etc replaced by single space
996 $sql = preg_replace ( '/\s+/', ' ', $sql);
997
998 # All numbers => N
999 $sql = preg_replace ('/-?[0-9]+/s', 'N', $sql);
1000
1001 return $sql;
1002 }
1003
1004 /**
1005 * Determines whether a field exists in a table
1006 *
1007 * @param $table String: table name
1008 * @param $field String: filed to check on that table
1009 * @param $fname String: calling function name (optional)
1010 * @return Boolean: whether $table has filed $field
1011 */
1012 function fieldExists( $table, $field, $fname = 'Database::fieldExists' ) {
1013 $info = $this->fieldInfo( $table, $field );
1014 return (bool)$info;
1015 }
1016
1017 /**
1018 * Determines whether an index exists
1019 * Usually aborts on failure
1020 * If errors are explicitly ignored, returns NULL on failure
1021 */
1022 function indexExists( $table, $index, $fname = 'Database::indexExists' ) {
1023 $info = $this->indexInfo( $table, $index, $fname );
1024 if ( is_null( $info ) ) {
1025 return null;
1026 } else {
1027 return $info !== false;
1028 }
1029 }
1030
1031
1032 /**
1033 * Get information about an index into an object
1034 * Returns false if the index does not exist
1035 */
1036 function indexInfo( $table, $index, $fname = 'Database::indexInfo' ) {
1037 # SHOW INDEX works in MySQL 3.23.58, but SHOW INDEXES does not.
1038 # SHOW INDEX should work for 3.x and up:
1039 # http://dev.mysql.com/doc/mysql/en/SHOW_INDEX.html
1040 $table = $this->tableName( $table );
1041 $index = $this->indexName( $index );
1042 $sql = 'SHOW INDEX FROM '.$table;
1043 $res = $this->query( $sql, $fname );
1044 if ( !$res ) {
1045 return null;
1046 }
1047
1048 $result = array();
1049 while ( $row = $this->fetchObject( $res ) ) {
1050 if ( $row->Key_name == $index ) {
1051 $result[] = $row;
1052 }
1053 }
1054
1055 return empty($result) ? false : $result;
1056 }
1057
1058 /**
1059 * Query whether a given table exists
1060 */
1061 function tableExists( $table ) {
1062 $table = $this->tableName( $table );
1063 $old = $this->ignoreErrors( true );
1064 $res = $this->query( "SELECT 1 FROM $table LIMIT 1" );
1065 $this->ignoreErrors( $old );
1066 return (bool)$res;
1067 }
1068
1069 /**
1070 * mysql_fetch_field() wrapper
1071 * Returns false if the field doesn't exist
1072 *
1073 * @param $table
1074 * @param $field
1075 */
1076 abstract function fieldInfo( $table, $field );
1077
1078 /**
1079 * mysql_field_type() wrapper
1080 */
1081 function fieldType( $res, $index ) {
1082 if ( $res instanceof ResultWrapper ) {
1083 $res = $res->result;
1084 }
1085 return mysql_field_type( $res, $index );
1086 }
1087
1088 /**
1089 * Determines if a given index is unique
1090 */
1091 function indexUnique( $table, $index ) {
1092 $indexInfo = $this->indexInfo( $table, $index );
1093 if ( !$indexInfo ) {
1094 return null;
1095 }
1096 return !$indexInfo[0]->Non_unique;
1097 }
1098
1099 /**
1100 * INSERT wrapper, inserts an array into a table
1101 *
1102 * $a may be a single associative array, or an array of these with numeric keys, for
1103 * multi-row insert.
1104 *
1105 * Usually aborts on failure
1106 * If errors are explicitly ignored, returns success
1107 */
1108 function insert( $table, $a, $fname = 'Database::insert', $options = array() ) {
1109 # No rows to insert, easy just return now
1110 if ( !count( $a ) ) {
1111 return true;
1112 }
1113
1114 $table = $this->tableName( $table );
1115 if ( !is_array( $options ) ) {
1116 $options = array( $options );
1117 }
1118 if ( isset( $a[0] ) && is_array( $a[0] ) ) {
1119 $multi = true;
1120 $keys = array_keys( $a[0] );
1121 } else {
1122 $multi = false;
1123 $keys = array_keys( $a );
1124 }
1125
1126 $sql = 'INSERT ' . implode( ' ', $options ) .
1127 " INTO $table (" . implode( ',', $keys ) . ') VALUES ';
1128
1129 if ( $multi ) {
1130 $first = true;
1131 foreach ( $a as $row ) {
1132 if ( $first ) {
1133 $first = false;
1134 } else {
1135 $sql .= ',';
1136 }
1137 $sql .= '(' . $this->makeList( $row ) . ')';
1138 }
1139 } else {
1140 $sql .= '(' . $this->makeList( $a ) . ')';
1141 }
1142 return (bool)$this->query( $sql, $fname );
1143 }
1144
1145 /**
1146 * Make UPDATE options for the Database::update function
1147 *
1148 * @private
1149 * @param $options Array: The options passed to Database::update
1150 * @return string
1151 */
1152 function makeUpdateOptions( $options ) {
1153 if( !is_array( $options ) ) {
1154 $options = array( $options );
1155 }
1156 $opts = array();
1157 if ( in_array( 'LOW_PRIORITY', $options ) )
1158 $opts[] = $this->lowPriorityOption();
1159 if ( in_array( 'IGNORE', $options ) )
1160 $opts[] = 'IGNORE';
1161 return implode(' ', $opts);
1162 }
1163
1164 /**
1165 * UPDATE wrapper, takes a condition array and a SET array
1166 *
1167 * @param $table String: The table to UPDATE
1168 * @param $values Array: An array of values to SET
1169 * @param $conds Array: An array of conditions (WHERE). Use '*' to update all rows.
1170 * @param $fname String: The Class::Function calling this function
1171 * (for the log)
1172 * @param $options Array: An array of UPDATE options, can be one or
1173 * more of IGNORE, LOW_PRIORITY
1174 * @return Boolean
1175 */
1176 function update( $table, $values, $conds, $fname = 'Database::update', $options = array() ) {
1177 $table = $this->tableName( $table );
1178 $opts = $this->makeUpdateOptions( $options );
1179 $sql = "UPDATE $opts $table SET " . $this->makeList( $values, LIST_SET );
1180 if ( $conds != '*' ) {
1181 $sql .= " WHERE " . $this->makeList( $conds, LIST_AND );
1182 }
1183 return $this->query( $sql, $fname );
1184 }
1185
1186 /**
1187 * Makes an encoded list of strings from an array
1188 * $mode:
1189 * LIST_COMMA - comma separated, no field names
1190 * LIST_AND - ANDed WHERE clause (without the WHERE)
1191 * LIST_OR - ORed WHERE clause (without the WHERE)
1192 * LIST_SET - comma separated with field names, like a SET clause
1193 * LIST_NAMES - comma separated field names
1194 */
1195 function makeList( $a, $mode = LIST_COMMA ) {
1196 if ( !is_array( $a ) ) {
1197 throw new DBUnexpectedError( $this, 'Database::makeList called with incorrect parameters' );
1198 }
1199
1200 $first = true;
1201 $list = '';
1202 foreach ( $a as $field => $value ) {
1203 if ( !$first ) {
1204 if ( $mode == LIST_AND ) {
1205 $list .= ' AND ';
1206 } elseif($mode == LIST_OR) {
1207 $list .= ' OR ';
1208 } else {
1209 $list .= ',';
1210 }
1211 } else {
1212 $first = false;
1213 }
1214 if ( ($mode == LIST_AND || $mode == LIST_OR) && is_numeric( $field ) ) {
1215 $list .= "($value)";
1216 } elseif ( ($mode == LIST_SET) && is_numeric( $field ) ) {
1217 $list .= "$value";
1218 } elseif ( ($mode == LIST_AND || $mode == LIST_OR) && is_array($value) ) {
1219 if( count( $value ) == 0 ) {
1220 throw new MWException( __METHOD__.': empty input' );
1221 } elseif( count( $value ) == 1 ) {
1222 // Special-case single values, as IN isn't terribly efficient
1223 // Don't necessarily assume the single key is 0; we don't
1224 // enforce linear numeric ordering on other arrays here.
1225 $value = array_values( $value );
1226 $list .= $field." = ".$this->addQuotes( $value[0] );
1227 } else {
1228 $list .= $field." IN (".$this->makeList($value).") ";
1229 }
1230 } elseif( $value === null ) {
1231 if ( $mode == LIST_AND || $mode == LIST_OR ) {
1232 $list .= "$field IS ";
1233 } elseif ( $mode == LIST_SET ) {
1234 $list .= "$field = ";
1235 }
1236 $list .= 'NULL';
1237 } else {
1238 if ( $mode == LIST_AND || $mode == LIST_OR || $mode == LIST_SET ) {
1239 $list .= "$field = ";
1240 }
1241 $list .= $mode == LIST_NAMES ? $value : $this->addQuotes( $value );
1242 }
1243 }
1244 return $list;
1245 }
1246
1247 /**
1248 * Build a partial where clause from a 2-d array such as used for LinkBatch.
1249 * The keys on each level may be either integers or strings.
1250 *
1251 * @param $data Array: organized as 2-d array(baseKeyVal => array(subKeyVal => <ignored>, ...), ...)
1252 * @param $baseKey String: field name to match the base-level keys to (eg 'pl_namespace')
1253 * @param $subKey String: field name to match the sub-level keys to (eg 'pl_title')
1254 * @return Mixed: string SQL fragment, or false if no items in array.
1255 */
1256 function makeWhereFrom2d( $data, $baseKey, $subKey ) {
1257 $conds = array();
1258 foreach ( $data as $base => $sub ) {
1259 if ( count( $sub ) ) {
1260 $conds[] = $this->makeList(
1261 array( $baseKey => $base, $subKey => array_keys( $sub ) ),
1262 LIST_AND);
1263 }
1264 }
1265
1266 if ( $conds ) {
1267 return $this->makeList( $conds, LIST_OR );
1268 } else {
1269 // Nothing to search for...
1270 return false;
1271 }
1272 }
1273
1274 /**
1275 * Bitwise operations
1276 */
1277
1278 function bitNot($field) {
1279 return "(~$bitField)";
1280 }
1281
1282 function bitAnd($fieldLeft, $fieldRight) {
1283 return "($fieldLeft & $fieldRight)";
1284 }
1285
1286 function bitOr($fieldLeft, $fieldRight) {
1287 return "($fieldLeft | $fieldRight)";
1288 }
1289
1290 /**
1291 * Change the current database
1292 *
1293 * @return bool Success or failure
1294 */
1295 function selectDB( $db ) {
1296 # Stub. Shouldn't cause serious problems if it's not overridden, but
1297 # if your database engine supports a concept similar to MySQL's
1298 # databases you may as well. TODO: explain what exactly will fail if
1299 # this is not overridden.
1300 return true;
1301 }
1302
1303 /**
1304 * Get the current DB name
1305 */
1306 function getDBname() {
1307 return $this->mDBname;
1308 }
1309
1310 /**
1311 * Get the server hostname or IP address
1312 */
1313 function getServer() {
1314 return $this->mServer;
1315 }
1316
1317 /**
1318 * Format a table name ready for use in constructing an SQL query
1319 *
1320 * This does two important things: it quotes the table names to clean them up,
1321 * and it adds a table prefix if only given a table name with no quotes.
1322 *
1323 * All functions of this object which require a table name call this function
1324 * themselves. Pass the canonical name to such functions. This is only needed
1325 * when calling query() directly.
1326 *
1327 * @param $name String: database table name
1328 * @return String: full database name
1329 */
1330 function tableName( $name ) {
1331 global $wgSharedDB, $wgSharedPrefix, $wgSharedTables;
1332 # Skip the entire process when we have a string quoted on both ends.
1333 # Note that we check the end so that we will still quote any use of
1334 # use of `database`.table. But won't break things if someone wants
1335 # to query a database table with a dot in the name.
1336 if ( $name[0] == '`' && substr( $name, -1, 1 ) == '`' ) return $name;
1337
1338 # Lets test for any bits of text that should never show up in a table
1339 # name. Basically anything like JOIN or ON which are actually part of
1340 # SQL queries, but may end up inside of the table value to combine
1341 # sql. Such as how the API is doing.
1342 # Note that we use a whitespace test rather than a \b test to avoid
1343 # any remote case where a word like on may be inside of a table name
1344 # surrounded by symbols which may be considered word breaks.
1345 if( preg_match( '/(^|\s)(DISTINCT|JOIN|ON|AS)(\s|$)/i', $name ) !== 0 ) return $name;
1346
1347 # Split database and table into proper variables.
1348 # We reverse the explode so that database.table and table both output
1349 # the correct table.
1350 $dbDetails = array_reverse( explode( '.', $name, 2 ) );
1351 if( isset( $dbDetails[1] ) ) @list( $table, $database ) = $dbDetails;
1352 else @list( $table ) = $dbDetails;
1353 $prefix = $this->mTablePrefix; # Default prefix
1354
1355 # A database name has been specified in input. Quote the table name
1356 # because we don't want any prefixes added.
1357 if( isset($database) ) $table = ( $table[0] == '`' ? $table : "`{$table}`" );
1358
1359 # Note that we use the long format because php will complain in in_array if
1360 # the input is not an array, and will complain in is_array if it is not set.
1361 if( !isset( $database ) # Don't use shared database if pre selected.
1362 && isset( $wgSharedDB ) # We have a shared database
1363 && $table[0] != '`' # Paranoia check to prevent shared tables listing '`table`'
1364 && isset( $wgSharedTables )
1365 && is_array( $wgSharedTables )
1366 && in_array( $table, $wgSharedTables ) ) { # A shared table is selected
1367 $database = $wgSharedDB;
1368 $prefix = isset( $wgSharedPrefix ) ? $wgSharedPrefix : $prefix;
1369 }
1370
1371 # Quote the $database and $table and apply the prefix if not quoted.
1372 if( isset($database) ) $database = ( $database[0] == '`' ? $database : "`{$database}`" );
1373 $table = ( $table[0] == '`' ? $table : "`{$prefix}{$table}`" );
1374
1375 # Merge our database and table into our final table name.
1376 $tableName = ( isset($database) ? "{$database}.{$table}" : "{$table}" );
1377
1378 # We're finished, return.
1379 return $tableName;
1380 }
1381
1382 /**
1383 * Fetch a number of table names into an array
1384 * This is handy when you need to construct SQL for joins
1385 *
1386 * Example:
1387 * extract($dbr->tableNames('user','watchlist'));
1388 * $sql = "SELECT wl_namespace,wl_title FROM $watchlist,$user
1389 * WHERE wl_user=user_id AND wl_user=$nameWithQuotes";
1390 */
1391 public function tableNames() {
1392 $inArray = func_get_args();
1393 $retVal = array();
1394 foreach ( $inArray as $name ) {
1395 $retVal[$name] = $this->tableName( $name );
1396 }
1397 return $retVal;
1398 }
1399
1400 /**
1401 * Fetch a number of table names into an zero-indexed numerical array
1402 * This is handy when you need to construct SQL for joins
1403 *
1404 * Example:
1405 * list( $user, $watchlist ) = $dbr->tableNamesN('user','watchlist');
1406 * $sql = "SELECT wl_namespace,wl_title FROM $watchlist,$user
1407 * WHERE wl_user=user_id AND wl_user=$nameWithQuotes";
1408 */
1409 public function tableNamesN() {
1410 $inArray = func_get_args();
1411 $retVal = array();
1412 foreach ( $inArray as $name ) {
1413 $retVal[] = $this->tableName( $name );
1414 }
1415 return $retVal;
1416 }
1417
1418 /**
1419 * @private
1420 */
1421 function tableNamesWithUseIndexOrJOIN( $tables, $use_index = array(), $join_conds = array() ) {
1422 $ret = array();
1423 $retJOIN = array();
1424 $use_index_safe = is_array($use_index) ? $use_index : array();
1425 $join_conds_safe = is_array($join_conds) ? $join_conds : array();
1426 foreach ( $tables as $table ) {
1427 // Is there a JOIN and INDEX clause for this table?
1428 if ( isset($join_conds_safe[$table]) && isset($use_index_safe[$table]) ) {
1429 $tableClause = $join_conds_safe[$table][0] . ' ' . $this->tableName( $table );
1430 $tableClause .= ' ' . $this->useIndexClause( implode( ',', (array)$use_index_safe[$table] ) );
1431 $on = $this->makeList((array)$join_conds_safe[$table][1], LIST_AND);
1432 if ( $on != '' ) {
1433 $tableClause .= ' ON (' . $on . ')';
1434 }
1435 $retJOIN[] = $tableClause;
1436 // Is there an INDEX clause?
1437 } else if ( isset($use_index_safe[$table]) ) {
1438 $tableClause = $this->tableName( $table );
1439 $tableClause .= ' ' . $this->useIndexClause( implode( ',', (array)$use_index_safe[$table] ) );
1440 $ret[] = $tableClause;
1441 // Is there a JOIN clause?
1442 } else if ( isset($join_conds_safe[$table]) ) {
1443 $tableClause = $join_conds_safe[$table][0] . ' ' . $this->tableName( $table );
1444 $on = $this->makeList((array)$join_conds_safe[$table][1], LIST_AND);
1445 if ( $on != '' ) {
1446 $tableClause .= ' ON (' . $on . ')';
1447 }
1448 $retJOIN[] = $tableClause;
1449 } else {
1450 $tableClause = $this->tableName( $table );
1451 $ret[] = $tableClause;
1452 }
1453 }
1454 // We can't separate explicit JOIN clauses with ',', use ' ' for those
1455 $straightJoins = !empty($ret) ? implode( ',', $ret ) : "";
1456 $otherJoins = !empty($retJOIN) ? implode( ' ', $retJOIN ) : "";
1457 // Compile our final table clause
1458 return implode(' ',array($straightJoins,$otherJoins) );
1459 }
1460
1461 /**
1462 * Get the name of an index in a given table
1463 */
1464 function indexName( $index ) {
1465 // Backwards-compatibility hack
1466 $renamed = array(
1467 'ar_usertext_timestamp' => 'usertext_timestamp',
1468 'un_user_id' => 'user_id',
1469 'un_user_ip' => 'user_ip',
1470 );
1471 if( isset( $renamed[$index] ) ) {
1472 return $renamed[$index];
1473 } else {
1474 return $index;
1475 }
1476 }
1477
1478 /**
1479 * Wrapper for addslashes()
1480 * @param $s String: to be slashed.
1481 * @return String: slashed string.
1482 */
1483 abstract function strencode( $s );
1484
1485 /**
1486 * If it's a string, adds quotes and backslashes
1487 * Otherwise returns as-is
1488 */
1489 function addQuotes( $s ) {
1490 if ( $s === null ) {
1491 return 'NULL';
1492 } else {
1493 # This will also quote numeric values. This should be harmless,
1494 # and protects against weird problems that occur when they really
1495 # _are_ strings such as article titles and string->number->string
1496 # conversion is not 1:1.
1497 return "'" . $this->strencode( $s ) . "'";
1498 }
1499 }
1500
1501 /**
1502 * Escape string for safe LIKE usage.
1503 * WARNING: you should almost never use this function directly,
1504 * instead use buildLike() that escapes everything automatically
1505 * Deprecated in 1.17, warnings in 1.17, removed in ???
1506 */
1507 public function escapeLike( $s ) {
1508 wfDeprecated( __METHOD__ );
1509 return $this->escapeLikeInternal( $s );
1510 }
1511
1512 protected function escapeLikeInternal( $s ) {
1513 $s = str_replace( '\\', '\\\\', $s );
1514 $s = $this->strencode( $s );
1515 $s = str_replace( array( '%', '_' ), array( '\%', '\_' ), $s );
1516 return $s;
1517 }
1518
1519 /**
1520 * LIKE statement wrapper, receives a variable-length argument list with parts of pattern to match
1521 * containing either string literals that will be escaped or tokens returned by anyChar() or anyString().
1522 * Alternatively, the function could be provided with an array of aforementioned parameters.
1523 *
1524 * Example: $dbr->buildLike( 'My_page_title/', $dbr->anyString() ) returns a LIKE clause that searches
1525 * for subpages of 'My page title'.
1526 * Alternatively: $pattern = array( 'My_page_title/', $dbr->anyString() ); $query .= $dbr->buildLike( $pattern );
1527 *
1528 * @since 1.16
1529 * @return String: fully built LIKE statement
1530 */
1531 function buildLike() {
1532 $params = func_get_args();
1533 if (count($params) > 0 && is_array($params[0])) {
1534 $params = $params[0];
1535 }
1536
1537 $s = '';
1538 foreach( $params as $value) {
1539 if( $value instanceof LikeMatch ) {
1540 $s .= $value->toString();
1541 } else {
1542 $s .= $this->escapeLikeInternal( $value );
1543 }
1544 }
1545 return " LIKE '" . $s . "' ";
1546 }
1547
1548 /**
1549 * Returns a token for buildLike() that denotes a '_' to be used in a LIKE query
1550 */
1551 function anyChar() {
1552 return new LikeMatch( '_' );
1553 }
1554
1555 /**
1556 * Returns a token for buildLike() that denotes a '%' to be used in a LIKE query
1557 */
1558 function anyString() {
1559 return new LikeMatch( '%' );
1560 }
1561
1562 /**
1563 * Returns an appropriately quoted sequence value for inserting a new row.
1564 * MySQL has autoincrement fields, so this is just NULL. But the PostgreSQL
1565 * subclass will return an integer, and save the value for insertId()
1566 */
1567 function nextSequenceValue( $seqName ) {
1568 return null;
1569 }
1570
1571 /**
1572 * USE INDEX clause. Unlikely to be useful for anything but MySQL. This
1573 * is only needed because a) MySQL must be as efficient as possible due to
1574 * its use on Wikipedia, and b) MySQL 4.0 is kind of dumb sometimes about
1575 * which index to pick. Anyway, other databases might have different
1576 * indexes on a given table. So don't bother overriding this unless you're
1577 * MySQL.
1578 */
1579 function useIndexClause( $index ) {
1580 return '';
1581 }
1582
1583 /**
1584 * REPLACE query wrapper
1585 * PostgreSQL simulates this with a DELETE followed by INSERT
1586 * $row is the row to insert, an associative array
1587 * $uniqueIndexes is an array of indexes. Each element may be either a
1588 * field name or an array of field names
1589 *
1590 * It may be more efficient to leave off unique indexes which are unlikely to collide.
1591 * However if you do this, you run the risk of encountering errors which wouldn't have
1592 * occurred in MySQL
1593 *
1594 * @todo migrate comment to phodocumentor format
1595 */
1596 function replace( $table, $uniqueIndexes, $rows, $fname = 'Database::replace' ) {
1597 $table = $this->tableName( $table );
1598
1599 # Single row case
1600 if ( !is_array( reset( $rows ) ) ) {
1601 $rows = array( $rows );
1602 }
1603
1604 $sql = "REPLACE INTO $table (" . implode( ',', array_keys( $rows[0] ) ) .') VALUES ';
1605 $first = true;
1606 foreach ( $rows as $row ) {
1607 if ( $first ) {
1608 $first = false;
1609 } else {
1610 $sql .= ',';
1611 }
1612 $sql .= '(' . $this->makeList( $row ) . ')';
1613 }
1614 return $this->query( $sql, $fname );
1615 }
1616
1617 /**
1618 * DELETE where the condition is a join
1619 * MySQL does this with a multi-table DELETE syntax, PostgreSQL does it with sub-selects
1620 *
1621 * For safety, an empty $conds will not delete everything. If you want to delete all rows where the
1622 * join condition matches, set $conds='*'
1623 *
1624 * DO NOT put the join condition in $conds
1625 *
1626 * @param $delTable String: The table to delete from.
1627 * @param $joinTable String: The other table.
1628 * @param $delVar String: The variable to join on, in the first table.
1629 * @param $joinVar String: The variable to join on, in the second table.
1630 * @param $conds Array: Condition array of field names mapped to variables, ANDed together in the WHERE clause
1631 * @param $fname String: Calling function name (use __METHOD__) for logs/profiling
1632 */
1633 function deleteJoin( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname = 'Database::deleteJoin' ) {
1634 if ( !$conds ) {
1635 throw new DBUnexpectedError( $this, 'Database::deleteJoin() called with empty $conds' );
1636 }
1637
1638 $delTable = $this->tableName( $delTable );
1639 $joinTable = $this->tableName( $joinTable );
1640 $sql = "DELETE $delTable FROM $delTable, $joinTable WHERE $delVar=$joinVar ";
1641 if ( $conds != '*' ) {
1642 $sql .= ' AND ' . $this->makeList( $conds, LIST_AND );
1643 }
1644
1645 return $this->query( $sql, $fname );
1646 }
1647
1648 /**
1649 * Returns the size of a text field, or -1 for "unlimited"
1650 */
1651 function textFieldSize( $table, $field ) {
1652 $table = $this->tableName( $table );
1653 $sql = "SHOW COLUMNS FROM $table LIKE \"$field\";";
1654 $res = $this->query( $sql, 'Database::textFieldSize' );
1655 $row = $this->fetchObject( $res );
1656
1657 $m = array();
1658 if ( preg_match( '/\((.*)\)/', $row->Type, $m ) ) {
1659 $size = $m[1];
1660 } else {
1661 $size = -1;
1662 }
1663 return $size;
1664 }
1665
1666 /**
1667 * A string to insert into queries to show that they're low-priority, like
1668 * MySQL's LOW_PRIORITY. If no such feature exists, return an empty
1669 * string and nothing bad should happen.
1670 *
1671 * @return string Returns the text of the low priority option if it is supported, or a blank string otherwise
1672 */
1673 function lowPriorityOption() {
1674 return '';
1675 }
1676
1677 /**
1678 * DELETE query wrapper
1679 *
1680 * Use $conds == "*" to delete all rows
1681 */
1682 function delete( $table, $conds, $fname = 'Database::delete' ) {
1683 if ( !$conds ) {
1684 throw new DBUnexpectedError( $this, 'Database::delete() called with no conditions' );
1685 }
1686 $table = $this->tableName( $table );
1687 $sql = "DELETE FROM $table";
1688 if ( $conds != '*' ) {
1689 $sql .= ' WHERE ' . $this->makeList( $conds, LIST_AND );
1690 }
1691 return $this->query( $sql, $fname );
1692 }
1693
1694 /**
1695 * INSERT SELECT wrapper
1696 * $varMap must be an associative array of the form array( 'dest1' => 'source1', ...)
1697 * Source items may be literals rather than field names, but strings should be quoted with Database::addQuotes()
1698 * $conds may be "*" to copy the whole table
1699 * srcTable may be an array of tables.
1700 */
1701 function insertSelect( $destTable, $srcTable, $varMap, $conds, $fname = 'Database::insertSelect',
1702 $insertOptions = array(), $selectOptions = array() )
1703 {
1704 $destTable = $this->tableName( $destTable );
1705 if ( is_array( $insertOptions ) ) {
1706 $insertOptions = implode( ' ', $insertOptions );
1707 }
1708 if( !is_array( $selectOptions ) ) {
1709 $selectOptions = array( $selectOptions );
1710 }
1711 list( $startOpts, $useIndex, $tailOpts ) = $this->makeSelectOptions( $selectOptions );
1712 if( is_array( $srcTable ) ) {
1713 $srcTable = implode( ',', array_map( array( &$this, 'tableName' ), $srcTable ) );
1714 } else {
1715 $srcTable = $this->tableName( $srcTable );
1716 }
1717 $sql = "INSERT $insertOptions INTO $destTable (" . implode( ',', array_keys( $varMap ) ) . ')' .
1718 " SELECT $startOpts " . implode( ',', $varMap ) .
1719 " FROM $srcTable $useIndex ";
1720 if ( $conds != '*' ) {
1721 $sql .= ' WHERE ' . $this->makeList( $conds, LIST_AND );
1722 }
1723 $sql .= " $tailOpts";
1724 return $this->query( $sql, $fname );
1725 }
1726
1727 /**
1728 * Construct a LIMIT query with optional offset. This is used for query
1729 * pages. The SQL should be adjusted so that only the first $limit rows
1730 * are returned. If $offset is provided as well, then the first $offset
1731 * rows should be discarded, and the next $limit rows should be returned.
1732 * If the result of the query is not ordered, then the rows to be returned
1733 * are theoretically arbitrary.
1734 *
1735 * $sql is expected to be a SELECT, if that makes a difference. For
1736 * UPDATE, limitResultForUpdate should be used.
1737 *
1738 * The version provided by default works in MySQL and SQLite. It will very
1739 * likely need to be overridden for most other DBMSes.
1740 *
1741 * @param $sql String: SQL query we will append the limit too
1742 * @param $limit Integer: the SQL limit
1743 * @param $offset Integer the SQL offset (default false)
1744 */
1745 function limitResult( $sql, $limit, $offset=false ) {
1746 if( !is_numeric( $limit ) ) {
1747 throw new DBUnexpectedError( $this, "Invalid non-numeric limit passed to limitResult()\n" );
1748 }
1749 return "$sql LIMIT "
1750 . ( (is_numeric($offset) && $offset != 0) ? "{$offset}," : "" )
1751 . "{$limit} ";
1752 }
1753 function limitResultForUpdate( $sql, $num ) {
1754 return $this->limitResult( $sql, $num, 0 );
1755 }
1756
1757 /**
1758 * Returns true if current database backend supports ORDER BY or LIMIT for separate subqueries
1759 * within the UNION construct.
1760 * @return Boolean
1761 */
1762 function unionSupportsOrderAndLimit() {
1763 return true; // True for almost every DB supported
1764 }
1765
1766 /**
1767 * Construct a UNION query
1768 * This is used for providing overload point for other DB abstractions
1769 * not compatible with the MySQL syntax.
1770 * @param $sqls Array: SQL statements to combine
1771 * @param $all Boolean: use UNION ALL
1772 * @return String: SQL fragment
1773 */
1774 function unionQueries($sqls, $all) {
1775 $glue = $all ? ') UNION ALL (' : ') UNION (';
1776 return '('.implode( $glue, $sqls ) . ')';
1777 }
1778
1779 /**
1780 * Returns an SQL expression for a simple conditional. This doesn't need
1781 * to be overridden unless CASE isn't supported in your DBMS.
1782 *
1783 * @param $cond String: SQL expression which will result in a boolean value
1784 * @param $trueVal String: SQL expression to return if true
1785 * @param $falseVal String: SQL expression to return if false
1786 * @return String: SQL fragment
1787 */
1788 function conditional( $cond, $trueVal, $falseVal ) {
1789 return " (CASE WHEN $cond THEN $trueVal ELSE $falseVal END) ";
1790 }
1791
1792 /**
1793 * Returns a comand for str_replace function in SQL query.
1794 * Uses REPLACE() in MySQL
1795 *
1796 * @param $orig String: column to modify
1797 * @param $old String: column to seek
1798 * @param $new String: column to replace with
1799 */
1800 function strreplace( $orig, $old, $new ) {
1801 return "REPLACE({$orig}, {$old}, {$new})";
1802 }
1803
1804 /**
1805 * Determines if the last failure was due to a deadlock
1806 * STUB
1807 */
1808 function wasDeadlock() {
1809 return false;
1810 }
1811
1812 /**
1813 * Determines if the last query error was something that should be dealt
1814 * with by pinging the connection and reissuing the query.
1815 * STUB
1816 */
1817 function wasErrorReissuable() {
1818 return false;
1819 }
1820
1821 /**
1822 * Determines if the last failure was due to the database being read-only.
1823 * STUB
1824 */
1825 function wasReadOnlyError() {
1826 return false;
1827 }
1828
1829 /**
1830 * Perform a deadlock-prone transaction.
1831 *
1832 * This function invokes a callback function to perform a set of write
1833 * queries. If a deadlock occurs during the processing, the transaction
1834 * will be rolled back and the callback function will be called again.
1835 *
1836 * Usage:
1837 * $dbw->deadlockLoop( callback, ... );
1838 *
1839 * Extra arguments are passed through to the specified callback function.
1840 *
1841 * Returns whatever the callback function returned on its successful,
1842 * iteration, or false on error, for example if the retry limit was
1843 * reached.
1844 */
1845 function deadlockLoop() {
1846 $myFname = 'Database::deadlockLoop';
1847
1848 $this->begin();
1849 $args = func_get_args();
1850 $function = array_shift( $args );
1851 $oldIgnore = $this->ignoreErrors( true );
1852 $tries = DEADLOCK_TRIES;
1853 if ( is_array( $function ) ) {
1854 $fname = $function[0];
1855 } else {
1856 $fname = $function;
1857 }
1858 do {
1859 $retVal = call_user_func_array( $function, $args );
1860 $error = $this->lastError();
1861 $errno = $this->lastErrno();
1862 $sql = $this->lastQuery();
1863
1864 if ( $errno ) {
1865 if ( $this->wasDeadlock() ) {
1866 # Retry
1867 usleep( mt_rand( DEADLOCK_DELAY_MIN, DEADLOCK_DELAY_MAX ) );
1868 } else {
1869 $this->reportQueryError( $error, $errno, $sql, $fname );
1870 }
1871 }
1872 } while( $this->wasDeadlock() && --$tries > 0 );
1873 $this->ignoreErrors( $oldIgnore );
1874 if ( $tries <= 0 ) {
1875 $this->rollback( $myFname );
1876 $this->reportQueryError( $error, $errno, $sql, $fname );
1877 return false;
1878 } else {
1879 $this->commit( $myFname );
1880 return $retVal;
1881 }
1882 }
1883
1884 /**
1885 * Do a SELECT MASTER_POS_WAIT()
1886 *
1887 * @param $pos MySQLMasterPos object
1888 * @param $timeout Integer: the maximum number of seconds to wait for synchronisation
1889 */
1890 function masterPosWait( MySQLMasterPos $pos, $timeout ) {
1891 $fname = 'Database::masterPosWait';
1892 wfProfileIn( $fname );
1893
1894 # Commit any open transactions
1895 if ( $this->mTrxLevel ) {
1896 $this->commit();
1897 }
1898
1899 if ( !is_null( $this->mFakeSlaveLag ) ) {
1900 $wait = intval( ( $pos->pos - microtime(true) + $this->mFakeSlaveLag ) * 1e6 );
1901 if ( $wait > $timeout * 1e6 ) {
1902 wfDebug( "Fake slave timed out waiting for $pos ($wait us)\n" );
1903 wfProfileOut( $fname );
1904 return -1;
1905 } elseif ( $wait > 0 ) {
1906 wfDebug( "Fake slave waiting $wait us\n" );
1907 usleep( $wait );
1908 wfProfileOut( $fname );
1909 return 1;
1910 } else {
1911 wfDebug( "Fake slave up to date ($wait us)\n" );
1912 wfProfileOut( $fname );
1913 return 0;
1914 }
1915 }
1916
1917 # Call doQuery() directly, to avoid opening a transaction if DBO_TRX is set
1918 $encFile = $this->addQuotes( $pos->file );
1919 $encPos = intval( $pos->pos );
1920 $sql = "SELECT MASTER_POS_WAIT($encFile, $encPos, $timeout)";
1921 $res = $this->doQuery( $sql );
1922 if ( $res && $row = $this->fetchRow( $res ) ) {
1923 wfProfileOut( $fname );
1924 return $row[0];
1925 } else {
1926 wfProfileOut( $fname );
1927 return false;
1928 }
1929 }
1930
1931 /**
1932 * Get the position of the master from SHOW SLAVE STATUS
1933 */
1934 function getSlavePos() {
1935 if ( !is_null( $this->mFakeSlaveLag ) ) {
1936 $pos = new MySQLMasterPos( 'fake', microtime(true) - $this->mFakeSlaveLag );
1937 wfDebug( __METHOD__.": fake slave pos = $pos\n" );
1938 return $pos;
1939 }
1940 $res = $this->query( 'SHOW SLAVE STATUS', 'Database::getSlavePos' );
1941 $row = $this->fetchObject( $res );
1942 if ( $row ) {
1943 $pos = isset($row->Exec_master_log_pos) ? $row->Exec_master_log_pos : $row->Exec_Master_Log_Pos;
1944 return new MySQLMasterPos( $row->Relay_Master_Log_File, $pos );
1945 } else {
1946 return false;
1947 }
1948 }
1949
1950 /**
1951 * Get the position of the master from SHOW MASTER STATUS
1952 */
1953 function getMasterPos() {
1954 if ( $this->mFakeMaster ) {
1955 return new MySQLMasterPos( 'fake', microtime( true ) );
1956 }
1957 $res = $this->query( 'SHOW MASTER STATUS', 'Database::getMasterPos' );
1958 $row = $this->fetchObject( $res );
1959 if ( $row ) {
1960 return new MySQLMasterPos( $row->File, $row->Position );
1961 } else {
1962 return false;
1963 }
1964 }
1965
1966 /**
1967 * Begin a transaction, committing any previously open transaction
1968 */
1969 function begin( $fname = 'Database::begin' ) {
1970 $this->query( 'BEGIN', $fname );
1971 $this->mTrxLevel = 1;
1972 }
1973
1974 /**
1975 * End a transaction
1976 */
1977 function commit( $fname = 'Database::commit' ) {
1978 if( $this->mTrxLevel ) {
1979 $this->query( 'COMMIT', $fname );
1980 $this->mTrxLevel = 0;
1981 }
1982 }
1983
1984 /**
1985 * Rollback a transaction.
1986 * No-op on non-transactional databases.
1987 */
1988 function rollback( $fname = 'Database::rollback' ) {
1989 if( $this->mTrxLevel ) {
1990 $this->query( 'ROLLBACK', $fname, true );
1991 $this->mTrxLevel = 0;
1992 }
1993 }
1994
1995 /**
1996 * Begin a transaction, committing any previously open transaction
1997 * @deprecated use begin()
1998 */
1999 function immediateBegin( $fname = 'Database::immediateBegin' ) {
2000 wfDeprecated( __METHOD__ );
2001 $this->begin();
2002 }
2003
2004 /**
2005 * Commit transaction, if one is open
2006 * @deprecated use commit()
2007 */
2008 function immediateCommit( $fname = 'Database::immediateCommit' ) {
2009 wfDeprecated( __METHOD__ );
2010 $this->commit();
2011 }
2012
2013 /**
2014 * Creates a new table with structure copied from existing table
2015 * Note that unlike most database abstraction functions, this function does not
2016 * automatically append database prefix, because it works at a lower
2017 * abstraction level.
2018 *
2019 * @param $oldName String: name of table whose structure should be copied
2020 * @param $newName String: name of table to be created
2021 * @param $temporary Boolean: whether the new table should be temporary
2022 * @param $fname String: calling function name
2023 * @return Boolean: true if operation was successful
2024 */
2025 function duplicateTableStructure( $oldName, $newName, $temporary = false, $fname = 'Database::duplicateTableStructure' ) {
2026 throw new MWException( 'DatabaseBase::duplicateTableStructure is not implemented in descendant class' );
2027 }
2028
2029 /**
2030 * Return MW-style timestamp used for MySQL schema
2031 */
2032 function timestamp( $ts=0 ) {
2033 return wfTimestamp(TS_MW,$ts);
2034 }
2035
2036 /**
2037 * Local database timestamp format or null
2038 */
2039 function timestampOrNull( $ts = null ) {
2040 if( is_null( $ts ) ) {
2041 return null;
2042 } else {
2043 return $this->timestamp( $ts );
2044 }
2045 }
2046
2047 /**
2048 * @todo document
2049 */
2050 function resultObject( $result ) {
2051 if( empty( $result ) ) {
2052 return false;
2053 } elseif ( $result instanceof ResultWrapper ) {
2054 return $result;
2055 } elseif ( $result === true ) {
2056 // Successful write query
2057 return $result;
2058 } else {
2059 return new ResultWrapper( $this, $result );
2060 }
2061 }
2062
2063 /**
2064 * Return aggregated value alias
2065 */
2066 function aggregateValue ($valuedata,$valuename='value') {
2067 return $valuename;
2068 }
2069
2070 /**
2071 * Returns a wikitext link to the DB's website, e.g.,
2072 * return "[http://www.mysql.com/ MySQL]";
2073 * Should at least contain plain text, if for some reason
2074 * your database has no website.
2075 *
2076 * @return String: wikitext of a link to the server software's web site
2077 */
2078 abstract function getSoftwareLink();
2079
2080 /**
2081 * A string describing the current software version, like from
2082 * mysql_get_server_info(). Will be listed on Special:Version, etc.
2083 *
2084 * @return String: Version information from the database
2085 */
2086 abstract function getServerVersion();
2087
2088 /**
2089 * Ping the server and try to reconnect if it there is no connection
2090 *
2091 * @return bool Success or failure
2092 */
2093 function ping() {
2094 # Stub. Not essential to override.
2095 return true;
2096 }
2097
2098 /**
2099 * Get slave lag.
2100 * Currently supported only by MySQL
2101 * @return Database replication lag in seconds
2102 */
2103 function getLag() {
2104 return $this->mFakeSlaveLag;
2105 }
2106
2107 /**
2108 * Get status information from SHOW STATUS in an associative array
2109 */
2110 function getStatus($which="%") {
2111 $res = $this->query( "SHOW STATUS LIKE '{$which}'" );
2112 $status = array();
2113 while ( $row = $this->fetchObject( $res ) ) {
2114 $status[$row->Variable_name] = $row->Value;
2115 }
2116 return $status;
2117 }
2118
2119 /**
2120 * Return the maximum number of items allowed in a list, or 0 for unlimited.
2121 */
2122 function maxListLen() {
2123 return 0;
2124 }
2125
2126 function encodeBlob($b) {
2127 return $b;
2128 }
2129
2130 function decodeBlob($b) {
2131 return $b;
2132 }
2133
2134 /**
2135 * Override database's default connection timeout. May be useful for very
2136 * long batch queries such as full-wiki dumps, where a single query reads
2137 * out over hours or days. May or may not be necessary for non-MySQL
2138 * databases. For most purposes, leaving it as a no-op should be fine.
2139 *
2140 * @param $timeout Integer in seconds
2141 */
2142 public function setTimeout( $timeout ) {}
2143
2144 /**
2145 * Read and execute SQL commands from a file.
2146 * Returns true on success, error string or exception on failure (depending on object's error ignore settings)
2147 * @param $filename String: File name to open
2148 * @param $lineCallback Callback: Optional function called before reading each line
2149 * @param $resultCallback Callback: Optional function called for each MySQL result
2150 */
2151 function sourceFile( $filename, $lineCallback = false, $resultCallback = false ) {
2152 $fp = fopen( $filename, 'r' );
2153 if ( false === $fp ) {
2154 if (!defined("MEDIAWIKI_INSTALL"))
2155 throw new MWException( "Could not open \"{$filename}\".\n" );
2156 else
2157 return "Could not open \"{$filename}\".\n";
2158 }
2159 try {
2160 $error = $this->sourceStream( $fp, $lineCallback, $resultCallback );
2161 }
2162 catch( MWException $e ) {
2163 if ( defined("MEDIAWIKI_INSTALL") ) {
2164 $error = $e->getMessage();
2165 } else {
2166 fclose( $fp );
2167 throw $e;
2168 }
2169 }
2170
2171 fclose( $fp );
2172 return $error;
2173 }
2174
2175 /**
2176 * Get the full path of a patch file. Originally based on archive()
2177 * from updaters.inc. Keep in mind this always returns a patch, as
2178 * it fails back to MySQL if no DB-specific patch can be found
2179 *
2180 * @param $patch String The name of the patch, like patch-something.sql
2181 * @return String Full path to patch file
2182 */
2183 public static function patchPath( $patch ) {
2184 global $wgDBtype, $IP;
2185 if ( file_exists( "$IP/maintenance/$wgDBtype/archives/$patch" ) ) {
2186 return "$IP/maintenance/$wgDBtype/archives/$patch";
2187 } else {
2188 return "$IP/maintenance/archives/$patch";
2189 }
2190 }
2191
2192 /**
2193 * Read and execute commands from an open file handle
2194 * Returns true on success, error string or exception on failure (depending on object's error ignore settings)
2195 * @param $fp String: File handle
2196 * @param $lineCallback Callback: Optional function called before reading each line
2197 * @param $resultCallback Callback: Optional function called for each MySQL result
2198 */
2199 function sourceStream( $fp, $lineCallback = false, $resultCallback = false ) {
2200 $cmd = "";
2201 $done = false;
2202 $dollarquote = false;
2203
2204 while ( ! feof( $fp ) ) {
2205 if ( $lineCallback ) {
2206 call_user_func( $lineCallback );
2207 }
2208 $line = trim( fgets( $fp, 1024 ) );
2209 $sl = strlen( $line ) - 1;
2210
2211 if ( $sl < 0 ) { continue; }
2212 if ( '-' == $line{0} && '-' == $line{1} ) { continue; }
2213
2214 ## Allow dollar quoting for function declarations
2215 if (substr($line,0,4) == '$mw$') {
2216 if ($dollarquote) {
2217 $dollarquote = false;
2218 $done = true;
2219 }
2220 else {
2221 $dollarquote = true;
2222 }
2223 }
2224 else if (!$dollarquote) {
2225 if ( ';' == $line{$sl} && ($sl < 2 || ';' != $line{$sl - 1})) {
2226 $done = true;
2227 $line = substr( $line, 0, $sl );
2228 }
2229 }
2230
2231 if ( $cmd != '' ) { $cmd .= ' '; }
2232 $cmd .= "$line\n";
2233
2234 if ( $done ) {
2235 $cmd = str_replace(';;', ";", $cmd);
2236 $cmd = $this->replaceVars( $cmd );
2237 $res = $this->query( $cmd, __METHOD__ );
2238 if ( $resultCallback ) {
2239 call_user_func( $resultCallback, $res, $this );
2240 }
2241
2242 if ( false === $res ) {
2243 $err = $this->lastError();
2244 return "Query \"{$cmd}\" failed with error code \"$err\".\n";
2245 }
2246
2247 $cmd = '';
2248 $done = false;
2249 }
2250 }
2251 return true;
2252 }
2253
2254
2255 /**
2256 * Replace variables in sourced SQL
2257 */
2258 protected function replaceVars( $ins ) {
2259 $varnames = array(
2260 'wgDBserver', 'wgDBname', 'wgDBintlname', 'wgDBuser',
2261 'wgDBpassword', 'wgDBsqluser', 'wgDBsqlpassword',
2262 'wgDBadminuser', 'wgDBadminpassword', 'wgDBTableOptions',
2263 );
2264
2265 // Ordinary variables
2266 foreach ( $varnames as $var ) {
2267 if( isset( $GLOBALS[$var] ) ) {
2268 $val = addslashes( $GLOBALS[$var] ); // FIXME: safety check?
2269 $ins = str_replace( '{$' . $var . '}', $val, $ins );
2270 $ins = str_replace( '/*$' . $var . '*/`', '`' . $val, $ins );
2271 $ins = str_replace( '/*$' . $var . '*/', $val, $ins );
2272 }
2273 }
2274
2275 // Table prefixes
2276 $ins = preg_replace_callback( '!/\*(?:\$wgDBprefix|_)\*/([a-zA-Z_0-9]*)!',
2277 array( $this, 'tableNameCallback' ), $ins );
2278
2279 // Index names
2280 $ins = preg_replace_callback( '!/\*i\*/([a-zA-Z_0-9]*)!',
2281 array( $this, 'indexNameCallback' ), $ins );
2282 return $ins;
2283 }
2284
2285 /**
2286 * Table name callback
2287 * @private
2288 */
2289 protected function tableNameCallback( $matches ) {
2290 return $this->tableName( $matches[1] );
2291 }
2292
2293 /**
2294 * Index name callback
2295 */
2296 protected function indexNameCallback( $matches ) {
2297 return $this->indexName( $matches[1] );
2298 }
2299
2300 /**
2301 * Build a concatenation list to feed into a SQL query
2302 * @param $stringList Array: list of raw SQL expressions; caller is responsible for any quoting
2303 * @return String
2304 */
2305 function buildConcat( $stringList ) {
2306 return 'CONCAT(' . implode( ',', $stringList ) . ')';
2307 }
2308
2309 /**
2310 * Acquire a named lock
2311 *
2312 * Abstracted from Filestore::lock() so child classes can implement for
2313 * their own needs.
2314 *
2315 * @param $lockName String: name of lock to aquire
2316 * @param $method String: name of method calling us
2317 * @param $timeout Integer: timeout
2318 * @return Boolean
2319 */
2320 public function lock( $lockName, $method, $timeout = 5 ) {
2321 return true;
2322 }
2323
2324 /**
2325 * Release a lock.
2326 *
2327 * @param $lockName String: Name of lock to release
2328 * @param $method String: Name of method calling us
2329 *
2330 * @return Returns 1 if the lock was released, 0 if the lock was not established
2331 * by this thread (in which case the lock is not released), and NULL if the named
2332 * lock did not exist
2333 */
2334 public function unlock( $lockName, $method ) {
2335 return true;
2336 }
2337
2338 /**
2339 * Lock specific tables
2340 *
2341 * @param $read Array of tables to lock for read access
2342 * @param $write Array of tables to lock for write access
2343 * @param $method String name of caller
2344 * @param $lowPriority bool Whether to indicate writes to be LOW PRIORITY
2345 */
2346 public function lockTables( $read, $write, $method, $lowPriority = true ) {
2347 return true;
2348 }
2349
2350 /**
2351 * Unlock specific tables
2352 *
2353 * @param $method String the caller
2354 */
2355 public function unlockTables( $method ) {
2356 return true;
2357 }
2358
2359 /**
2360 * Get search engine class. All subclasses of this need to implement this
2361 * if they wish to use searching.
2362 *
2363 * @return String
2364 */
2365 public function getSearchEngine() {
2366 return 'SearchEngineDummy';
2367 }
2368
2369 /**
2370 * Allow or deny "big selects" for this session only. This is done by setting
2371 * the sql_big_selects session variable.
2372 *
2373 * This is a MySQL-specific feature.
2374 *
2375 * @param $value Mixed: true for allow, false for deny, or "default" to restore the initial value
2376 */
2377 public function setBigSelects( $value = true ) {
2378 // no-op
2379 }
2380 }
2381
2382
2383 /******************************************************************************
2384 * Utility classes
2385 *****************************************************************************/
2386
2387 /**
2388 * Utility class.
2389 * @ingroup Database
2390 */
2391 class DBObject {
2392 public $mData;
2393
2394 function DBObject($data) {
2395 $this->mData = $data;
2396 }
2397
2398 function isLOB() {
2399 return false;
2400 }
2401
2402 function data() {
2403 return $this->mData;
2404 }
2405 }
2406
2407 /**
2408 * Utility class
2409 * @ingroup Database
2410 *
2411 * This allows us to distinguish a blob from a normal string and an array of strings
2412 */
2413 class Blob {
2414 private $mData;
2415 function __construct($data) {
2416 $this->mData = $data;
2417 }
2418 function fetch() {
2419 return $this->mData;
2420 }
2421 }
2422
2423 /**
2424 * Utility class.
2425 * @ingroup Database
2426 */
2427 class MySQLField {
2428 private $name, $tablename, $default, $max_length, $nullable,
2429 $is_pk, $is_unique, $is_multiple, $is_key, $type;
2430 function __construct ($info) {
2431 $this->name = $info->name;
2432 $this->tablename = $info->table;
2433 $this->default = $info->def;
2434 $this->max_length = $info->max_length;
2435 $this->nullable = !$info->not_null;
2436 $this->is_pk = $info->primary_key;
2437 $this->is_unique = $info->unique_key;
2438 $this->is_multiple = $info->multiple_key;
2439 $this->is_key = ($this->is_pk || $this->is_unique || $this->is_multiple);
2440 $this->type = $info->type;
2441 }
2442
2443 function name() {
2444 return $this->name;
2445 }
2446
2447 function tableName() {
2448 return $this->tableName;
2449 }
2450
2451 function defaultValue() {
2452 return $this->default;
2453 }
2454
2455 function maxLength() {
2456 return $this->max_length;
2457 }
2458
2459 function nullable() {
2460 return $this->nullable;
2461 }
2462
2463 function isKey() {
2464 return $this->is_key;
2465 }
2466
2467 function isMultipleKey() {
2468 return $this->is_multiple;
2469 }
2470
2471 function type() {
2472 return $this->type;
2473 }
2474 }
2475
2476 /******************************************************************************
2477 * Error classes
2478 *****************************************************************************/
2479
2480 /**
2481 * Database error base class
2482 * @ingroup Database
2483 */
2484 class DBError extends MWException {
2485 public $db;
2486
2487 /**
2488 * Construct a database error
2489 * @param $db Database object which threw the error
2490 * @param $error A simple error message to be used for debugging
2491 */
2492 function __construct( DatabaseBase &$db, $error ) {
2493 $this->db =& $db;
2494 parent::__construct( $error );
2495 }
2496
2497 function getText() {
2498 global $wgShowDBErrorBacktrace;
2499 $s = $this->getMessage() . "\n";
2500 if ( $wgShowDBErrorBacktrace ) {
2501 $s .= "Backtrace:\n" . $this->getTraceAsString() . "\n";
2502 }
2503 return $s;
2504 }
2505 }
2506
2507 /**
2508 * @ingroup Database
2509 */
2510 class DBConnectionError extends DBError {
2511 public $error;
2512
2513 function __construct( DatabaseBase &$db, $error = 'unknown error' ) {
2514 $msg = 'DB connection error';
2515 if ( trim( $error ) != '' ) {
2516 $msg .= ": $error";
2517 }
2518 $this->error = $error;
2519 parent::__construct( $db, $msg );
2520 }
2521
2522 function useOutputPage() {
2523 // Not likely to work
2524 return false;
2525 }
2526
2527 function useMessageCache() {
2528 // Not likely to work
2529 return false;
2530 }
2531
2532 function getLogMessage() {
2533 # Don't send to the exception log
2534 return false;
2535 }
2536
2537 function getPageTitle() {
2538 global $wgSitename, $wgLang;
2539 $header = "$wgSitename has a problem";
2540 if ( $wgLang instanceof Language ) {
2541 $header = htmlspecialchars( $wgLang->getMessage( 'dberr-header' ) );
2542 }
2543
2544 return $header;
2545 }
2546
2547 function getHTML() {
2548 global $wgLang, $wgMessageCache, $wgUseFileCache, $wgShowDBErrorBacktrace;
2549
2550 $sorry = 'Sorry! This site is experiencing technical difficulties.';
2551 $again = 'Try waiting a few minutes and reloading.';
2552 $info = '(Can\'t contact the database server: $1)';
2553
2554 if ( $wgLang instanceof Language ) {
2555 $sorry = htmlspecialchars( $wgLang->getMessage( 'dberr-problems' ) );
2556 $again = htmlspecialchars( $wgLang->getMessage( 'dberr-again' ) );
2557 $info = htmlspecialchars( $wgLang->getMessage( 'dberr-info' ) );
2558 }
2559
2560 # No database access
2561 if ( is_object( $wgMessageCache ) ) {
2562 $wgMessageCache->disable();
2563 }
2564
2565 if ( trim( $this->error ) == '' ) {
2566 $this->error = $this->db->getProperty('mServer');
2567 }
2568
2569 $noconnect = "<p><strong>$sorry</strong><br />$again</p><p><small>$info</small></p>";
2570 $text = str_replace( '$1', $this->error, $noconnect );
2571
2572 if ( $wgShowDBErrorBacktrace ) {
2573 $text .= '<p>Backtrace:</p><p>' . nl2br( htmlspecialchars( $this->getTraceAsString() ) );
2574 }
2575
2576 $extra = $this->searchForm();
2577
2578 if( $wgUseFileCache ) {
2579 try {
2580 $cache = $this->fileCachedPage();
2581 # Cached version on file system?
2582 if( $cache !== null ) {
2583 # Hack: extend the body for error messages
2584 $cache = str_replace( array('</html>','</body>'), '', $cache );
2585 # Add cache notice...
2586 $cachederror = "This is a cached copy of the requested page, and may not be up to date. ";
2587 # Localize it if possible...
2588 if( $wgLang instanceof Language ) {
2589 $cachederror = htmlspecialchars( $wgLang->getMessage( 'dberr-cachederror' ) );
2590 }
2591 $warning = "<div style='color:red;font-size:150%;font-weight:bold;'>$cachederror</div>";
2592 # Output cached page with notices on bottom and re-close body
2593 return "{$cache}{$warning}<hr />$text<hr />$extra</body></html>";
2594 }
2595 } catch( MWException $e ) {
2596 // Do nothing, just use the default page
2597 }
2598 }
2599 # Headers needed here - output is just the error message
2600 return $this->htmlHeader()."$text<hr />$extra".$this->htmlFooter();
2601 }
2602
2603 function searchForm() {
2604 global $wgSitename, $wgServer, $wgLang, $wgInputEncoding;
2605 $usegoogle = "You can try searching via Google in the meantime.";
2606 $outofdate = "Note that their indexes of our content may be out of date.";
2607 $googlesearch = "Search";
2608
2609 if ( $wgLang instanceof Language ) {
2610 $usegoogle = htmlspecialchars( $wgLang->getMessage( 'dberr-usegoogle' ) );
2611 $outofdate = htmlspecialchars( $wgLang->getMessage( 'dberr-outofdate' ) );
2612 $googlesearch = htmlspecialchars( $wgLang->getMessage( 'searchbutton' ) );
2613 }
2614
2615 $search = htmlspecialchars(@$_REQUEST['search']);
2616
2617 $trygoogle = <<<EOT
2618 <div style="margin: 1.5em">$usegoogle<br />
2619 <small>$outofdate</small></div>
2620 <!-- SiteSearch Google -->
2621 <form method="get" action="http://www.google.com/search" id="googlesearch">
2622 <input type="hidden" name="domains" value="$wgServer" />
2623 <input type="hidden" name="num" value="50" />
2624 <input type="hidden" name="ie" value="$wgInputEncoding" />
2625 <input type="hidden" name="oe" value="$wgInputEncoding" />
2626
2627 <input type="text" name="q" size="31" maxlength="255" value="$search" />
2628 <input type="submit" name="btnG" value="$googlesearch" />
2629 <div>
2630 <input type="radio" name="sitesearch" id="gwiki" value="$wgServer" checked="checked" /><label for="gwiki">$wgSitename</label>
2631 <input type="radio" name="sitesearch" id="gWWW" value="" /><label for="gWWW">WWW</label>
2632 </div>
2633 </form>
2634 <!-- SiteSearch Google -->
2635 EOT;
2636 return $trygoogle;
2637 }
2638
2639 function fileCachedPage() {
2640 global $wgTitle, $title, $wgLang, $wgOut;
2641 if( $wgOut->isDisabled() ) return; // Done already?
2642 $mainpage = 'Main Page';
2643 if ( $wgLang instanceof Language ) {
2644 $mainpage = htmlspecialchars( $wgLang->getMessage( 'mainpage' ) );
2645 }
2646
2647 if( $wgTitle ) {
2648 $t =& $wgTitle;
2649 } elseif( $title ) {
2650 $t = Title::newFromURL( $title );
2651 } else {
2652 $t = Title::newFromText( $mainpage );
2653 }
2654
2655 $cache = new HTMLFileCache( $t );
2656 if( $cache->isFileCached() ) {
2657 return $cache->fetchPageText();
2658 } else {
2659 return '';
2660 }
2661 }
2662
2663 function htmlBodyOnly() {
2664 return true;
2665 }
2666
2667 }
2668
2669 /**
2670 * @ingroup Database
2671 */
2672 class DBQueryError extends DBError {
2673 public $error, $errno, $sql, $fname;
2674
2675 function __construct( DatabaseBase &$db, $error, $errno, $sql, $fname ) {
2676 $message = "A database error has occurred\n" .
2677 "Query: $sql\n" .
2678 "Function: $fname\n" .
2679 "Error: $errno $error\n";
2680
2681 parent::__construct( $db, $message );
2682 $this->error = $error;
2683 $this->errno = $errno;
2684 $this->sql = $sql;
2685 $this->fname = $fname;
2686 }
2687
2688 function getText() {
2689 global $wgShowDBErrorBacktrace;
2690 if ( $this->useMessageCache() ) {
2691 $s = wfMsg( 'dberrortextcl', htmlspecialchars( $this->getSQL() ),
2692 htmlspecialchars( $this->fname ), $this->errno, htmlspecialchars( $this->error ) ) . "\n";
2693 if ( $wgShowDBErrorBacktrace ) {
2694 $s .= "Backtrace:\n" . $this->getTraceAsString() . "\n";
2695 }
2696 return $s;
2697 } else {
2698 return parent::getText();
2699 }
2700 }
2701
2702 function getSQL() {
2703 global $wgShowSQLErrors;
2704 if( !$wgShowSQLErrors ) {
2705 return $this->msg( 'sqlhidden', 'SQL hidden' );
2706 } else {
2707 return $this->sql;
2708 }
2709 }
2710
2711 function getLogMessage() {
2712 # Don't send to the exception log
2713 return false;
2714 }
2715
2716 function getPageTitle() {
2717 return $this->msg( 'databaseerror', 'Database error' );
2718 }
2719
2720 function getHTML() {
2721 global $wgShowDBErrorBacktrace;
2722 if ( $this->useMessageCache() ) {
2723 $s = wfMsgNoDB( 'dberrortext', htmlspecialchars( $this->getSQL() ),
2724 htmlspecialchars( $this->fname ), $this->errno, htmlspecialchars( $this->error ) );
2725 } else {
2726 $s = nl2br( htmlspecialchars( $this->getMessage() ) );
2727 }
2728 if ( $wgShowDBErrorBacktrace ) {
2729 $s .= '<p>Backtrace:</p><p>' . nl2br( htmlspecialchars( $this->getTraceAsString() ) );
2730 }
2731 return $s;
2732 }
2733 }
2734
2735 /**
2736 * @ingroup Database
2737 */
2738 class DBUnexpectedError extends DBError {}
2739
2740
2741 /**
2742 * Result wrapper for grabbing data queried by someone else
2743 * @ingroup Database
2744 */
2745 class ResultWrapper implements Iterator {
2746 var $db, $result, $pos = 0, $currentRow = null;
2747
2748 /**
2749 * Create a new result object from a result resource and a Database object
2750 */
2751 function ResultWrapper( $database, $result ) {
2752 $this->db = $database;
2753 if ( $result instanceof ResultWrapper ) {
2754 $this->result = $result->result;
2755 } else {
2756 $this->result = $result;
2757 }
2758 }
2759
2760 /**
2761 * Get the number of rows in a result object
2762 */
2763 function numRows() {
2764 return $this->db->numRows( $this );
2765 }
2766
2767 /**
2768 * Fetch the next row from the given result object, in object form.
2769 * Fields can be retrieved with $row->fieldname, with fields acting like
2770 * member variables.
2771 *
2772 * @return MySQL row object
2773 * @throws DBUnexpectedError Thrown if the database returns an error
2774 */
2775 function fetchObject() {
2776 return $this->db->fetchObject( $this );
2777 }
2778
2779 /**
2780 * Fetch the next row from the given result object, in associative array
2781 * form. Fields are retrieved with $row['fieldname'].
2782 *
2783 * @return MySQL row object
2784 * @throws DBUnexpectedError Thrown if the database returns an error
2785 */
2786 function fetchRow() {
2787 return $this->db->fetchRow( $this );
2788 }
2789
2790 /**
2791 * Free a result object
2792 */
2793 function free() {
2794 $this->db->freeResult( $this );
2795 unset( $this->result );
2796 unset( $this->db );
2797 }
2798
2799 /**
2800 * Change the position of the cursor in a result object
2801 * See mysql_data_seek()
2802 */
2803 function seek( $row ) {
2804 $this->db->dataSeek( $this, $row );
2805 }
2806
2807 /*********************
2808 * Iterator functions
2809 * Note that using these in combination with the non-iterator functions
2810 * above may cause rows to be skipped or repeated.
2811 */
2812
2813 function rewind() {
2814 if ($this->numRows()) {
2815 $this->db->dataSeek($this, 0);
2816 }
2817 $this->pos = 0;
2818 $this->currentRow = null;
2819 }
2820
2821 function current() {
2822 if ( is_null( $this->currentRow ) ) {
2823 $this->next();
2824 }
2825 return $this->currentRow;
2826 }
2827
2828 function key() {
2829 return $this->pos;
2830 }
2831
2832 function next() {
2833 $this->pos++;
2834 $this->currentRow = $this->fetchObject();
2835 return $this->currentRow;
2836 }
2837
2838 function valid() {
2839 return $this->current() !== false;
2840 }
2841 }
2842
2843 /* Overloads the relevant methods of the real ResultsWrapper so it
2844 * doesn't go anywhere near an actual database.
2845 */
2846 class FakeResultWrapper extends ResultWrapper {
2847
2848 var $result = array();
2849 var $db = null; // And it's going to stay that way :D
2850 var $pos = 0;
2851 var $currentRow = null;
2852
2853 function __construct( $array ){
2854 $this->result = $array;
2855 }
2856
2857 function numRows() {
2858 return count( $this->result );
2859 }
2860
2861 function fetchRow() {
2862 $this->currentRow = $this->result[$this->pos++];
2863 return $this->currentRow;
2864 }
2865
2866 function seek( $row ) {
2867 $this->pos = $row;
2868 }
2869
2870 function free() {}
2871
2872 // Callers want to be able to access fields with $this->fieldName
2873 function fetchObject(){
2874 $this->currentRow = $this->result[$this->pos++];
2875 return (object)$this->currentRow;
2876 }
2877
2878 function rewind() {
2879 $this->pos = 0;
2880 $this->currentRow = null;
2881 }
2882 }
2883
2884 /**
2885 * Used by DatabaseBase::buildLike() to represent characters that have special meaning in SQL LIKE clauses
2886 * and thus need no escaping. Don't instantiate it manually, use Database::anyChar() and anyString() instead.
2887 */
2888 class LikeMatch {
2889 private $str;
2890
2891 public function __construct( $s ) {
2892 $this->str = $s;
2893 }
2894
2895 public function toString() {
2896 return $this->str;
2897 }
2898 }
Wiklou, le Wiki du Wiklou