-
Notifications
You must be signed in to change notification settings - Fork 3
/
Database.php
3480 lines (3115 loc) · 97.3 KB
/
Database.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* @defgroup Database Database
*
* @file
* @ingroup Database
* This file deals with database interface functions
* and query specifics/optimisations
*/
/** Number of times to re-try an operation in case of deadlock */
define( 'DEADLOCK_TRIES', 4 );
/** Minimum time to wait before retry, in microseconds */
define( 'DEADLOCK_DELAY_MIN', 500000 );
/** Maximum time to wait before retry */
define( 'DEADLOCK_DELAY_MAX', 1500000 );
/**
* Base interface for all DBMS-specific code. At a bare minimum, all of the
* following must be implemented to support MediaWiki
*
* @file
* @ingroup Database
*/
interface DatabaseType {
/**
* Get the type of the DBMS, as it appears in $wgDBtype.
*
* @return string
*/
function getType();
/**
* Open a connection to the database. Usually aborts on failure
*
* @param $server String: database server host
* @param $user String: database user name
* @param $password String: database user password
* @param $dbName String: database name
* @return bool
* @throws DBConnectionError
*/
function open( $server, $user, $password, $dbName );
/**
* Fetch the next row from the given result object, in object form.
* Fields can be retrieved with $row->fieldname, with fields acting like
* member variables.
*
* @param $res ResultWrapper|object as returned from DatabaseBase::query(), etc.
* @return Row object
* @throws DBUnexpectedError Thrown if the database returns an error
*/
function fetchObject( $res );
/**
* Fetch the next row from the given result object, in associative array
* form. Fields are retrieved with $row['fieldname'].
*
* @param $res ResultWrapper result object as returned from DatabaseBase::query(), etc.
* @return Row object
* @throws DBUnexpectedError Thrown if the database returns an error
*/
function fetchRow( $res );
/**
* Get the number of rows in a result object
*
* @param $res Mixed: A SQL result
* @return int
*/
function numRows( $res );
/**
* Get the number of fields in a result object
* @see http://www.php.net/mysql_num_fields
*
* @param $res Mixed: A SQL result
* @return int
*/
function numFields( $res );
/**
* Get a field name in a result object
* @see http://www.php.net/mysql_field_name
*
* @param $res Mixed: A SQL result
* @param $n Integer
* @return string
*/
function fieldName( $res, $n );
/**
* Get the inserted value of an auto-increment row
*
* The value inserted should be fetched from nextSequenceValue()
*
* Example:
* $id = $dbw->nextSequenceValue('page_page_id_seq');
* $dbw->insert('page',array('page_id' => $id));
* $id = $dbw->insertId();
*
* @return int
*/
function insertId();
/**
* Change the position of the cursor in a result object
* @see http://www.php.net/mysql_data_seek
*
* @param $res Mixed: A SQL result
* @param $row Mixed: Either MySQL row or ResultWrapper
*/
function dataSeek( $res, $row );
/**
* Get the last error number
* @see http://www.php.net/mysql_errno
*
* @return int
*/
function lastErrno();
/**
* Get a description of the last error
* @see http://www.php.net/mysql_error
*
* @return string
*/
function lastError();
/**
* mysql_fetch_field() wrapper
* Returns false if the field doesn't exist
*
* @param $table string: table name
* @param $field string: field name
*
* @return Field
*/
function fieldInfo( $table, $field );
/**
* Get information about an index into an object
* @param $table string: Table name
* @param $index string: Index name
* @param $fname string: Calling function name
* @return Mixed: Database-specific index description class or false if the index does not exist
*/
function indexInfo( $table, $index, $fname = 'Database::indexInfo' );
/**
* Get the number of rows affected by the last write query
* @see http://www.php.net/mysql_affected_rows
*
* @return int
*/
function affectedRows();
/**
* Wrapper for addslashes()
*
* @param $s string: to be slashed.
* @return string: slashed string.
*/
function strencode( $s );
/**
* Returns a wikitext link to the DB's website, e.g.,
* return "[http://www.mysql.com/ MySQL]";
* Should at least contain plain text, if for some reason
* your database has no website.
*
* @return string: wikitext of a link to the server software's web site
*/
static function getSoftwareLink();
/**
* A string describing the current software version, like from
* mysql_get_server_info().
*
* @return string: Version information from the database server.
*/
function getServerVersion();
/**
* A string describing the current software version, and possibly
* other details in a user-friendly way. Will be listed on Special:Version, etc.
* Use getServerVersion() to get machine-friendly information.
*
* @return string: Version information from the database server
*/
function getServerInfo();
}
/**
* Database abstraction object
* @ingroup Database
*/
abstract class DatabaseBase implements DatabaseType {
# ------------------------------------------------------------------------------
# Variables
# ------------------------------------------------------------------------------
protected $mLastQuery = '';
protected $mDoneWrites = false;
protected $mPHPError = false;
protected $mServer, $mUser, $mPassword, $mDBname;
/**
* @var DatabaseBase
*/
protected $mConn = null;
protected $mOpened = false;
protected $mTablePrefix;
protected $mFlags;
protected $mTrxLevel = 0;
protected $mErrorCount = 0;
protected $mLBInfo = array();
protected $mFakeSlaveLag = null, $mFakeMaster = false;
protected $mDefaultBigSelects = null;
protected $mSchemaVars = false;
protected $preparedArgs;
protected $htmlErrors;
protected $delimiter = ';';
# ------------------------------------------------------------------------------
# Accessors
# ------------------------------------------------------------------------------
# These optionally set a variable and return the previous state
/**
* A string describing the current software version, and possibly
* other details in a user-friendly way. Will be listed on Special:Version, etc.
* Use getServerVersion() to get machine-friendly information.
*
* @return string: Version information from the database server
*/
public function getServerInfo() {
return $this->getServerVersion();
}
/**
* Boolean, controls output of large amounts of debug information.
* @param $debug bool|null
* - true to enable debugging
* - false to disable debugging
* - omitted or null to do nothing
*
* @return bool|null previous value of the flag
*/
function debug( $debug = null ) {
return wfSetBit( $this->mFlags, DBO_DEBUG, $debug );
}
/**
* Turns buffering of SQL result sets on (true) or off (false). Default is
* "on".
*
* Unbuffered queries are very troublesome in MySQL:
*
* - If another query is executed while the first query is being read
* out, the first query is killed. This means you can't call normal
* MediaWiki functions while you are reading an unbuffered query result
* from a normal wfGetDB() connection.
*
* - Unbuffered queries cause the MySQL server to use large amounts of
* memory and to hold broad locks which block other queries.
*
* If you want to limit client-side memory, it's almost always better to
* split up queries into batches using a LIMIT clause than to switch off
* buffering.
*
* @param $buffer null|bool
*
* @return null|bool The previous value of the flag
*/
function bufferResults( $buffer = null ) {
if ( is_null( $buffer ) ) {
return !(bool)( $this->mFlags & DBO_NOBUFFER );
} else {
return !wfSetBit( $this->mFlags, DBO_NOBUFFER, !$buffer );
}
}
/**
* Turns on (false) or off (true) the automatic generation and sending
* of a "we're sorry, but there has been a database error" page on
* database errors. Default is on (false). When turned off, the
* code should use lastErrno() and lastError() to handle the
* situation as appropriate.
*
* @param $ignoreErrors bool|null
*
* @return bool The previous value of the flag.
*/
function ignoreErrors( $ignoreErrors = null ) {
return wfSetBit( $this->mFlags, DBO_IGNORE, $ignoreErrors );
}
/**
* Gets or sets the current transaction level.
*
* Historically, transactions were allowed to be "nested". This is no
* longer supported, so this function really only returns a boolean.
*
* @param $level int An integer (0 or 1), or omitted to leave it unchanged.
* @return int The previous value
*/
function trxLevel( $level = null ) {
return wfSetVar( $this->mTrxLevel, $level );
}
/**
* Get/set the number of errors logged. Only useful when errors are ignored
* @param $count int The count to set, or omitted to leave it unchanged.
* @return int The error count
*/
function errorCount( $count = null ) {
return wfSetVar( $this->mErrorCount, $count );
}
/**
* Get/set the table prefix.
* @param $prefix string The table prefix to set, or omitted to leave it unchanged.
* @return string The previous table prefix.
*/
function tablePrefix( $prefix = null ) {
return wfSetVar( $this->mTablePrefix, $prefix );
}
/**
* Get properties passed down from the server info array of the load
* balancer.
*
* @param $name string The entry of the info array to get, or null to get the
* whole array
*
* @return LoadBalancer|null
*/
function getLBInfo( $name = null ) {
if ( is_null( $name ) ) {
return $this->mLBInfo;
} else {
if ( array_key_exists( $name, $this->mLBInfo ) ) {
return $this->mLBInfo[$name];
} else {
return null;
}
}
}
/**
* Set the LB info array, or a member of it. If called with one parameter,
* the LB info array is set to that parameter. If it is called with two
* parameters, the member with the given name is set to the given value.
*
* @param $name
* @param $value
*/
function setLBInfo( $name, $value = null ) {
if ( is_null( $value ) ) {
$this->mLBInfo = $name;
} else {
$this->mLBInfo[$name] = $value;
}
}
/**
* Set lag time in seconds for a fake slave
*
* @param $lag int
*/
function setFakeSlaveLag( $lag ) {
$this->mFakeSlaveLag = $lag;
}
/**
* Make this connection a fake master
*
* @param $enabled bool
*/
function setFakeMaster( $enabled = true ) {
$this->mFakeMaster = $enabled;
}
/**
* Returns true if this database supports (and uses) cascading deletes
*
* @return bool
*/
function cascadingDeletes() {
return false;
}
/**
* Returns true if this database supports (and uses) triggers (e.g. on the page table)
*
* @return bool
*/
function cleanupTriggers() {
return false;
}
/**
* Returns true if this database is strict about what can be put into an IP field.
* Specifically, it uses a NULL value instead of an empty string.
*
* @return bool
*/
function strictIPs() {
return false;
}
/**
* Returns true if this database uses timestamps rather than integers
*
* @return bool
*/
function realTimestamps() {
return false;
}
/**
* Returns true if this database does an implicit sort when doing GROUP BY
*
* @return bool
*/
function implicitGroupby() {
return true;
}
/**
* Returns true if this database does an implicit order by when the column has an index
* For example: SELECT page_title FROM page LIMIT 1
*
* @return bool
*/
function implicitOrderby() {
return true;
}
/**
* Returns true if this database requires that SELECT DISTINCT queries require that all
ORDER BY expressions occur in the SELECT list per the SQL92 standard
*
* @return bool
*/
function standardSelectDistinct() {
return true;
}
/**
* Returns true if this database can do a native search on IP columns
* e.g. this works as expected: .. WHERE rc_ip = '127.42.12.102/32';
*
* @return bool
*/
function searchableIPs() {
return false;
}
/**
* Returns true if this database can use functional indexes
*
* @return bool
*/
function functionalIndexes() {
return false;
}
/**
* Return the last query that went through DatabaseBase::query()
* @return String
*/
function lastQuery() {
return $this->mLastQuery;
}
/**
* Returns true if the connection may have been used for write queries.
* Should return true if unsure.
*
* @return bool
*/
function doneWrites() {
return $this->mDoneWrites;
}
/**
* Is a connection to the database open?
* @return Boolean
*/
function isOpen() {
return $this->mOpened;
}
/**
* Set a flag for this connection
*
* @param $flag Integer: DBO_* constants from Defines.php:
* - DBO_DEBUG: output some debug info (same as debug())
* - DBO_NOBUFFER: don't buffer results (inverse of bufferResults())
* - DBO_IGNORE: ignore errors (same as ignoreErrors())
* - DBO_TRX: automatically start transactions
* - DBO_DEFAULT: automatically sets DBO_TRX if not in command line mode
* and removes it in command line mode
* - DBO_PERSISTENT: use persistant database connection
*/
function setFlag( $flag ) {
$this->mFlags |= $flag;
}
/**
* Clear a flag for this connection
*
* @param $flag: same as setFlag()'s $flag param
*/
function clearFlag( $flag ) {
$this->mFlags &= ~$flag;
}
/**
* Returns a boolean whether the flag $flag is set for this connection
*
* @param $flag: same as setFlag()'s $flag param
* @return Boolean
*/
function getFlag( $flag ) {
return !!( $this->mFlags & $flag );
}
/**
* General read-only accessor
*
* @param $name string
*
* @return string
*/
function getProperty( $name ) {
return $this->$name;
}
/**
* @return string
*/
function getWikiID() {
if ( $this->mTablePrefix ) {
return "{$this->mDBname}-{$this->mTablePrefix}";
} else {
return $this->mDBname;
}
}
/**
* Return a path to the DBMS-specific schema file, otherwise default to tables.sql
*
* @return string
*/
public function getSchemaPath() {
global $IP;
if ( file_exists( "$IP/maintenance/" . $this->getType() . "/tables.sql" ) ) {
return "$IP/maintenance/" . $this->getType() . "/tables.sql";
} else {
return "$IP/maintenance/tables.sql";
}
}
# ------------------------------------------------------------------------------
# Other functions
# ------------------------------------------------------------------------------
/**
* Constructor.
* @param $server String: database server host
* @param $user String: database user name
* @param $password String: database user password
* @param $dbName String: database name
* @param $flags
* @param $tablePrefix String: database table prefixes. By default use the prefix gave in LocalSettings.php
*/
function __construct( $server = false, $user = false, $password = false, $dbName = false,
$flags = 0, $tablePrefix = 'get from global'
) {
global $wgDBprefix, $wgCommandLineMode;
$this->mFlags = $flags;
if ( $this->mFlags & DBO_DEFAULT ) {
if ( $wgCommandLineMode ) {
$this->mFlags &= ~DBO_TRX;
} else {
$this->mFlags |= DBO_TRX;
}
}
/** Get the default table prefix*/
if ( $tablePrefix == 'get from global' ) {
$this->mTablePrefix = $wgDBprefix;
} else {
$this->mTablePrefix = $tablePrefix;
}
if ( $user ) {
$this->open( $server, $user, $password, $dbName );
}
}
/**
* Called by serialize. Throw an exception when DB connection is serialized.
* This causes problems on some database engines because the connection is
* not restored on unserialize.
*/
public function __sleep() {
throw new MWException( 'Database serialization may cause problems, since the connection is not restored on wakeup.' );
}
/**
* Same as new DatabaseMysql( ... ), kept for backward compatibility
* @deprecated since 1.17
*
* @param $server
* @param $user
* @param $password
* @param $dbName
* @param $flags int
* @return DatabaseMysql
*/
static function newFromParams( $server, $user, $password, $dbName, $flags = 0 ) {
wfDeprecated( __METHOD__, '1.17' );
return new DatabaseMysql( $server, $user, $password, $dbName, $flags );
}
/**
* Same as new factory( ... ), kept for backward compatibility
* @deprecated since 1.18
* @see Database::factory()
* @return DatabaseBase
*/
public final static function newFromType( $dbType, $p = array() ) {
wfDeprecated( __METHOD__, '1.18' );
if ( isset( $p['tableprefix'] ) ) {
$p['tablePrefix'] = $p['tableprefix'];
}
return self::factory( $dbType, $p );
}
/**
* Given a DB type, construct the name of the appropriate child class of
* DatabaseBase. This is designed to replace all of the manual stuff like:
* $class = 'Database' . ucfirst( strtolower( $type ) );
* as well as validate against the canonical list of DB types we have
*
* This factory function is mostly useful for when you need to connect to a
* database other than the MediaWiki default (such as for external auth,
* an extension, et cetera). Do not use this to connect to the MediaWiki
* database. Example uses in core:
* @see LoadBalancer::reallyOpenConnection()
* @see ExternalUser_MediaWiki::initFromCond()
* @see ForeignDBRepo::getMasterDB()
* @see WebInstaller_DBConnect::execute()
*
* @since 1.18
*
* @param $dbType String A possible DB type
* @param $p Array An array of options to pass to the constructor.
* Valid options are: host, user, password, dbname, flags, tablePrefix
* @return DatabaseBase subclass or null
*/
public final static function factory( $dbType, $p = array() ) {
$canonicalDBTypes = array(
'mysql', 'postgres', 'sqlite', 'oracle', 'mssql', 'ibm_db2'
);
$dbType = strtolower( $dbType );
$class = 'Database' . ucfirst( $dbType );
if( in_array( $dbType, $canonicalDBTypes ) || ( class_exists( $class ) && is_subclass_of( $class, 'DatabaseBase' ) ) ) {
return new $class(
isset( $p['host'] ) ? $p['host'] : false,
isset( $p['user'] ) ? $p['user'] : false,
isset( $p['password'] ) ? $p['password'] : false,
isset( $p['dbname'] ) ? $p['dbname'] : false,
isset( $p['flags'] ) ? $p['flags'] : 0,
isset( $p['tablePrefix'] ) ? $p['tablePrefix'] : 'get from global'
);
} else {
return null;
}
}
protected function installErrorHandler() {
$this->mPHPError = false;
$this->htmlErrors = ini_set( 'html_errors', '0' );
set_error_handler( array( $this, 'connectionErrorHandler' ) );
}
/**
* @return bool|string
*/
protected function restoreErrorHandler() {
restore_error_handler();
if ( $this->htmlErrors !== false ) {
ini_set( 'html_errors', $this->htmlErrors );
}
if ( $this->mPHPError ) {
$error = preg_replace( '!\[<a.*</a>\]!', '', $this->mPHPError );
$error = preg_replace( '!^.*?:\s?(.*)$!', '$1', $error );
return $error;
} else {
return false;
}
}
/**
* @param $errno
* @param $errstr
*/
protected function connectionErrorHandler( $errno, $errstr ) {
$this->mPHPError = $errstr;
}
/**
* Closes a database connection.
* if it is open : commits any open transactions
*
* @return Bool operation success. true if already closed.
*/
public function close() {
$this->mOpened = false;
if ( $this->mConn ) {
if ( $this->trxLevel() ) {
$this->commit( __METHOD__ );
}
$ret = $this->closeConnection();
$this->mConn = false;
return $ret;
} else {
return true;
}
}
/**
* Closes underlying database connection
* @since 1.20
* @return bool: Whether connection was closed successfully
*/
protected abstract function closeConnection();
/**
* @param $error String: fallback error message, used if none is given by DB
*/
function reportConnectionError( $error = 'Unknown error' ) {
$myError = $this->lastError();
if ( $myError ) {
$error = $myError;
}
# New method
throw new DBConnectionError( $this, $error );
}
/**
* The DBMS-dependent part of query()
*
* @param $sql String: SQL query.
* @return ResultWrapper Result object to feed to fetchObject, fetchRow, ...; or false on failure
*/
protected abstract function doQuery( $sql );
/**
* Determine whether a query writes to the DB.
* Should return true if unsure.
*
* @param $sql string
*
* @return bool
*/
function isWriteQuery( $sql ) {
return !preg_match( '/^(?:SELECT|BEGIN|ROLLBACK|COMMIT|SET|SHOW|\(SELECT)\b/i', $sql );
}
/**
* Run an SQL query and return the result. Normally throws a DBQueryError
* on failure. If errors are ignored, returns false instead.
*
* In new code, the query wrappers select(), insert(), update(), delete(),
* etc. should be used where possible, since they give much better DBMS
* independence and automatically quote or validate user input in a variety
* of contexts. This function is generally only useful for queries which are
* explicitly DBMS-dependent and are unsupported by the query wrappers, such
* as CREATE TABLE.
*
* However, the query wrappers themselves should call this function.
*
* @param $sql String: SQL query
* @param $fname String: Name of the calling function, for profiling/SHOW PROCESSLIST
* comment (you can use __METHOD__ or add some extra info)
* @param $tempIgnore Boolean: Whether to avoid throwing an exception on errors...
* maybe best to catch the exception instead?
* @return boolean|ResultWrapper. true for a successful write query, ResultWrapper object
* for a successful read query, or false on failure if $tempIgnore set
* @throws DBQueryError Thrown when the database returns an error of any kind
*/
public function query( $sql, $fname = '', $tempIgnore = false ) {
$isMaster = !is_null( $this->getLBInfo( 'master' ) );
if ( !Profiler::instance()->isStub() ) {
# generalizeSQL will probably cut down the query to reasonable
# logging size most of the time. The substr is really just a sanity check.
if ( $isMaster ) {
$queryProf = 'query-m: ' . substr( DatabaseBase::generalizeSQL( $sql ), 0, 255 );
$totalProf = 'DatabaseBase::query-master';
} else {
$queryProf = 'query: ' . substr( DatabaseBase::generalizeSQL( $sql ), 0, 255 );
$totalProf = 'DatabaseBase::query';
}
wfProfileIn( $totalProf );
wfProfileIn( $queryProf );
}
$this->mLastQuery = $sql;
if ( !$this->mDoneWrites && $this->isWriteQuery( $sql ) ) {
# Set a flag indicating that writes have been done
wfDebug( __METHOD__ . ": Writes done: $sql\n" );
$this->mDoneWrites = true;
}
# Add a comment for easy SHOW PROCESSLIST interpretation
global $wgUser;
if ( is_object( $wgUser ) && $wgUser->isItemLoaded( 'name' ) ) {
$userName = $wgUser->getName();
if ( mb_strlen( $userName ) > 15 ) {
$userName = mb_substr( $userName, 0, 15 ) . '...';
}
$userName = str_replace( '/', '', $userName );
} else {
$userName = '';
}
$commentedSql = preg_replace( '/\s/', " /* $fname $userName */ ", $sql, 1 );
# If DBO_TRX is set, start a transaction
if ( ( $this->mFlags & DBO_TRX ) && !$this->trxLevel() &&
$sql != 'BEGIN' && $sql != 'COMMIT' && $sql != 'ROLLBACK' ) {
# avoid establishing transactions for SHOW and SET statements too -
# that would delay transaction initializations to once connection
# is really used by application
$sqlstart = substr( $sql, 0, 10 ); // very much worth it, benchmark certified(tm)
if ( strpos( $sqlstart, "SHOW " ) !== 0 && strpos( $sqlstart, "SET " ) !== 0 )
$this->begin( __METHOD__ . " ($fname)" );
}
if ( $this->debug() ) {
static $cnt = 0;
$cnt++;
$sqlx = substr( $commentedSql, 0, 500 );
$sqlx = strtr( $sqlx, "\t\n", ' ' );
$master = $isMaster ? 'master' : 'slave';
wfDebug( "Query {$this->mDBname} ($cnt) ($master): $sqlx\n" );
}
if ( istainted( $sql ) & TC_MYSQL ) {
throw new MWException( 'Tainted query found' );
}
$queryId = MWDebug::query( $sql, $fname, $isMaster );
# Do the query and handle errors
$ret = $this->doQuery( $commentedSql );
MWDebug::queryTime( $queryId );
# Try reconnecting if the connection was lost
if ( false === $ret && $this->wasErrorReissuable() ) {
# Transaction is gone, like it or not
$this->mTrxLevel = 0;
wfDebug( "Connection lost, reconnecting...\n" );
if ( $this->ping() ) {
wfDebug( "Reconnected\n" );
$sqlx = substr( $commentedSql, 0, 500 );
$sqlx = strtr( $sqlx, "\t\n", ' ' );
global $wgRequestTime;
$elapsed = round( microtime( true ) - $wgRequestTime, 3 );
if ( $elapsed < 300 ) {
# Not a database error to lose a transaction after a minute or two
wfLogDBError( "Connection lost and reconnected after {$elapsed}s, query: $sqlx\n" );
}
$ret = $this->doQuery( $commentedSql );
} else {
wfDebug( "Failed\n" );
}
}
if ( false === $ret ) {
$this->reportQueryError( $this->lastError(), $this->lastErrno(), $sql, $fname, $tempIgnore );
}
if ( !Profiler::instance()->isStub() ) {
wfProfileOut( $queryProf );
wfProfileOut( $totalProf );
}
return $this->resultObject( $ret );
}
/**
* Report a query error. Log the error, and if neither the object ignore
* flag nor the $tempIgnore flag is set, throw a DBQueryError.
*
* @param $error String
* @param $errno Integer
* @param $sql String
* @param $fname String
* @param $tempIgnore Boolean
*/
function reportQueryError( $error, $errno, $sql, $fname, $tempIgnore = false ) {
# Ignore errors during error handling to avoid infinite recursion
$ignore = $this->ignoreErrors( true );
++$this->mErrorCount;
if ( $ignore || $tempIgnore ) {
wfDebug( "SQL ERROR (ignored): $error\n" );
$this->ignoreErrors( $ignore );
} else {
$sql1line = str_replace( "\n", "\\n", $sql );
wfLogDBError( "$fname\t{$this->mServer}\t$errno\t$error\t$sql1line\n" );
wfDebug( "SQL ERROR: " . $error . "\n" );
throw new DBQueryError( $this, $error, $errno, $sql, $fname );
}
}
/**
* Intended to be compatible with the PEAR::DB wrapper functions.
* http://pear.php.net/manual/en/package.database.db.intro-execute.php
*
* ? = scalar value, quoted as necessary
* ! = raw SQL bit (a function for instance)
* & = filename; reads the file and inserts as a blob
* (we don't use this though...)
*
* This function should not be used directly by new code outside of the
* database classes. The query wrapper functions (select() etc.) should be
* used instead.
*
* @param $sql string
* @param $func string
*
* @return array
*/
function prepare( $sql, $func = 'DatabaseBase::prepare' ) {
/* MySQL doesn't support prepared statements (yet), so just
pack up the query for reference. We'll manually replace
the bits later. */
return array( 'query' => $sql, 'func' => $func );
}
/**
* Free a prepared query, generated by prepare().
* @param $prepared
*/
function freePrepared( $prepared ) {
/* No-op by default */
}
/**
* Execute a prepared query with the various arguments
* @param $prepared String: the prepared sql
* @param $args Mixed: Either an array here, or put scalars as varargs
*
* @return ResultWrapper
*/
function execute( $prepared, $args = null ) {
if ( !is_array( $args ) ) {
# Pull the var args
$args = func_get_args();
array_shift( $args );
}
$sql = $this->fillPrepared( $prepared['query'], $args );
return $this->query( $sql, $prepared['func'] );
}
/**
* Prepare & execute an SQL statement, quoting and inserting arguments
* in the appropriate places.
*
* This function should not be used directly by new code outside of the
* database classes. The query wrapper functions (select() etc.) should be
* used instead.
*