MediaWiki  master
DatabaseMysqlBase.php
Go to the documentation of this file.
1 <?php
23 namespace Wikimedia\Rdbms;
24 
32 
41 abstract class DatabaseMysqlBase extends Database {
47  protected $lagDetectionOptions = [];
49  protected $useGTIDs = false;
51  protected $sslKeyPath;
53  protected $sslCertPath;
55  protected $sslCAFile;
57  protected $sslCAPath;
59  protected $sslCiphers;
61  protected $sqlMode;
63  protected $utf8Mode;
65  protected $defaultBigSelects = null;
66 
68  private $serverVersion = null;
73 
74  // Cache getServerId() for 24 hours
75  const SERVER_ID_CACHE_TTL = 86400;
76 
78  const LAG_STALE_WARN_THRESHOLD = 0.100;
79 
99  function __construct( array $params ) {
100  $this->lagDetectionMethod = $params['lagDetectionMethod'] ?? 'Seconds_Behind_Master';
101  $this->lagDetectionOptions = $params['lagDetectionOptions'] ?? [];
102  $this->useGTIDs = !empty( $params['useGTIDs' ] );
103  foreach ( [ 'KeyPath', 'CertPath', 'CAFile', 'CAPath', 'Ciphers' ] as $name ) {
104  $var = "ssl{$name}";
105  if ( isset( $params[$var] ) ) {
106  $this->$var = $params[$var];
107  }
108  }
109  $this->sqlMode = $params['sqlMode'] ?? null;
110  $this->utf8Mode = !empty( $params['utf8Mode'] );
111  $this->insertSelectIsSafe = isset( $params['insertSelectIsSafe'] )
112  ? (bool)$params['insertSelectIsSafe'] : null;
113 
114  parent::__construct( $params );
115  }
116 
120  public function getType() {
121  return 'mysql';
122  }
123 
124  protected function open( $server, $user, $password, $dbName, $schema, $tablePrefix ) {
125  # Close/unset connection handle
126  $this->close();
127 
128  $this->server = $server;
129  $this->user = $user;
130  $this->password = $password;
131 
132  $this->installErrorHandler();
133  try {
134  $this->conn = $this->mysqlConnect( $this->server, $dbName );
135  } catch ( Exception $ex ) {
136  $this->restoreErrorHandler();
137  throw $ex;
138  }
139  $error = $this->restoreErrorHandler();
140 
141  # Always log connection errors
142  if ( !$this->conn ) {
143  $error = $error ?: $this->lastError();
144  $this->connLogger->error(
145  "Error connecting to {db_server}: {error}",
146  $this->getLogContext( [
147  'method' => __METHOD__,
148  'error' => $error,
149  ] )
150  );
151  $this->connLogger->debug( "DB connection error\n" .
152  "Server: $server, User: $user, Password: " .
153  substr( $password, 0, 3 ) . "..., error: " . $error . "\n" );
154 
155  throw new DBConnectionError( $this, $error );
156  }
157 
158  if ( strlen( $dbName ) ) {
159  $this->selectDomain( new DatabaseDomain( $dbName, null, $tablePrefix ) );
160  } else {
161  $this->currentDomain = new DatabaseDomain( null, null, $tablePrefix );
162  }
163 
164  // Tell the server what we're communicating with
165  if ( !$this->connectInitCharset() ) {
166  $error = $this->lastError();
167  $this->queryLogger->error(
168  "Error setting character set: {error}",
169  $this->getLogContext( [
170  'method' => __METHOD__,
171  'error' => $this->lastError(),
172  ] )
173  );
174  throw new DBConnectionError( $this, "Error setting character set: $error" );
175  }
176 
177  // Abstract over any insane MySQL defaults
178  $set = [ 'group_concat_max_len = 262144' ];
179  // Set SQL mode, default is turning them all off, can be overridden or skipped with null
180  if ( is_string( $this->sqlMode ) ) {
181  $set[] = 'sql_mode = ' . $this->addQuotes( $this->sqlMode );
182  }
183  // Set any custom settings defined by site config
184  // (e.g. https://dev.mysql.com/doc/refman/4.1/en/innodb-parameters.html)
185  foreach ( $this->connectionVariables as $var => $val ) {
186  // Escape strings but not numbers to avoid MySQL complaining
187  if ( !is_int( $val ) && !is_float( $val ) ) {
188  $val = $this->addQuotes( $val );
189  }
190  $set[] = $this->addIdentifierQuotes( $var ) . ' = ' . $val;
191  }
192 
193  if ( $set ) {
194  // Use doQuery() to avoid opening implicit transactions (DBO_TRX)
195  $success = $this->doQuery( 'SET ' . implode( ', ', $set ) );
196  if ( !$success ) {
197  $error = $this->lastError();
198  $this->queryLogger->error(
199  'Error setting MySQL variables on server {db_server}: {error}',
200  $this->getLogContext( [
201  'method' => __METHOD__,
202  'error' => $error,
203  ] )
204  );
205  throw new DBConnectionError( $this, "Error setting MySQL variables: $error" );
206  }
207  }
208 
209  $this->opened = true;
210 
211  return true;
212  }
213 
218  protected function connectInitCharset() {
219  if ( $this->utf8Mode ) {
220  // Tell the server we're communicating with it in UTF-8.
221  // This may engage various charset conversions.
222  return $this->mysqlSetCharset( 'utf8' );
223  } else {
224  return $this->mysqlSetCharset( 'binary' );
225  }
226  }
227 
228  protected function doSelectDomain( DatabaseDomain $domain ) {
229  if ( $domain->getSchema() !== null ) {
230  throw new DBExpectedError( $this, __CLASS__ . ": domain schemas are not supported." );
231  }
232 
233  $database = $domain->getDatabase();
234  // A null database means "don't care" so leave it as is and update the table prefix
235  if ( $database === null ) {
236  $this->currentDomain = new DatabaseDomain(
237  $this->currentDomain->getDatabase(),
238  null,
239  $domain->getTablePrefix()
240  );
241 
242  return true;
243  }
244 
245  if ( $database !== $this->getDBname() ) {
246  $sql = 'USE ' . $this->addIdentifierQuotes( $database );
247  list( $res, $err, $errno ) =
248  $this->executeQuery( $sql, __METHOD__, self::QUERY_IGNORE_DBO_TRX );
249 
250  if ( $res === false ) {
251  $this->reportQueryError( $err, $errno, $sql, __METHOD__ );
252  return false; // unreachable
253  }
254  }
255 
256  // Update that domain fields on success (no exception thrown)
257  $this->currentDomain = $domain;
258 
259  return true;
260  }
261 
270  abstract protected function mysqlConnect( $realServer, $dbName );
271 
278  abstract protected function mysqlSetCharset( $charset );
279 
284  public function freeResult( $res ) {
285  if ( $res instanceof ResultWrapper ) {
286  $res = $res->result;
287  }
288  Wikimedia\suppressWarnings();
289  $ok = $this->mysqlFreeResult( $res );
290  Wikimedia\restoreWarnings();
291  if ( !$ok ) {
292  throw new DBUnexpectedError( $this, "Unable to free MySQL result" );
293  }
294  }
295 
302  abstract protected function mysqlFreeResult( $res );
303 
309  public function fetchObject( $res ) {
310  if ( $res instanceof ResultWrapper ) {
311  $res = $res->result;
312  }
313  Wikimedia\suppressWarnings();
314  $row = $this->mysqlFetchObject( $res );
315  Wikimedia\restoreWarnings();
316 
317  $errno = $this->lastErrno();
318  // Unfortunately, mysql_fetch_object does not reset the last errno.
319  // Only check for CR_SERVER_LOST and CR_UNKNOWN_ERROR, as
320  // these are the only errors mysql_fetch_object can cause.
321  // See https://dev.mysql.com/doc/refman/5.0/en/mysql-fetch-row.html.
322  if ( $errno == 2000 || $errno == 2013 ) {
323  throw new DBUnexpectedError(
324  $this,
325  'Error in fetchObject(): ' . htmlspecialchars( $this->lastError() )
326  );
327  }
328 
329  return $row;
330  }
331 
338  abstract protected function mysqlFetchObject( $res );
339 
345  public function fetchRow( $res ) {
346  if ( $res instanceof ResultWrapper ) {
347  $res = $res->result;
348  }
349  Wikimedia\suppressWarnings();
350  $row = $this->mysqlFetchArray( $res );
351  Wikimedia\restoreWarnings();
352 
353  $errno = $this->lastErrno();
354  // Unfortunately, mysql_fetch_array does not reset the last errno.
355  // Only check for CR_SERVER_LOST and CR_UNKNOWN_ERROR, as
356  // these are the only errors mysql_fetch_array can cause.
357  // See https://dev.mysql.com/doc/refman/5.0/en/mysql-fetch-row.html.
358  if ( $errno == 2000 || $errno == 2013 ) {
359  throw new DBUnexpectedError(
360  $this,
361  'Error in fetchRow(): ' . htmlspecialchars( $this->lastError() )
362  );
363  }
364 
365  return $row;
366  }
367 
374  abstract protected function mysqlFetchArray( $res );
375 
381  function numRows( $res ) {
382  if ( $res instanceof ResultWrapper ) {
383  $res = $res->result;
384  }
385  Wikimedia\suppressWarnings();
386  $n = !is_bool( $res ) ? $this->mysqlNumRows( $res ) : 0;
387  Wikimedia\restoreWarnings();
388 
389  // Unfortunately, mysql_num_rows does not reset the last errno.
390  // We are not checking for any errors here, since
391  // there are no errors mysql_num_rows can cause.
392  // See https://dev.mysql.com/doc/refman/5.0/en/mysql-fetch-row.html.
393  // See https://phabricator.wikimedia.org/T44430
394  return $n;
395  }
396 
403  abstract protected function mysqlNumRows( $res );
404 
409  public function numFields( $res ) {
410  if ( $res instanceof ResultWrapper ) {
411  $res = $res->result;
412  }
413 
414  return $this->mysqlNumFields( $res );
415  }
416 
423  abstract protected function mysqlNumFields( $res );
424 
430  public function fieldName( $res, $n ) {
431  if ( $res instanceof ResultWrapper ) {
432  $res = $res->result;
433  }
434 
435  return $this->mysqlFieldName( $res, $n );
436  }
437 
445  abstract protected function mysqlFieldName( $res, $n );
446 
453  public function fieldType( $res, $n ) {
454  if ( $res instanceof ResultWrapper ) {
455  $res = $res->result;
456  }
457 
458  return $this->mysqlFieldType( $res, $n );
459  }
460 
468  abstract protected function mysqlFieldType( $res, $n );
469 
475  public function dataSeek( $res, $row ) {
476  if ( $res instanceof ResultWrapper ) {
477  $res = $res->result;
478  }
479 
480  return $this->mysqlDataSeek( $res, $row );
481  }
482 
490  abstract protected function mysqlDataSeek( $res, $row );
491 
495  public function lastError() {
496  if ( $this->conn ) {
497  # Even if it's non-zero, it can still be invalid
498  Wikimedia\suppressWarnings();
499  $error = $this->mysqlError( $this->conn );
500  if ( !$error ) {
501  $error = $this->mysqlError();
502  }
503  Wikimedia\restoreWarnings();
504  } else {
505  $error = $this->mysqlError();
506  }
507  if ( $error ) {
508  $error .= ' (' . $this->server . ')';
509  }
510 
511  return $error;
512  }
513 
520  abstract protected function mysqlError( $conn = null );
521 
522  protected function wasQueryTimeout( $error, $errno ) {
523  // https://dev.mysql.com/doc/refman/8.0/en/client-error-reference.html
524  // https://phabricator.wikimedia.org/T170638
525  return in_array( $errno, [ 2062, 3024 ] );
526  }
527 
528  public function replace( $table, $uniqueIndexes, $rows, $fname = __METHOD__ ) {
529  $this->nativeReplace( $table, $rows, $fname );
530  }
531 
532  protected function isInsertSelectSafe( array $insertOptions, array $selectOptions ) {
533  $row = $this->getReplicationSafetyInfo();
534  // For row-based-replication, the resulting changes will be relayed, not the query
535  if ( $row->binlog_format === 'ROW' ) {
536  return true;
537  }
538  // LIMIT requires ORDER BY on a unique key or it is non-deterministic
539  if ( isset( $selectOptions['LIMIT'] ) ) {
540  return false;
541  }
542  // In MySQL, an INSERT SELECT is only replication safe with row-based
543  // replication or if innodb_autoinc_lock_mode is 0. When those
544  // conditions aren't met, use non-native mode.
545  // While we could try to determine if the insert is safe anyway by
546  // checking if the target table has an auto-increment column that
547  // isn't set in $varMap, that seems unlikely to be worth the extra
548  // complexity.
549  return (
550  in_array( 'NO_AUTO_COLUMNS', $insertOptions ) ||
551  (int)$row->innodb_autoinc_lock_mode === 0
552  );
553  }
554 
558  protected function getReplicationSafetyInfo() {
559  if ( $this->replicationInfoRow === null ) {
560  $this->replicationInfoRow = $this->selectRow(
561  false,
562  [
563  'innodb_autoinc_lock_mode' => '@@innodb_autoinc_lock_mode',
564  'binlog_format' => '@@binlog_format',
565  ],
566  [],
567  __METHOD__
568  );
569  }
570 
572  }
573 
587  public function estimateRowCount( $table, $var = '*', $conds = '',
588  $fname = __METHOD__, $options = [], $join_conds = []
589  ) {
590  $conds = $this->normalizeConditions( $conds, $fname );
591  $column = $this->extractSingleFieldFromList( $var );
592  if ( is_string( $column ) && !in_array( $column, [ '*', '1' ] ) ) {
593  $conds[] = "$column IS NOT NULL";
594  }
595 
596  $options['EXPLAIN'] = true;
597  $res = $this->select( $table, $var, $conds, $fname, $options, $join_conds );
598  if ( $res === false ) {
599  return false;
600  }
601  if ( !$this->numRows( $res ) ) {
602  return 0;
603  }
604 
605  $rows = 1;
606  foreach ( $res as $plan ) {
607  $rows *= $plan->rows > 0 ? $plan->rows : 1; // avoid resetting to zero
608  }
609 
610  return (int)$rows;
611  }
612 
613  public function tableExists( $table, $fname = __METHOD__ ) {
614  // Split database and table into proper variables as Database::tableName() returns
615  // shared tables prefixed with their database, which do not work in SHOW TABLES statements
616  list( $database, , $prefix, $table ) = $this->qualifiedTableComponents( $table );
617  $tableName = "{$prefix}{$table}";
618 
619  if ( isset( $this->sessionTempTables[$tableName] ) ) {
620  return true; // already known to exist and won't show in SHOW TABLES anyway
621  }
622 
623  // We can't use buildLike() here, because it specifies an escape character
624  // other than the backslash, which is the only one supported by SHOW TABLES
625  $encLike = $this->escapeLikeInternal( $tableName, '\\' );
626 
627  // If the database has been specified (such as for shared tables), use "FROM"
628  if ( $database !== '' ) {
629  $encDatabase = $this->addIdentifierQuotes( $database );
630  $query = "SHOW TABLES FROM $encDatabase LIKE '$encLike'";
631  } else {
632  $query = "SHOW TABLES LIKE '$encLike'";
633  }
634 
635  return $this->query( $query, $fname )->numRows() > 0;
636  }
637 
643  public function fieldInfo( $table, $field ) {
644  $table = $this->tableName( $table );
645  $res = $this->query( "SELECT * FROM $table LIMIT 1", __METHOD__, true );
646  if ( !$res ) {
647  return false;
648  }
649  $n = $this->mysqlNumFields( $res->result );
650  for ( $i = 0; $i < $n; $i++ ) {
651  $meta = $this->mysqlFetchField( $res->result, $i );
652  if ( $field == $meta->name ) {
653  return new MySQLField( $meta );
654  }
655  }
656 
657  return false;
658  }
659 
667  abstract protected function mysqlFetchField( $res, $n );
668 
678  public function indexInfo( $table, $index, $fname = __METHOD__ ) {
679  # SHOW INDEX works in MySQL 3.23.58, but SHOW INDEXES does not.
680  # SHOW INDEX should work for 3.x and up:
681  # https://dev.mysql.com/doc/mysql/en/SHOW_INDEX.html
682  $table = $this->tableName( $table );
683  $index = $this->indexName( $index );
684 
685  $sql = 'SHOW INDEX FROM ' . $table;
686  $res = $this->query( $sql, $fname );
687 
688  if ( !$res ) {
689  return null;
690  }
691 
692  $result = [];
693 
694  foreach ( $res as $row ) {
695  if ( $row->Key_name == $index ) {
696  $result[] = $row;
697  }
698  }
699 
700  return $result ?: false;
701  }
702 
707  public function strencode( $s ) {
708  return $this->mysqlRealEscapeString( $s );
709  }
710 
715  abstract protected function mysqlRealEscapeString( $s );
716 
717  public function addQuotes( $s ) {
718  if ( is_bool( $s ) ) {
719  // Parent would transform to int, which does not play nice with MySQL type juggling.
720  // When searching for an int in a string column, the strings are cast to int, which
721  // means false would match any string not starting with a number.
722  $s = (string)(int)$s;
723  }
724  return parent::addQuotes( $s );
725  }
726 
733  public function addIdentifierQuotes( $s ) {
734  // Characters in the range \u0001-\uFFFF are valid in a quoted identifier
735  // Remove NUL bytes and escape backticks by doubling
736  return '`' . str_replace( [ "\0", '`' ], [ '', '``' ], $s ) . '`';
737  }
738 
743  public function isQuotedIdentifier( $name ) {
744  return strlen( $name ) && $name[0] == '`' && substr( $name, -1, 1 ) == '`';
745  }
746 
747  protected function doGetLag() {
748  if ( $this->getLagDetectionMethod() === 'pt-heartbeat' ) {
749  return $this->getLagFromPtHeartbeat();
750  } else {
751  return $this->getLagFromSlaveStatus();
752  }
753  }
754 
758  protected function getLagDetectionMethod() {
760  }
761 
765  protected function getLagFromSlaveStatus() {
766  $res = $this->query( 'SHOW SLAVE STATUS', __METHOD__ );
767  $row = $res ? $res->fetchObject() : false;
768  // If the server is not replicating, there will be no row
769  if ( $row && strval( $row->Seconds_Behind_Master ) !== '' ) {
770  return intval( $row->Seconds_Behind_Master );
771  }
772 
773  return false;
774  }
775 
779  protected function getLagFromPtHeartbeat() {
781 
782  $currentTrxInfo = $this->getRecordedTransactionLagStatus();
783  if ( $currentTrxInfo ) {
784  // There is an active transaction and the initial lag was already queried
785  $staleness = microtime( true ) - $currentTrxInfo['since'];
786  if ( $staleness > self::LAG_STALE_WARN_THRESHOLD ) {
787  // Avoid returning higher and higher lag value due to snapshot age
788  // given that the isolation level will typically be REPEATABLE-READ
789  $this->queryLogger->warning(
790  "Using cached lag value for {db_server} due to active transaction",
791  $this->getLogContext( [
792  'method' => __METHOD__,
793  'age' => $staleness,
794  'trace' => ( new RuntimeException() )->getTraceAsString()
795  ] )
796  );
797  }
798 
799  return $currentTrxInfo['lag'];
800  }
801 
802  if ( isset( $options['conds'] ) ) {
803  // Best method for multi-DC setups: use logical channel names
804  $data = $this->getHeartbeatData( $options['conds'] );
805  } else {
806  // Standard method: use master server ID (works with stock pt-heartbeat)
807  $masterInfo = $this->getMasterServerInfo();
808  if ( !$masterInfo ) {
809  $this->queryLogger->error(
810  "Unable to query master of {db_server} for server ID",
811  $this->getLogContext( [
812  'method' => __METHOD__
813  ] )
814  );
815 
816  return false; // could not get master server ID
817  }
818 
819  $conds = [ 'server_id' => intval( $masterInfo['serverId'] ) ];
820  $data = $this->getHeartbeatData( $conds );
821  }
822 
823  list( $time, $nowUnix ) = $data;
824  if ( $time !== null ) {
825  // @time is in ISO format like "2015-09-25T16:48:10.000510"
826  $dateTime = new DateTime( $time, new DateTimeZone( 'UTC' ) );
827  $timeUnix = (int)$dateTime->format( 'U' ) + $dateTime->format( 'u' ) / 1e6;
828 
829  return max( $nowUnix - $timeUnix, 0.0 );
830  }
831 
832  $this->queryLogger->error(
833  "Unable to find pt-heartbeat row for {db_server}",
834  $this->getLogContext( [
835  'method' => __METHOD__
836  ] )
837  );
838 
839  return false;
840  }
841 
842  protected function getMasterServerInfo() {
844  $key = $cache->makeGlobalKey(
845  'mysql',
846  'master-info',
847  // Using one key for all cluster replica DBs is preferable
848  $this->getLBInfo( 'clusterMasterHost' ) ?: $this->getServer()
849  );
850  $fname = __METHOD__;
851 
852  return $cache->getWithSetCallback(
853  $key,
854  $cache::TTL_INDEFINITE,
855  function () use ( $cache, $key, $fname ) {
856  // Get and leave a lock key in place for a short period
857  if ( !$cache->lock( $key, 0, 10 ) ) {
858  return false; // avoid master connection spike slams
859  }
860 
861  $conn = $this->getLazyMasterHandle();
862  if ( !$conn ) {
863  return false; // something is misconfigured
864  }
865 
866  // Connect to and query the master; catch errors to avoid outages
867  try {
868  $res = $conn->query( 'SELECT @@server_id AS id', $fname );
869  $row = $res ? $res->fetchObject() : false;
870  $id = $row ? (int)$row->id : 0;
871  } catch ( DBError $e ) {
872  $id = 0;
873  }
874 
875  // Cache the ID if it was retrieved
876  return $id ? [ 'serverId' => $id, 'asOf' => time() ] : false;
877  }
878  );
879  }
880 
886  protected function getHeartbeatData( array $conds ) {
887  // Query time and trip time are not counted
888  $nowUnix = microtime( true );
889  // Do not bother starting implicit transactions here
890  $this->clearFlag( self::DBO_TRX, self::REMEMBER_PRIOR );
891  try {
892  $whereSQL = $this->makeList( $conds, self::LIST_AND );
893  // Use ORDER BY for channel based queries since that field might not be UNIQUE.
894  // Note: this would use "TIMESTAMPDIFF(MICROSECOND,ts,UTC_TIMESTAMP(6))" but the
895  // percision field is not supported in MySQL <= 5.5.
896  $res = $this->query(
897  "SELECT ts FROM heartbeat.heartbeat WHERE $whereSQL ORDER BY ts DESC LIMIT 1",
898  __METHOD__
899  );
900  $row = $res ? $res->fetchObject() : false;
901  } finally {
902  $this->restoreFlags();
903  }
904 
905  return [ $row ? $row->ts : null, $nowUnix ];
906  }
907 
908  protected function getApproximateLagStatus() {
909  if ( $this->getLagDetectionMethod() === 'pt-heartbeat' ) {
910  // Disable caching since this is fast enough and we don't wan't
911  // to be *too* pessimistic by having both the cache TTL and the
912  // pt-heartbeat interval count as lag in getSessionLagStatus()
913  return parent::getApproximateLagStatus();
914  }
915 
916  $key = $this->srvCache->makeGlobalKey( 'mysql-lag', $this->getServer() );
917  $approxLag = $this->srvCache->get( $key );
918  if ( !$approxLag ) {
919  $approxLag = parent::getApproximateLagStatus();
920  $this->srvCache->set( $key, $approxLag, 1 );
921  }
922 
923  return $approxLag;
924  }
925 
926  public function masterPosWait( DBMasterPos $pos, $timeout ) {
927  if ( !( $pos instanceof MySQLMasterPos ) ) {
928  throw new InvalidArgumentException( "Position not an instance of MySQLMasterPos" );
929  }
930 
931  if ( $this->getLBInfo( 'is static' ) === true ) {
932  return 0; // this is a copy of a read-only dataset with no master DB
933  } elseif ( $this->lastKnownReplicaPos && $this->lastKnownReplicaPos->hasReached( $pos ) ) {
934  return 0; // already reached this point for sure
935  }
936 
937  // Call doQuery() directly, to avoid opening a transaction if DBO_TRX is set
938  if ( $pos->getGTIDs() ) {
939  // Ignore GTIDs from domains exclusive to the master DB (presumably inactive)
940  $rpos = $this->getReplicaPos();
941  $gtidsWait = $rpos ? MySQLMasterPos::getCommonDomainGTIDs( $pos, $rpos ) : [];
942  if ( !$gtidsWait ) {
943  $this->queryLogger->error(
944  "No GTIDs with the same domain between master ($pos) and replica ($rpos)",
945  $this->getLogContext( [
946  'method' => __METHOD__,
947  ] )
948  );
949 
950  return -1; // $pos is from the wrong cluster?
951  }
952  // Wait on the GTID set (MariaDB only)
953  $gtidArg = $this->addQuotes( implode( ',', $gtidsWait ) );
954  if ( strpos( $gtidArg, ':' ) !== false ) {
955  // MySQL GTIDs, e.g "source_id:transaction_id"
956  $sql = "SELECT WAIT_FOR_EXECUTED_GTID_SET($gtidArg, $timeout)";
957  } else {
958  // MariaDB GTIDs, e.g."domain:server:sequence"
959  $sql = "SELECT MASTER_GTID_WAIT($gtidArg, $timeout)";
960  }
961  } else {
962  // Wait on the binlog coordinates
963  $encFile = $this->addQuotes( $pos->getLogFile() );
964  $encPos = intval( $pos->getLogPosition()[$pos::CORD_EVENT] );
965  $sql = "SELECT MASTER_POS_WAIT($encFile, $encPos, $timeout)";
966  }
967 
968  list( $res, $err ) = $this->executeQuery( $sql, __METHOD__, self::QUERY_IGNORE_DBO_TRX );
969  $row = $res ? $this->fetchRow( $res ) : false;
970  if ( !$row ) {
971  throw new DBExpectedError( $this, "Replication wait failed: {$err}" );
972  }
973 
974  // Result can be NULL (error), -1 (timeout), or 0+ per the MySQL manual
975  $status = ( $row[0] !== null ) ? intval( $row[0] ) : null;
976  if ( $status === null ) {
977  if ( !$pos->getGTIDs() ) {
978  // T126436: jobs programmed to wait on master positions might be referencing
979  // binlogs with an old master hostname; this makes MASTER_POS_WAIT() return null.
980  // Try to detect this case and treat the replica DB as having reached the given
981  // position (any master switchover already requires that the new master be caught
982  // up before the switch).
983  $replicationPos = $this->getReplicaPos();
984  if ( $replicationPos && !$replicationPos->channelsMatch( $pos ) ) {
985  $this->lastKnownReplicaPos = $replicationPos;
986  $status = 0;
987  }
988  }
989  } elseif ( $status >= 0 ) {
990  // Remember that this position was reached to save queries next time
991  $this->lastKnownReplicaPos = $pos;
992  }
993 
994  return $status;
995  }
996 
1002  public function getReplicaPos() {
1003  $now = microtime( true ); // as-of-time *before* fetching GTID variables
1004 
1005  if ( $this->useGTIDs() ) {
1006  // Try to use GTIDs, fallbacking to binlog positions if not possible
1007  $data = $this->getServerGTIDs( __METHOD__ );
1008  // Use gtid_slave_pos for MariaDB and gtid_executed for MySQL
1009  foreach ( [ 'gtid_slave_pos', 'gtid_executed' ] as $name ) {
1010  if ( isset( $data[$name] ) && strlen( $data[$name] ) ) {
1011  return new MySQLMasterPos( $data[$name], $now );
1012  }
1013  }
1014  }
1015 
1016  $data = $this->getServerRoleStatus( 'SLAVE', __METHOD__ );
1017  if ( $data && strlen( $data['Relay_Master_Log_File'] ) ) {
1018  return new MySQLMasterPos(
1019  "{$data['Relay_Master_Log_File']}/{$data['Exec_Master_Log_Pos']}",
1020  $now
1021  );
1022  }
1023 
1024  return false;
1025  }
1026 
1032  public function getMasterPos() {
1033  $now = microtime( true ); // as-of-time *before* fetching GTID variables
1034 
1035  $pos = false;
1036  if ( $this->useGTIDs() ) {
1037  // Try to use GTIDs, fallbacking to binlog positions if not possible
1038  $data = $this->getServerGTIDs( __METHOD__ );
1039  // Use gtid_binlog_pos for MariaDB and gtid_executed for MySQL
1040  foreach ( [ 'gtid_binlog_pos', 'gtid_executed' ] as $name ) {
1041  if ( isset( $data[$name] ) && strlen( $data[$name] ) ) {
1042  $pos = new MySQLMasterPos( $data[$name], $now );
1043  break;
1044  }
1045  }
1046  // Filter domains that are inactive or not relevant to the session
1047  if ( $pos ) {
1048  $pos->setActiveOriginServerId( $this->getServerId() );
1049  $pos->setActiveOriginServerUUID( $this->getServerUUID() );
1050  if ( isset( $data['gtid_domain_id'] ) ) {
1051  $pos->setActiveDomain( $data['gtid_domain_id'] );
1052  }
1053  }
1054  }
1055 
1056  if ( !$pos ) {
1057  $data = $this->getServerRoleStatus( 'MASTER', __METHOD__ );
1058  if ( $data && strlen( $data['File'] ) ) {
1059  $pos = new MySQLMasterPos( "{$data['File']}/{$data['Position']}", $now );
1060  }
1061  }
1062 
1063  return $pos;
1064  }
1065 
1070  protected function getServerId() {
1071  $fname = __METHOD__;
1072  return $this->srvCache->getWithSetCallback(
1073  $this->srvCache->makeGlobalKey( 'mysql-server-id', $this->getServer() ),
1074  self::SERVER_ID_CACHE_TTL,
1075  function () use ( $fname ) {
1076  $res = $this->query( "SELECT @@server_id AS id", $fname );
1077  return intval( $this->fetchObject( $res )->id );
1078  }
1079  );
1080  }
1081 
1085  protected function getServerUUID() {
1086  return $this->srvCache->getWithSetCallback(
1087  $this->srvCache->makeGlobalKey( 'mysql-server-uuid', $this->getServer() ),
1088  self::SERVER_ID_CACHE_TTL,
1089  function () {
1090  $res = $this->query( "SHOW GLOBAL VARIABLES LIKE 'server_uuid'" );
1091  $row = $this->fetchObject( $res );
1092 
1093  return $row ? $row->Value : null;
1094  }
1095  );
1096  }
1097 
1102  protected function getServerGTIDs( $fname = __METHOD__ ) {
1103  $map = [];
1104  // Get global-only variables like gtid_executed
1105  $res = $this->query( "SHOW GLOBAL VARIABLES LIKE 'gtid_%'", $fname );
1106  foreach ( $res as $row ) {
1107  $map[$row->Variable_name] = $row->Value;
1108  }
1109  // Get session-specific (e.g. gtid_domain_id since that is were writes will log)
1110  $res = $this->query( "SHOW SESSION VARIABLES LIKE 'gtid_%'", $fname );
1111  foreach ( $res as $row ) {
1112  $map[$row->Variable_name] = $row->Value;
1113  }
1114 
1115  return $map;
1116  }
1117 
1123  protected function getServerRoleStatus( $role, $fname = __METHOD__ ) {
1124  return $this->query( "SHOW $role STATUS", $fname )->fetchRow() ?: [];
1125  }
1126 
1127  public function serverIsReadOnly() {
1128  $res = $this->query( "SHOW GLOBAL VARIABLES LIKE 'read_only'", __METHOD__ );
1129  $row = $this->fetchObject( $res );
1130 
1131  return $row ? ( strtolower( $row->Value ) === 'on' ) : false;
1132  }
1133 
1138  function useIndexClause( $index ) {
1139  return "FORCE INDEX (" . $this->indexName( $index ) . ")";
1140  }
1141 
1146  function ignoreIndexClause( $index ) {
1147  return "IGNORE INDEX (" . $this->indexName( $index ) . ")";
1148  }
1149 
1153  function lowPriorityOption() {
1154  return 'LOW_PRIORITY';
1155  }
1156 
1160  public function getSoftwareLink() {
1161  // MariaDB includes its name in its version string; this is how MariaDB's version of
1162  // the mysql command-line client identifies MariaDB servers (see mariadb_connection()
1163  // in libmysql/libmysql.c).
1164  $version = $this->getServerVersion();
1165  if ( strpos( $version, 'MariaDB' ) !== false || strpos( $version, '-maria-' ) !== false ) {
1166  return '[{{int:version-db-mariadb-url}} MariaDB]';
1167  }
1168 
1169  // Percona Server's version suffix is not very distinctive, and @@version_comment
1170  // doesn't give the necessary info for source builds, so assume the server is MySQL.
1171  // (Even Percona's version of mysql doesn't try to make the distinction.)
1172  return '[{{int:version-db-mysql-url}} MySQL]';
1173  }
1174 
1178  public function getServerVersion() {
1179  // Not using mysql_get_server_info() or similar for consistency: in the handshake,
1180  // MariaDB 10 adds the prefix "5.5.5-", and only some newer client libraries strip
1181  // it off (see RPL_VERSION_HACK in include/mysql_com.h).
1182  if ( $this->serverVersion === null ) {
1183  $this->serverVersion = $this->selectField( '', 'VERSION()', '', __METHOD__ );
1184  }
1185  return $this->serverVersion;
1186  }
1187 
1191  public function setSessionOptions( array $options ) {
1192  if ( isset( $options['connTimeout'] ) ) {
1193  $timeout = (int)$options['connTimeout'];
1194  $this->query( "SET net_read_timeout=$timeout" );
1195  $this->query( "SET net_write_timeout=$timeout" );
1196  }
1197  }
1198 
1204  public function streamStatementEnd( &$sql, &$newLine ) {
1205  if ( strtoupper( substr( $newLine, 0, 9 ) ) == 'DELIMITER' ) {
1206  preg_match( '/^DELIMITER\s+(\S+)/', $newLine, $m );
1207  $this->delimiter = $m[1];
1208  $newLine = '';
1209  }
1210 
1211  return parent::streamStatementEnd( $sql, $newLine );
1212  }
1213 
1222  public function lockIsFree( $lockName, $method ) {
1223  if ( !parent::lockIsFree( $lockName, $method ) ) {
1224  return false; // already held
1225  }
1226 
1227  $encName = $this->addQuotes( $this->makeLockName( $lockName ) );
1228  $result = $this->query( "SELECT IS_FREE_LOCK($encName) AS lockstatus", $method );
1229  $row = $this->fetchObject( $result );
1230 
1231  return ( $row->lockstatus == 1 );
1232  }
1233 
1240  public function lock( $lockName, $method, $timeout = 5 ) {
1241  $encName = $this->addQuotes( $this->makeLockName( $lockName ) );
1242  $result = $this->query( "SELECT GET_LOCK($encName, $timeout) AS lockstatus", $method );
1243  $row = $this->fetchObject( $result );
1244 
1245  if ( $row->lockstatus == 1 ) {
1246  parent::lock( $lockName, $method, $timeout ); // record
1247  return true;
1248  }
1249 
1250  $this->queryLogger->info( __METHOD__ . " failed to acquire lock '{lockname}'",
1251  [ 'lockname' => $lockName ] );
1252 
1253  return false;
1254  }
1255 
1263  public function unlock( $lockName, $method ) {
1264  $encName = $this->addQuotes( $this->makeLockName( $lockName ) );
1265  $result = $this->query( "SELECT RELEASE_LOCK($encName) as lockstatus", $method );
1266  $row = $this->fetchObject( $result );
1267 
1268  if ( $row->lockstatus == 1 ) {
1269  parent::unlock( $lockName, $method ); // record
1270  return true;
1271  }
1272 
1273  $this->queryLogger->warning( __METHOD__ . " failed to release lock '$lockName'\n" );
1274 
1275  return false;
1276  }
1277 
1278  private function makeLockName( $lockName ) {
1279  // https://dev.mysql.com/doc/refman/5.7/en/miscellaneous-functions.html#function_get-lock
1280  // Newer version enforce a 64 char length limit.
1281  return ( strlen( $lockName ) > 64 ) ? sha1( $lockName ) : $lockName;
1282  }
1283 
1284  public function namedLocksEnqueue() {
1285  return true;
1286  }
1287 
1289  return false; // tied to TCP connection
1290  }
1291 
1292  protected function doLockTables( array $read, array $write, $method ) {
1293  $items = [];
1294  foreach ( $write as $table ) {
1295  $items[] = $this->tableName( $table ) . ' WRITE';
1296  }
1297  foreach ( $read as $table ) {
1298  $items[] = $this->tableName( $table ) . ' READ';
1299  }
1300 
1301  $sql = "LOCK TABLES " . implode( ',', $items );
1302  $this->query( $sql, $method );
1303 
1304  return true;
1305  }
1306 
1307  protected function doUnlockTables( $method ) {
1308  $this->query( "UNLOCK TABLES", $method );
1309 
1310  return true;
1311  }
1312 
1316  public function setBigSelects( $value = true ) {
1317  if ( $value === 'default' ) {
1318  if ( $this->defaultBigSelects === null ) {
1319  # Function hasn't been called before so it must already be set to the default
1320  return;
1321  } else {
1323  }
1324  } elseif ( $this->defaultBigSelects === null ) {
1325  $this->defaultBigSelects =
1326  (bool)$this->selectField( false, '@@sql_big_selects', '', __METHOD__ );
1327  }
1328  $encValue = $value ? '1' : '0';
1329  $this->query( "SET sql_big_selects=$encValue", __METHOD__ );
1330  }
1331 
1342  public function deleteJoin(
1343  $delTable, $joinTable, $delVar, $joinVar, $conds, $fname = __METHOD__
1344  ) {
1345  if ( !$conds ) {
1346  throw new DBUnexpectedError( $this, __METHOD__ . ' called with empty $conds' );
1347  }
1348 
1349  $delTable = $this->tableName( $delTable );
1350  $joinTable = $this->tableName( $joinTable );
1351  $sql = "DELETE $delTable FROM $delTable, $joinTable WHERE $delVar=$joinVar ";
1352 
1353  if ( $conds != '*' ) {
1354  $sql .= ' AND ' . $this->makeList( $conds, self::LIST_AND );
1355  }
1356 
1357  $this->query( $sql, $fname );
1358  }
1359 
1360  public function upsert(
1361  $table, array $rows, $uniqueIndexes, array $set, $fname = __METHOD__
1362  ) {
1363  if ( $rows === [] ) {
1364  return true; // nothing to do
1365  }
1366 
1367  if ( !is_array( reset( $rows ) ) ) {
1368  $rows = [ $rows ];
1369  }
1370 
1371  $table = $this->tableName( $table );
1372  $columns = array_keys( $rows[0] );
1373 
1374  $sql = "INSERT INTO $table (" . implode( ',', $columns ) . ') VALUES ';
1375  $rowTuples = [];
1376  foreach ( $rows as $row ) {
1377  $rowTuples[] = '(' . $this->makeList( $row ) . ')';
1378  }
1379  $sql .= implode( ',', $rowTuples );
1380  $sql .= " ON DUPLICATE KEY UPDATE " . $this->makeList( $set, self::LIST_SET );
1381 
1382  $this->query( $sql, $fname );
1383 
1384  return true;
1385  }
1386 
1392  public function getServerUptime() {
1393  $vars = $this->getMysqlStatus( 'Uptime' );
1394 
1395  return (int)$vars['Uptime'];
1396  }
1397 
1403  public function wasDeadlock() {
1404  return $this->lastErrno() == 1213;
1405  }
1406 
1412  public function wasLockTimeout() {
1413  return $this->lastErrno() == 1205;
1414  }
1415 
1421  public function wasReadOnlyError() {
1422  return $this->lastErrno() == 1223 ||
1423  ( $this->lastErrno() == 1290 && strpos( $this->lastError(), '--read-only' ) !== false );
1424  }
1425 
1426  public function wasConnectionError( $errno ) {
1427  return $errno == 2013 || $errno == 2006;
1428  }
1429 
1430  protected function wasKnownStatementRollbackError() {
1431  $errno = $this->lastErrno();
1432 
1433  if ( $errno === 1205 ) { // lock wait timeout
1434  // Note that this is uncached to avoid stale values of SET is used
1435  $row = $this->selectRow(
1436  false,
1437  [ 'innodb_rollback_on_timeout' => '@@innodb_rollback_on_timeout' ],
1438  [],
1439  __METHOD__
1440  );
1441  // https://dev.mysql.com/doc/refman/5.7/en/innodb-error-handling.html
1442  // https://dev.mysql.com/doc/refman/5.5/en/innodb-parameters.html
1443  return $row->innodb_rollback_on_timeout ? false : true;
1444  }
1445 
1446  // See https://dev.mysql.com/doc/refman/5.5/en/error-messages-server.html
1447  return in_array( $errno, [ 1022, 1062, 1216, 1217, 1137, 1146, 1051, 1054 ], true );
1448  }
1449 
1457  public function duplicateTableStructure(
1458  $oldName, $newName, $temporary = false, $fname = __METHOD__
1459  ) {
1460  $tmp = $temporary ? 'TEMPORARY ' : '';
1461  $newName = $this->addIdentifierQuotes( $newName );
1462  $oldName = $this->addIdentifierQuotes( $oldName );
1463  $query = "CREATE $tmp TABLE $newName (LIKE $oldName)";
1464 
1465  return $this->query( $query, $fname, $this::QUERY_PSEUDO_PERMANENT );
1466  }
1467 
1475  public function listTables( $prefix = null, $fname = __METHOD__ ) {
1476  $result = $this->query( "SHOW TABLES", $fname );
1477 
1478  $endArray = [];
1479 
1480  foreach ( $result as $table ) {
1481  $vars = get_object_vars( $table );
1482  $table = array_pop( $vars );
1483 
1484  if ( !$prefix || strpos( $table, $prefix ) === 0 ) {
1485  $endArray[] = $table;
1486  }
1487  }
1488 
1489  return $endArray;
1490  }
1491 
1497  public function dropTable( $tableName, $fName = __METHOD__ ) {
1498  if ( !$this->tableExists( $tableName, $fName ) ) {
1499  return false;
1500  }
1501 
1502  return $this->query( "DROP TABLE IF EXISTS " . $this->tableName( $tableName ), $fName );
1503  }
1504 
1511  private function getMysqlStatus( $which = "%" ) {
1512  $res = $this->query( "SHOW STATUS LIKE '{$which}'" );
1513  $status = [];
1514 
1515  foreach ( $res as $row ) {
1516  $status[$row->Variable_name] = $row->Value;
1517  }
1518 
1519  return $status;
1520  }
1521 
1531  public function listViews( $prefix = null, $fname = __METHOD__ ) {
1532  // The name of the column containing the name of the VIEW
1533  $propertyName = 'Tables_in_' . $this->getDBname();
1534 
1535  // Query for the VIEWS
1536  $res = $this->query( 'SHOW FULL TABLES WHERE TABLE_TYPE = "VIEW"' );
1537  $allViews = [];
1538  foreach ( $res as $row ) {
1539  array_push( $allViews, $row->$propertyName );
1540  }
1541 
1542  if ( is_null( $prefix ) || $prefix === '' ) {
1543  return $allViews;
1544  }
1545 
1546  $filteredViews = [];
1547  foreach ( $allViews as $viewName ) {
1548  // Does the name of this VIEW start with the table-prefix?
1549  if ( strpos( $viewName, $prefix ) === 0 ) {
1550  array_push( $filteredViews, $viewName );
1551  }
1552  }
1553 
1554  return $filteredViews;
1555  }
1556 
1565  public function isView( $name, $prefix = null ) {
1566  return in_array( $name, $this->listViews( $prefix ) );
1567  }
1568 
1569  protected function isTransactableQuery( $sql ) {
1570  return parent::isTransactableQuery( $sql ) &&
1571  !preg_match( '/^SELECT\s+(GET|RELEASE|IS_FREE)_LOCK\(/', $sql );
1572  }
1573 
1574  public function buildStringCast( $field ) {
1575  return "CAST( $field AS BINARY )";
1576  }
1577 
1582  public function buildIntegerCast( $field ) {
1583  return 'CAST( ' . $field . ' AS SIGNED )';
1584  }
1585 
1586  /*
1587  * @return bool Whether GTID support is used (mockable for testing)
1588  */
1589  protected function useGTIDs() {
1590  return $this->useGTIDs;
1591  }
1592 }
1593 
1597 class_alias( DatabaseMysqlBase::class, 'DatabaseMysqlBase' );
wasLockTimeout()
Determines if the last failure was due to a lock timeout.
normalizeConditions( $conds, $fname)
Definition: Database.php:1957
clearFlag( $flag, $remember=self::REMEMBER_NOTHING)
Clear a flag for this connection.
Definition: Database.php:738
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction $rows
Definition: hooks.txt:2633
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition: hooks.txt:1585
addIdentifierQuotes( $s)
MySQL uses backticks for identifier quoting instead of the sql standard "double quotes".
bool $utf8Mode
Use experimental UTF-8 transmission encoding.
$success
array $lagDetectionOptions
Method to detect replica DB lag.
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:187
lastErrno()
Get the last error number.
wasDeadlock()
Determines if the last failure was due to a deadlock.
escapeLikeInternal( $s, $escapeChar='`')
Definition: Database.php:2715
selectDomain( $domain)
Set the current domain (database, schema, and table prefix)
Definition: Database.php:2337
mysqlError( $conn=null)
Returns the text of the error message from previous MySQL operation.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Result wrapper for grabbing data queried from an IDatabase object.
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2159
executeQuery( $sql, $fname, $flags)
Execute a query, retrying it if there is a recoverable connection loss.
Definition: Database.php:1167
getServer()
Get the server hostname or IP address.
Definition: Database.php:2349
mysqlFieldName( $res, $n)
Get the name of the specified field in a result.
addQuotes( $s)
Adds quotes and backslashes.
selectField( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[])
A SELECT wrapper which returns a single field from a single result row.
Definition: Database.php:1572
This code would result in ircNotify being run twice when an article is and once for brion Hooks can return three possible true was required This is the default since MediaWiki *some string
Definition: hooks.txt:175
$value
masterPosWait(DBMasterPos $pos, $timeout)
Wait for the replica DB to catch up to a given master position.
nativeReplace( $table, $rows, $fname)
REPLACE query wrapper for MySQL and SQLite, which have a native REPLACE statement.
Definition: Database.php:2849
static getCommonDomainGTIDs(MySQLMasterPos $pos, MySQLMasterPos $refPos)
query( $sql, $fname=__METHOD__, $flags=0)
Run an SQL query and return the result.
Definition: Database.php:1130
string $server
Server that this instance is currently connected to.
Definition: Database.php:50
getLBInfo( $name=null)
Get properties passed down from the server info array of the load balancer.
Definition: Database.php:569
see documentation in includes Linker php for Linker::makeImageLink & $time
Definition: hooks.txt:1799
getReplicaPos()
Get the position of the master from SHOW SLAVE STATUS.
mysqlDataSeek( $res, $row)
Move internal result pointer.
open( $server, $user, $password, $dbName, $schema, $tablePrefix)
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1980
getMysqlStatus( $which="%")
Get status information from SHOW STATUS in an associative array.
close()
Close the database connection.
Definition: Database.php:865
getServerUptime()
Determines how long the server has been up.
installErrorHandler()
Set a custom error handler for logging errors during database connection.
Definition: Database.php:803
bool $useGTIDs
bool Whether to use GTID methods
getDBname()
Get the current DB name.
Definition: Database.php:2345
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action, or null $user:User who performed the tagging when the tagging is subsequent to the action, or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition: hooks.txt:1263
mysqlFieldType( $res, $n)
Get the type of the specified field in a result.
This program is free software; you can redistribute it and/or modify it under the terms of the GNU Ge...
mysqlFetchObject( $res)
Fetch a result row as an object.
mysqlFetchField( $res, $n)
Get column information from a result.
duplicateTableStructure( $oldName, $newName, $temporary=false, $fname=__METHOD__)
mysqlFetchArray( $res)
Fetch a result row as an associative and numeric array.
const LIST_AND
Definition: Defines.php:39
reportQueryError( $error, $errno, $sql, $fname, $ignore=false)
Report a query error.
Definition: Database.php:1527
An object representing a master or replica DB position in a replicated setup.
Definition: DBMasterPos.php:12
unlock( $lockName, $method)
FROM MYSQL DOCS: https://dev.mysql.com/doc/refman/5.0/en/miscellaneous-functions.html#function_releas...
indexName( $index)
Allows for index remapping in queries where this is not consistent across DBMS.
Definition: Database.php:2672
$res
Definition: database.txt:21
fieldType( $res, $n)
mysql_field_type() wrapper
getMasterPos()
Get the position of the master from SHOW MASTER STATUS.
tableName( $name, $format='quoted')
Format a table name ready for use in constructing an SQL query.
Definition: Database.php:2353
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such and we might be restricted by PHP settings such as safe mode or open_basedir We cannot assume that the software even has read access anywhere useful Many shared hosts run all users web applications under the same user
Wikitext formatted, in the key only.
Definition: distributors.txt:9
doQuery( $sql)
Run a query and return a DBMS-dependent wrapper or boolean.
$cache
Definition: mcc.php:33
$params
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped & $options
Definition: hooks.txt:1982
tableExists( $table, $fname=__METHOD__)
Query whether a given table exists.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
lockIsFree( $lockName, $method)
Check to see if a named lock is available.
dropTable( $tableName, $fName=__METHOD__)
mysqlNumRows( $res)
Get number of rows in result.
upsert( $table, array $rows, $uniqueIndexes, array $set, $fname=__METHOD__)
INSERT ON DUPLICATE KEY UPDATE wrapper, upserts an array into a table.
restoreFlags( $state=self::RESTORE_PRIOR)
Restore the flags to their prior state before the last setFlag/clearFlag call.
Definition: Database.php:749
doLockTables(array $read, array $write, $method)
makeList( $a, $mode=self::LIST_COMMA)
Makes an encoded list of strings from an array.
Definition: Database.php:2143
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
qualifiedTableComponents( $name)
Get the table components needed for a query given the currently selected database.
Definition: Database.php:2411
getRecordedTransactionLagStatus()
Get the replica DB lag when the current transaction started.
Definition: Database.php:4192
if(defined( 'MW_SETUP_CALLBACK')) $fname
Customization point after all loading (constants, functions, classes, DefaultSettings, LocalSettings).
Definition: Setup.php:123
const LIST_SET
Definition: Defines.php:40
listViews( $prefix=null, $fname=__METHOD__)
Lists VIEWs in the database.
const DBO_TRX
Definition: defines.php:12
wasReadOnlyError()
Determines if the last failure was due to the database being read-only.
replace( $table, $uniqueIndexes, $rows, $fname=__METHOD__)
REPLACE query wrapper.
BagOStuff $srvCache
APC cache.
Definition: Database.php:81
lock( $lockName, $method, $timeout=5)
tableLocksHaveTransactionScope()
Checks if table locks acquired by lockTables() are transaction-bound in their scope.
DBMasterPos class for MySQL/MariaDB.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
Class to handle database/prefix specification for IDatabase domains.
isView( $name, $prefix=null)
Differentiates between a TABLE and a VIEW.
connectInitCharset()
Set the character set information right after connection.
getLogContext(array $extras=[])
Create a log context to pass to PSR-3 logger functions.
Definition: Database.php:854
selectRow( $table, $vars, $conds, $fname=__METHOD__, $options=[], $join_conds=[])
Single row SELECT wrapper.
Definition: Database.php:1845
indexInfo( $table, $index, $fname=__METHOD__)
Get information about an index into an object Returns false if the index does not exist...
__construct(array $params)
Additional $params include:
namedLocksEnqueue()
Check to see if a named lock used by lock() use blocking queues.
mysqlSetCharset( $charset)
Set the character set of the MySQL link.
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:52
Relational database abstraction object.
Definition: Database.php:48
select( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
Execute a SELECT query constructed using the various parameters provided.
Definition: Database.php:1754
mysqlNumFields( $res)
Get number of fields in result.
restoreErrorHandler()
Restore the previous error handler and return the last PHP error for this DB.
Definition: Database.php:814
string $sqlMode
sql_mode value to send on connection
object resource null $conn
Database connection.
Definition: Database.php:100
isInsertSelectSafe(array $insertOptions, array $selectOptions)
string $user
User that this instance is currently connected under the name of.
Definition: Database.php:52
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such and we might be restricted by PHP settings such as safe mode or open_basedir We cannot assume that the software even has read access anywhere useful Many shared hosts run all users web applications under the same so they can t rely on Unix and must forbid reads to even standard directories like tmp lest users read each others files We cannot assume that the user has the ability to install or run any programs not written as web accessible PHP scripts Since anything that works on cheap shared hosting will work if you have shell or root access MediaWiki s design is based around catering to the lowest common denominator Although we support higher end setups as the way many things work by default is tailored toward shared hosting These defaults are unconventional from the point of view of and they certainly aren t ideal for someone who s installing MediaWiki as MediaWiki does not conform to normal Unix filesystem layout Hopefully we ll offer direct support for standard layouts in the but for now *any change to the location of files is unsupported *Moving things and leaving symlinks will *probably *not break but it is *strongly *advised not to try any more intrusive changes to get MediaWiki to conform more closely to your filesystem hierarchy Any such attempt will almost certainly result in unnecessary bugs The standard recommended location to install relative to the web is it should be possible to enable the appropriate rewrite rules by if you can reconfigure the web server
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
estimateRowCount( $table, $var=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
Estimate rows in dataset Returns estimated count, based on EXPLAIN output Takes same arguments as Dat...
string $lagDetectionMethod
Method to detect replica DB lag.
mysqlConnect( $realServer, $dbName)
Open a connection to a MySQL server.
doSelectDomain(DatabaseDomain $domain)
mysqlFreeResult( $res)
Free result memory.
static configuration should be added through ResourceLoaderGetConfigVars instead & $vars
Definition: hooks.txt:2217
Database abstraction object for MySQL.
listTables( $prefix=null, $fname=__METHOD__)
List all tables on the database.
Database error base class.
Definition: DBError.php:30
string $password
Password used to establish the current connection.
Definition: Database.php:54
Base class for the more common types of database errors.
getServerRoleStatus( $role, $fname=__METHOD__)
deleteJoin( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname=__METHOD__)
DELETE where the condition is a join.