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  public 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  $this->close();
126 
127  if ( $schema !== null ) {
128  throw $this->newExceptionAfterConnectError( "Got schema '$schema'; not supported." );
129  }
130 
131  $this->server = $server;
132  $this->user = $user;
133  $this->password = $password;
134 
135  $this->installErrorHandler();
136  try {
137  $this->conn = $this->mysqlConnect( $this->server, $dbName );
138  } catch ( Exception $e ) {
139  $this->restoreErrorHandler();
140  throw $this->newExceptionAfterConnectError( $e->getMessage() );
141  }
142  $error = $this->restoreErrorHandler();
143 
144  if ( !$this->conn ) {
145  throw $this->newExceptionAfterConnectError( $error ?: $this->lastError() );
146  }
147 
148  try {
149  $this->currentDomain = new DatabaseDomain(
150  strlen( $dbName ) ? $dbName : null,
151  null,
152  $tablePrefix
153  );
154  // Abstract over any insane MySQL defaults
155  $set = [ 'group_concat_max_len = 262144' ];
156  // Set SQL mode, default is turning them all off, can be overridden or skipped with null
157  if ( is_string( $this->sqlMode ) ) {
158  $set[] = 'sql_mode = ' . $this->addQuotes( $this->sqlMode );
159  }
160  // Set any custom settings defined by site config
161  // (e.g. https://dev.mysql.com/doc/refman/4.1/en/innodb-parameters.html)
162  foreach ( $this->connectionVariables as $var => $val ) {
163  // Escape strings but not numbers to avoid MySQL complaining
164  if ( !is_int( $val ) && !is_float( $val ) ) {
165  $val = $this->addQuotes( $val );
166  }
167  $set[] = $this->addIdentifierQuotes( $var ) . ' = ' . $val;
168  }
169 
170  if ( $set ) {
171  $this->query(
172  'SET ' . implode( ', ', $set ),
173  __METHOD__,
174  self::QUERY_IGNORE_DBO_TRX | self::QUERY_NO_RETRY
175  );
176  }
177  } catch ( Exception $e ) {
178  throw $this->newExceptionAfterConnectError( $e->getMessage() );
179  }
180  }
181 
182  protected function doSelectDomain( DatabaseDomain $domain ) {
183  if ( $domain->getSchema() !== null ) {
184  throw new DBExpectedError(
185  $this,
186  __CLASS__ . ": domain '{$domain->getId()}' has a schema component"
187  );
188  }
189 
190  $database = $domain->getDatabase();
191  // A null database means "don't care" so leave it as is and update the table prefix
192  if ( $database === null ) {
193  $this->currentDomain = new DatabaseDomain(
194  $this->currentDomain->getDatabase(),
195  null,
196  $domain->getTablePrefix()
197  );
198 
199  return true;
200  }
201 
202  if ( $database !== $this->getDBname() ) {
203  $sql = 'USE ' . $this->addIdentifierQuotes( $database );
204  list( $res, $err, $errno ) =
205  $this->executeQuery( $sql, __METHOD__, self::QUERY_IGNORE_DBO_TRX );
206 
207  if ( $res === false ) {
208  $this->reportQueryError( $err, $errno, $sql, __METHOD__ );
209  return false; // unreachable
210  }
211  }
212 
213  // Update that domain fields on success (no exception thrown)
214  $this->currentDomain = $domain;
215 
216  return true;
217  }
218 
227  abstract protected function mysqlConnect( $realServer, $dbName );
228 
233  public function freeResult( $res ) {
234  AtEase::suppressWarnings();
235  $ok = $this->mysqlFreeResult( ResultWrapper::unwrap( $res ) );
236  AtEase::restoreWarnings();
237  if ( !$ok ) {
238  throw new DBUnexpectedError( $this, "Unable to free MySQL result" );
239  }
240  }
241 
248  abstract protected function mysqlFreeResult( $res );
249 
255  public function fetchObject( $res ) {
256  AtEase::suppressWarnings();
257  $row = $this->mysqlFetchObject( ResultWrapper::unwrap( $res ) );
258  AtEase::restoreWarnings();
259 
260  $errno = $this->lastErrno();
261  // Unfortunately, mysql_fetch_object does not reset the last errno.
262  // Only check for CR_SERVER_LOST and CR_UNKNOWN_ERROR, as
263  // these are the only errors mysql_fetch_object can cause.
264  // See https://dev.mysql.com/doc/refman/5.0/en/mysql-fetch-row.html.
265  if ( $errno == 2000 || $errno == 2013 ) {
266  throw new DBUnexpectedError(
267  $this,
268  'Error in fetchObject(): ' . htmlspecialchars( $this->lastError() )
269  );
270  }
271 
272  return $row;
273  }
274 
281  abstract protected function mysqlFetchObject( $res );
282 
288  public function fetchRow( $res ) {
289  AtEase::suppressWarnings();
290  $row = $this->mysqlFetchArray( ResultWrapper::unwrap( $res ) );
291  AtEase::restoreWarnings();
292 
293  $errno = $this->lastErrno();
294  // Unfortunately, mysql_fetch_array does not reset the last errno.
295  // Only check for CR_SERVER_LOST and CR_UNKNOWN_ERROR, as
296  // these are the only errors mysql_fetch_array can cause.
297  // See https://dev.mysql.com/doc/refman/5.0/en/mysql-fetch-row.html.
298  if ( $errno == 2000 || $errno == 2013 ) {
299  throw new DBUnexpectedError(
300  $this,
301  'Error in fetchRow(): ' . htmlspecialchars( $this->lastError() )
302  );
303  }
304 
305  return $row;
306  }
307 
314  abstract protected function mysqlFetchArray( $res );
315 
321  function numRows( $res ) {
322  if ( is_bool( $res ) ) {
323  $n = 0;
324  } else {
325  AtEase::suppressWarnings();
326  $n = $this->mysqlNumRows( ResultWrapper::unwrap( $res ) );
327  AtEase::restoreWarnings();
328  }
329 
330  // Unfortunately, mysql_num_rows does not reset the last errno.
331  // We are not checking for any errors here, since
332  // there are no errors mysql_num_rows can cause.
333  // See https://dev.mysql.com/doc/refman/5.0/en/mysql-fetch-row.html.
334  // See https://phabricator.wikimedia.org/T44430
335  return $n;
336  }
337 
344  abstract protected function mysqlNumRows( $res );
345 
350  public function numFields( $res ) {
351  return $this->mysqlNumFields( ResultWrapper::unwrap( $res ) );
352  }
353 
360  abstract protected function mysqlNumFields( $res );
361 
367  public function fieldName( $res, $n ) {
368  return $this->mysqlFieldName( ResultWrapper::unwrap( $res ), $n );
369  }
370 
378  abstract protected function mysqlFieldName( $res, $n );
379 
386  public function fieldType( $res, $n ) {
387  return $this->mysqlFieldType( ResultWrapper::unwrap( $res ), $n );
388  }
389 
397  abstract protected function mysqlFieldType( $res, $n );
398 
404  public function dataSeek( $res, $row ) {
405  return $this->mysqlDataSeek( ResultWrapper::unwrap( $res ), $row );
406  }
407 
415  abstract protected function mysqlDataSeek( $res, $row );
416 
420  public function lastError() {
421  if ( $this->conn ) {
422  # Even if it's non-zero, it can still be invalid
423  AtEase::suppressWarnings();
424  $error = $this->mysqlError( $this->conn );
425  if ( !$error ) {
426  $error = $this->mysqlError();
427  }
428  AtEase::restoreWarnings();
429  } else {
430  $error = $this->mysqlError();
431  }
432  if ( $error ) {
433  $error .= ' (' . $this->server . ')';
434  }
435 
436  return $error;
437  }
438 
445  abstract protected function mysqlError( $conn = null );
446 
447  protected function wasQueryTimeout( $error, $errno ) {
448  // https://dev.mysql.com/doc/refman/8.0/en/client-error-reference.html
449  // https://phabricator.wikimedia.org/T170638
450  return in_array( $errno, [ 2062, 3024 ] );
451  }
452 
453  public function replace( $table, $uniqueIndexes, $rows, $fname = __METHOD__ ) {
454  $this->nativeReplace( $table, $rows, $fname );
455  }
456 
457  protected function isInsertSelectSafe( array $insertOptions, array $selectOptions ) {
458  $row = $this->getReplicationSafetyInfo();
459  // For row-based-replication, the resulting changes will be relayed, not the query
460  if ( $row->binlog_format === 'ROW' ) {
461  return true;
462  }
463  // LIMIT requires ORDER BY on a unique key or it is non-deterministic
464  if ( isset( $selectOptions['LIMIT'] ) ) {
465  return false;
466  }
467  // In MySQL, an INSERT SELECT is only replication safe with row-based
468  // replication or if innodb_autoinc_lock_mode is 0. When those
469  // conditions aren't met, use non-native mode.
470  // While we could try to determine if the insert is safe anyway by
471  // checking if the target table has an auto-increment column that
472  // isn't set in $varMap, that seems unlikely to be worth the extra
473  // complexity.
474  return (
475  in_array( 'NO_AUTO_COLUMNS', $insertOptions ) ||
476  (int)$row->innodb_autoinc_lock_mode === 0
477  );
478  }
479 
483  protected function getReplicationSafetyInfo() {
484  if ( $this->replicationInfoRow === null ) {
485  $this->replicationInfoRow = $this->selectRow(
486  false,
487  [
488  'innodb_autoinc_lock_mode' => '@@innodb_autoinc_lock_mode',
489  'binlog_format' => '@@binlog_format',
490  ],
491  [],
492  __METHOD__
493  );
494  }
495 
497  }
498 
512  public function estimateRowCount( $table, $var = '*', $conds = '',
513  $fname = __METHOD__, $options = [], $join_conds = []
514  ) {
515  $conds = $this->normalizeConditions( $conds, $fname );
516  $column = $this->extractSingleFieldFromList( $var );
517  if ( is_string( $column ) && !in_array( $column, [ '*', '1' ] ) ) {
518  $conds[] = "$column IS NOT NULL";
519  }
520 
521  $options['EXPLAIN'] = true;
522  $res = $this->select( $table, $var, $conds, $fname, $options, $join_conds );
523  if ( $res === false ) {
524  return false;
525  }
526  if ( !$this->numRows( $res ) ) {
527  return 0;
528  }
529 
530  $rows = 1;
531  foreach ( $res as $plan ) {
532  $rows *= $plan->rows > 0 ? $plan->rows : 1; // avoid resetting to zero
533  }
534 
535  return (int)$rows;
536  }
537 
538  public function tableExists( $table, $fname = __METHOD__ ) {
539  // Split database and table into proper variables as Database::tableName() returns
540  // shared tables prefixed with their database, which do not work in SHOW TABLES statements
541  list( $database, , $prefix, $table ) = $this->qualifiedTableComponents( $table );
542  $tableName = "{$prefix}{$table}";
543 
544  if ( isset( $this->sessionTempTables[$tableName] ) ) {
545  return true; // already known to exist and won't show in SHOW TABLES anyway
546  }
547 
548  // We can't use buildLike() here, because it specifies an escape character
549  // other than the backslash, which is the only one supported by SHOW TABLES
550  $encLike = $this->escapeLikeInternal( $tableName, '\\' );
551 
552  // If the database has been specified (such as for shared tables), use "FROM"
553  if ( $database !== '' ) {
554  $encDatabase = $this->addIdentifierQuotes( $database );
555  $query = "SHOW TABLES FROM $encDatabase LIKE '$encLike'";
556  } else {
557  $query = "SHOW TABLES LIKE '$encLike'";
558  }
559 
560  return $this->query( $query, $fname )->numRows() > 0;
561  }
562 
568  public function fieldInfo( $table, $field ) {
569  $table = $this->tableName( $table );
570  $flags = self::QUERY_SILENCE_ERRORS;
571  $res = $this->query( "SELECT * FROM $table LIMIT 1", __METHOD__, $flags );
572  if ( !$res ) {
573  return false;
574  }
575  $n = $this->mysqlNumFields( ResultWrapper::unwrap( $res ) );
576  for ( $i = 0; $i < $n; $i++ ) {
577  $meta = $this->mysqlFetchField( ResultWrapper::unwrap( $res ), $i );
578  if ( $field == $meta->name ) {
579  return new MySQLField( $meta );
580  }
581  }
582 
583  return false;
584  }
585 
593  abstract protected function mysqlFetchField( $res, $n );
594 
604  public function indexInfo( $table, $index, $fname = __METHOD__ ) {
605  # SHOW INDEX works in MySQL 3.23.58, but SHOW INDEXES does not.
606  # SHOW INDEX should work for 3.x and up:
607  # https://dev.mysql.com/doc/mysql/en/SHOW_INDEX.html
608  $table = $this->tableName( $table );
609  $index = $this->indexName( $index );
610 
611  $sql = 'SHOW INDEX FROM ' . $table;
612  $res = $this->query( $sql, $fname );
613 
614  if ( !$res ) {
615  return null;
616  }
617 
618  $result = [];
619 
620  foreach ( $res as $row ) {
621  if ( $row->Key_name == $index ) {
622  $result[] = $row;
623  }
624  }
625 
626  return $result ?: false;
627  }
628 
633  public function strencode( $s ) {
634  return $this->mysqlRealEscapeString( $s );
635  }
636 
641  abstract protected function mysqlRealEscapeString( $s );
642 
643  public function addQuotes( $s ) {
644  if ( is_bool( $s ) ) {
645  // Parent would transform to int, which does not play nice with MySQL type juggling.
646  // When searching for an int in a string column, the strings are cast to int, which
647  // means false would match any string not starting with a number.
648  $s = (string)(int)$s;
649  }
650  return parent::addQuotes( $s );
651  }
652 
659  public function addIdentifierQuotes( $s ) {
660  // Characters in the range \u0001-\uFFFF are valid in a quoted identifier
661  // Remove NUL bytes and escape backticks by doubling
662  return '`' . str_replace( [ "\0", '`' ], [ '', '``' ], $s ) . '`';
663  }
664 
669  public function isQuotedIdentifier( $name ) {
670  return strlen( $name ) && $name[0] == '`' && substr( $name, -1, 1 ) == '`';
671  }
672 
673  protected function doGetLag() {
674  if ( $this->getLagDetectionMethod() === 'pt-heartbeat' ) {
675  return $this->getLagFromPtHeartbeat();
676  } else {
677  return $this->getLagFromSlaveStatus();
678  }
679  }
680 
684  protected function getLagDetectionMethod() {
686  }
687 
691  protected function getLagFromSlaveStatus() {
692  $flags = self::QUERY_SILENCE_ERRORS | self::QUERY_IGNORE_DBO_TRX;
693  $res = $this->query( 'SHOW SLAVE STATUS', __METHOD__, $flags );
694  $row = $res ? $res->fetchObject() : false;
695  // If the server is not replicating, there will be no row
696  if ( $row && strval( $row->Seconds_Behind_Master ) !== '' ) {
697  return intval( $row->Seconds_Behind_Master );
698  }
699 
700  return false;
701  }
702 
706  protected function getLagFromPtHeartbeat() {
708 
709  $currentTrxInfo = $this->getRecordedTransactionLagStatus();
710  if ( $currentTrxInfo ) {
711  // There is an active transaction and the initial lag was already queried
712  $staleness = microtime( true ) - $currentTrxInfo['since'];
713  if ( $staleness > self::LAG_STALE_WARN_THRESHOLD ) {
714  // Avoid returning higher and higher lag value due to snapshot age
715  // given that the isolation level will typically be REPEATABLE-READ
716  $this->queryLogger->warning(
717  "Using cached lag value for {db_server} due to active transaction",
718  $this->getLogContext( [
719  'method' => __METHOD__,
720  'age' => $staleness,
721  'trace' => ( new RuntimeException() )->getTraceAsString()
722  ] )
723  );
724  }
725 
726  return $currentTrxInfo['lag'];
727  }
728 
729  if ( isset( $options['conds'] ) ) {
730  // Best method for multi-DC setups: use logical channel names
731  $data = $this->getHeartbeatData( $options['conds'] );
732  } else {
733  // Standard method: use master server ID (works with stock pt-heartbeat)
734  $masterInfo = $this->getMasterServerInfo();
735  if ( !$masterInfo ) {
736  $this->queryLogger->error(
737  "Unable to query master of {db_server} for server ID",
738  $this->getLogContext( [
739  'method' => __METHOD__
740  ] )
741  );
742 
743  return false; // could not get master server ID
744  }
745 
746  $conds = [ 'server_id' => intval( $masterInfo['serverId'] ) ];
747  $data = $this->getHeartbeatData( $conds );
748  }
749 
750  list( $time, $nowUnix ) = $data;
751  if ( $time !== null ) {
752  // @time is in ISO format like "2015-09-25T16:48:10.000510"
753  $dateTime = new DateTime( $time, new DateTimeZone( 'UTC' ) );
754  $timeUnix = (int)$dateTime->format( 'U' ) + $dateTime->format( 'u' ) / 1e6;
755 
756  return max( $nowUnix - $timeUnix, 0.0 );
757  }
758 
759  $this->queryLogger->error(
760  "Unable to find pt-heartbeat row for {db_server}",
761  $this->getLogContext( [
762  'method' => __METHOD__
763  ] )
764  );
765 
766  return false;
767  }
768 
769  protected function getMasterServerInfo() {
771  $key = $cache->makeGlobalKey(
772  'mysql',
773  'master-info',
774  // Using one key for all cluster replica DBs is preferable
775  $this->getLBInfo( 'clusterMasterHost' ) ?: $this->getServer()
776  );
777  $fname = __METHOD__;
778 
779  return $cache->getWithSetCallback(
780  $key,
781  $cache::TTL_INDEFINITE,
782  function () use ( $cache, $key, $fname ) {
783  // Get and leave a lock key in place for a short period
784  if ( !$cache->lock( $key, 0, 10 ) ) {
785  return false; // avoid master connection spike slams
786  }
787 
788  $conn = $this->getLazyMasterHandle();
789  if ( !$conn ) {
790  return false; // something is misconfigured
791  }
792 
793  // Connect to and query the master; catch errors to avoid outages
794  try {
795  $flags = self::QUERY_SILENCE_ERRORS | self::QUERY_IGNORE_DBO_TRX;
796  $res = $conn->query( 'SELECT @@server_id AS id', $fname, $flags );
797  $row = $res ? $res->fetchObject() : false;
798  $id = $row ? (int)$row->id : 0;
799  } catch ( DBError $e ) {
800  $id = 0;
801  }
802 
803  // Cache the ID if it was retrieved
804  return $id ? [ 'serverId' => $id, 'asOf' => time() ] : false;
805  }
806  );
807  }
808 
814  protected function getHeartbeatData( array $conds ) {
815  // Query time and trip time are not counted
816  $nowUnix = microtime( true );
817  // Do not bother starting implicit transactions here
818  $this->clearFlag( self::DBO_TRX, self::REMEMBER_PRIOR );
819  try {
820  $whereSQL = $this->makeList( $conds, self::LIST_AND );
821  // Use ORDER BY for channel based queries since that field might not be UNIQUE.
822  // Note: this would use "TIMESTAMPDIFF(MICROSECOND,ts,UTC_TIMESTAMP(6))" but the
823  // percision field is not supported in MySQL <= 5.5.
824  $res = $this->query(
825  "SELECT ts FROM heartbeat.heartbeat WHERE $whereSQL ORDER BY ts DESC LIMIT 1",
826  __METHOD__,
827  self::QUERY_SILENCE_ERRORS | self::QUERY_IGNORE_DBO_TRX
828  );
829  $row = $res ? $res->fetchObject() : false;
830  } finally {
831  $this->restoreFlags();
832  }
833 
834  return [ $row ? $row->ts : null, $nowUnix ];
835  }
836 
837  protected function getApproximateLagStatus() {
838  if ( $this->getLagDetectionMethod() === 'pt-heartbeat' ) {
839  // Disable caching since this is fast enough and we don't wan't
840  // to be *too* pessimistic by having both the cache TTL and the
841  // pt-heartbeat interval count as lag in getSessionLagStatus()
842  return parent::getApproximateLagStatus();
843  }
844 
845  $key = $this->srvCache->makeGlobalKey( 'mysql-lag', $this->getServer() );
846  $approxLag = $this->srvCache->get( $key );
847  if ( !$approxLag ) {
848  $approxLag = parent::getApproximateLagStatus();
849  $this->srvCache->set( $key, $approxLag, 1 );
850  }
851 
852  return $approxLag;
853  }
854 
855  public function masterPosWait( DBMasterPos $pos, $timeout ) {
856  if ( !( $pos instanceof MySQLMasterPos ) ) {
857  throw new InvalidArgumentException( "Position not an instance of MySQLMasterPos" );
858  }
859 
860  if ( $this->getLBInfo( 'is static' ) === true ) {
861  return 0; // this is a copy of a read-only dataset with no master DB
862  } elseif ( $this->lastKnownReplicaPos && $this->lastKnownReplicaPos->hasReached( $pos ) ) {
863  return 0; // already reached this point for sure
864  }
865 
866  // Call doQuery() directly, to avoid opening a transaction if DBO_TRX is set
867  if ( $pos->getGTIDs() ) {
868  // Ignore GTIDs from domains exclusive to the master DB (presumably inactive)
869  $rpos = $this->getReplicaPos();
870  $gtidsWait = $rpos ? MySQLMasterPos::getCommonDomainGTIDs( $pos, $rpos ) : [];
871  if ( !$gtidsWait ) {
872  $this->queryLogger->error(
873  "No GTIDs with the same domain between master ($pos) and replica ($rpos)",
874  $this->getLogContext( [
875  'method' => __METHOD__,
876  ] )
877  );
878 
879  return -1; // $pos is from the wrong cluster?
880  }
881  // Wait on the GTID set (MariaDB only)
882  $gtidArg = $this->addQuotes( implode( ',', $gtidsWait ) );
883  if ( strpos( $gtidArg, ':' ) !== false ) {
884  // MySQL GTIDs, e.g "source_id:transaction_id"
885  $sql = "SELECT WAIT_FOR_EXECUTED_GTID_SET($gtidArg, $timeout)";
886  } else {
887  // MariaDB GTIDs, e.g."domain:server:sequence"
888  $sql = "SELECT MASTER_GTID_WAIT($gtidArg, $timeout)";
889  }
890  } else {
891  // Wait on the binlog coordinates
892  $encFile = $this->addQuotes( $pos->getLogFile() );
893  $encPos = intval( $pos->getLogPosition()[$pos::CORD_EVENT] );
894  $sql = "SELECT MASTER_POS_WAIT($encFile, $encPos, $timeout)";
895  }
896 
897  list( $res, $err ) = $this->executeQuery( $sql, __METHOD__, self::QUERY_IGNORE_DBO_TRX );
898  $row = $res ? $this->fetchRow( $res ) : false;
899  if ( !$row ) {
900  throw new DBExpectedError( $this, "Replication wait failed: {$err}" );
901  }
902 
903  // Result can be NULL (error), -1 (timeout), or 0+ per the MySQL manual
904  $status = ( $row[0] !== null ) ? intval( $row[0] ) : null;
905  if ( $status === null ) {
906  if ( !$pos->getGTIDs() ) {
907  // T126436: jobs programmed to wait on master positions might be referencing
908  // binlogs with an old master hostname; this makes MASTER_POS_WAIT() return null.
909  // Try to detect this case and treat the replica DB as having reached the given
910  // position (any master switchover already requires that the new master be caught
911  // up before the switch).
912  $replicationPos = $this->getReplicaPos();
913  if ( $replicationPos && !$replicationPos->channelsMatch( $pos ) ) {
914  $this->lastKnownReplicaPos = $replicationPos;
915  $status = 0;
916  }
917  }
918  } elseif ( $status >= 0 ) {
919  // Remember that this position was reached to save queries next time
920  $this->lastKnownReplicaPos = $pos;
921  }
922 
923  return $status;
924  }
925 
931  public function getReplicaPos() {
932  $now = microtime( true ); // as-of-time *before* fetching GTID variables
933 
934  if ( $this->useGTIDs() ) {
935  // Try to use GTIDs, fallbacking to binlog positions if not possible
936  $data = $this->getServerGTIDs( __METHOD__ );
937  // Use gtid_slave_pos for MariaDB and gtid_executed for MySQL
938  foreach ( [ 'gtid_slave_pos', 'gtid_executed' ] as $name ) {
939  if ( isset( $data[$name] ) && strlen( $data[$name] ) ) {
940  return new MySQLMasterPos( $data[$name], $now );
941  }
942  }
943  }
944 
945  $data = $this->getServerRoleStatus( 'SLAVE', __METHOD__ );
946  if ( $data && strlen( $data['Relay_Master_Log_File'] ) ) {
947  return new MySQLMasterPos(
948  "{$data['Relay_Master_Log_File']}/{$data['Exec_Master_Log_Pos']}",
949  $now
950  );
951  }
952 
953  return false;
954  }
955 
961  public function getMasterPos() {
962  $now = microtime( true ); // as-of-time *before* fetching GTID variables
963 
964  $pos = false;
965  if ( $this->useGTIDs() ) {
966  // Try to use GTIDs, fallbacking to binlog positions if not possible
967  $data = $this->getServerGTIDs( __METHOD__ );
968  // Use gtid_binlog_pos for MariaDB and gtid_executed for MySQL
969  foreach ( [ 'gtid_binlog_pos', 'gtid_executed' ] as $name ) {
970  if ( isset( $data[$name] ) && strlen( $data[$name] ) ) {
971  $pos = new MySQLMasterPos( $data[$name], $now );
972  break;
973  }
974  }
975  // Filter domains that are inactive or not relevant to the session
976  if ( $pos ) {
977  $pos->setActiveOriginServerId( $this->getServerId() );
978  $pos->setActiveOriginServerUUID( $this->getServerUUID() );
979  if ( isset( $data['gtid_domain_id'] ) ) {
980  $pos->setActiveDomain( $data['gtid_domain_id'] );
981  }
982  }
983  }
984 
985  if ( !$pos ) {
986  $data = $this->getServerRoleStatus( 'MASTER', __METHOD__ );
987  if ( $data && strlen( $data['File'] ) ) {
988  $pos = new MySQLMasterPos( "{$data['File']}/{$data['Position']}", $now );
989  }
990  }
991 
992  return $pos;
993  }
994 
999  protected function getServerId() {
1000  $fname = __METHOD__;
1001  return $this->srvCache->getWithSetCallback(
1002  $this->srvCache->makeGlobalKey( 'mysql-server-id', $this->getServer() ),
1003  self::SERVER_ID_CACHE_TTL,
1004  function () use ( $fname ) {
1005  $flags = self::QUERY_IGNORE_DBO_TRX;
1006  $res = $this->query( "SELECT @@server_id AS id", $fname, $flags );
1007 
1008  return intval( $this->fetchObject( $res )->id );
1009  }
1010  );
1011  }
1012 
1016  protected function getServerUUID() {
1017  $fname = __METHOD__;
1018  return $this->srvCache->getWithSetCallback(
1019  $this->srvCache->makeGlobalKey( 'mysql-server-uuid', $this->getServer() ),
1020  self::SERVER_ID_CACHE_TTL,
1021  function () use ( $fname ) {
1022  $flags = self::QUERY_IGNORE_DBO_TRX;
1023  $res = $this->query( "SHOW GLOBAL VARIABLES LIKE 'server_uuid'", $fname, $flags );
1024  $row = $this->fetchObject( $res );
1025 
1026  return $row ? $row->Value : null;
1027  }
1028  );
1029  }
1030 
1035  protected function getServerGTIDs( $fname = __METHOD__ ) {
1036  $map = [];
1037 
1038  $flags = self::QUERY_IGNORE_DBO_TRX;
1039  // Get global-only variables like gtid_executed
1040  $res = $this->query( "SHOW GLOBAL VARIABLES LIKE 'gtid_%'", $fname, $flags );
1041  foreach ( $res as $row ) {
1042  $map[$row->Variable_name] = $row->Value;
1043  }
1044  // Get session-specific (e.g. gtid_domain_id since that is were writes will log)
1045  $res = $this->query( "SHOW SESSION VARIABLES LIKE 'gtid_%'", $fname, $flags );
1046  foreach ( $res as $row ) {
1047  $map[$row->Variable_name] = $row->Value;
1048  }
1049 
1050  return $map;
1051  }
1052 
1058  protected function getServerRoleStatus( $role, $fname = __METHOD__ ) {
1059  $flags = self::QUERY_IGNORE_DBO_TRX;
1060 
1061  return $this->query( "SHOW $role STATUS", $fname, $flags )->fetchRow() ?: [];
1062  }
1063 
1064  public function serverIsReadOnly() {
1065  $flags = self::QUERY_IGNORE_DBO_TRX;
1066  $res = $this->query( "SHOW GLOBAL VARIABLES LIKE 'read_only'", __METHOD__, $flags );
1067  $row = $this->fetchObject( $res );
1068 
1069  return $row ? ( strtolower( $row->Value ) === 'on' ) : false;
1070  }
1071 
1076  function useIndexClause( $index ) {
1077  return "FORCE INDEX (" . $this->indexName( $index ) . ")";
1078  }
1079 
1084  function ignoreIndexClause( $index ) {
1085  return "IGNORE INDEX (" . $this->indexName( $index ) . ")";
1086  }
1087 
1091  public function getSoftwareLink() {
1092  // MariaDB includes its name in its version string; this is how MariaDB's version of
1093  // the mysql command-line client identifies MariaDB servers (see mariadb_connection()
1094  // in libmysql/libmysql.c).
1095  $version = $this->getServerVersion();
1096  if ( strpos( $version, 'MariaDB' ) !== false || strpos( $version, '-maria-' ) !== false ) {
1097  return '[{{int:version-db-mariadb-url}} MariaDB]';
1098  }
1099 
1100  // Percona Server's version suffix is not very distinctive, and @@version_comment
1101  // doesn't give the necessary info for source builds, so assume the server is MySQL.
1102  // (Even Percona's version of mysql doesn't try to make the distinction.)
1103  return '[{{int:version-db-mysql-url}} MySQL]';
1104  }
1105 
1109  public function getServerVersion() {
1110  // Not using mysql_get_server_info() or similar for consistency: in the handshake,
1111  // MariaDB 10 adds the prefix "5.5.5-", and only some newer client libraries strip
1112  // it off (see RPL_VERSION_HACK in include/mysql_com.h).
1113  if ( $this->serverVersion === null ) {
1114  $this->serverVersion = $this->selectField( '', 'VERSION()', '', __METHOD__ );
1115  }
1116  return $this->serverVersion;
1117  }
1118 
1122  public function setSessionOptions( array $options ) {
1123  if ( isset( $options['connTimeout'] ) ) {
1124  $flags = self::QUERY_IGNORE_DBO_TRX;
1125  $timeout = (int)$options['connTimeout'];
1126  $this->query( "SET net_read_timeout=$timeout", __METHOD__, $flags );
1127  $this->query( "SET net_write_timeout=$timeout", __METHOD__, $flags );
1128  }
1129  }
1130 
1136  public function streamStatementEnd( &$sql, &$newLine ) {
1137  if ( strtoupper( substr( $newLine, 0, 9 ) ) == 'DELIMITER' ) {
1138  preg_match( '/^DELIMITER\s+(\S+)/', $newLine, $m );
1139  $this->delimiter = $m[1];
1140  $newLine = '';
1141  }
1142 
1143  return parent::streamStatementEnd( $sql, $newLine );
1144  }
1145 
1154  public function lockIsFree( $lockName, $method ) {
1155  if ( !parent::lockIsFree( $lockName, $method ) ) {
1156  return false; // already held
1157  }
1158 
1159  $encName = $this->addQuotes( $this->makeLockName( $lockName ) );
1160 
1161  $flags = self::QUERY_IGNORE_DBO_TRX;
1162  $res = $this->query( "SELECT IS_FREE_LOCK($encName) AS lockstatus", $method, $flags );
1163  $row = $this->fetchObject( $res );
1164 
1165  return ( $row->lockstatus == 1 );
1166  }
1167 
1174  public function lock( $lockName, $method, $timeout = 5 ) {
1175  $encName = $this->addQuotes( $this->makeLockName( $lockName ) );
1176 
1177  $flags = self::QUERY_IGNORE_DBO_TRX;
1178  $res = $this->query( "SELECT GET_LOCK($encName, $timeout) AS lockstatus", $method, $flags );
1179  $row = $this->fetchObject( $res );
1180 
1181  if ( $row->lockstatus == 1 ) {
1182  parent::lock( $lockName, $method, $timeout ); // record
1183  return true;
1184  }
1185 
1186  $this->queryLogger->info( __METHOD__ . " failed to acquire lock '{lockname}'",
1187  [ 'lockname' => $lockName ] );
1188 
1189  return false;
1190  }
1191 
1199  public function unlock( $lockName, $method ) {
1200  $encName = $this->addQuotes( $this->makeLockName( $lockName ) );
1201 
1202  $flags = self::QUERY_IGNORE_DBO_TRX;
1203  $res = $this->query( "SELECT RELEASE_LOCK($encName) as lockstatus", $method, $flags );
1204  $row = $this->fetchObject( $res );
1205 
1206  if ( $row->lockstatus == 1 ) {
1207  parent::unlock( $lockName, $method ); // record
1208  return true;
1209  }
1210 
1211  $this->queryLogger->warning( __METHOD__ . " failed to release lock '$lockName'\n" );
1212 
1213  return false;
1214  }
1215 
1216  private function makeLockName( $lockName ) {
1217  // https://dev.mysql.com/doc/refman/5.7/en/miscellaneous-functions.html#function_get-lock
1218  // Newer version enforce a 64 char length limit.
1219  return ( strlen( $lockName ) > 64 ) ? sha1( $lockName ) : $lockName;
1220  }
1221 
1222  public function namedLocksEnqueue() {
1223  return true;
1224  }
1225 
1227  return false; // tied to TCP connection
1228  }
1229 
1230  protected function doLockTables( array $read, array $write, $method ) {
1231  $items = [];
1232  foreach ( $write as $table ) {
1233  $items[] = $this->tableName( $table ) . ' WRITE';
1234  }
1235  foreach ( $read as $table ) {
1236  $items[] = $this->tableName( $table ) . ' READ';
1237  }
1238 
1239  $sql = "LOCK TABLES " . implode( ',', $items );
1240  $this->query( $sql, $method, self::QUERY_IGNORE_DBO_TRX );
1241 
1242  return true;
1243  }
1244 
1245  protected function doUnlockTables( $method ) {
1246  $this->query( "UNLOCK TABLES", $method, self::QUERY_IGNORE_DBO_TRX );
1247 
1248  return true;
1249  }
1250 
1254  public function setBigSelects( $value = true ) {
1255  if ( $value === 'default' ) {
1256  if ( $this->defaultBigSelects === null ) {
1257  # Function hasn't been called before so it must already be set to the default
1258  return;
1259  } else {
1261  }
1262  } elseif ( $this->defaultBigSelects === null ) {
1263  $this->defaultBigSelects =
1264  (bool)$this->selectField( false, '@@sql_big_selects', '', __METHOD__ );
1265  }
1266  $encValue = $value ? '1' : '0';
1267  $this->query( "SET sql_big_selects=$encValue", __METHOD__, self::QUERY_IGNORE_DBO_TRX );
1268  }
1269 
1280  public function deleteJoin(
1281  $delTable, $joinTable, $delVar, $joinVar, $conds, $fname = __METHOD__
1282  ) {
1283  if ( !$conds ) {
1284  throw new DBUnexpectedError( $this, __METHOD__ . ' called with empty $conds' );
1285  }
1286 
1287  $delTable = $this->tableName( $delTable );
1288  $joinTable = $this->tableName( $joinTable );
1289  $sql = "DELETE $delTable FROM $delTable, $joinTable WHERE $delVar=$joinVar ";
1290 
1291  if ( $conds != '*' ) {
1292  $sql .= ' AND ' . $this->makeList( $conds, self::LIST_AND );
1293  }
1294 
1295  $this->query( $sql, $fname );
1296  }
1297 
1298  public function upsert(
1299  $table, array $rows, $uniqueIndexes, array $set, $fname = __METHOD__
1300  ) {
1301  if ( $rows === [] ) {
1302  return true; // nothing to do
1303  }
1304 
1305  if ( !is_array( reset( $rows ) ) ) {
1306  $rows = [ $rows ];
1307  }
1308 
1309  $table = $this->tableName( $table );
1310  $columns = array_keys( $rows[0] );
1311 
1312  $sql = "INSERT INTO $table (" . implode( ',', $columns ) . ') VALUES ';
1313  $rowTuples = [];
1314  foreach ( $rows as $row ) {
1315  $rowTuples[] = '(' . $this->makeList( $row ) . ')';
1316  }
1317  $sql .= implode( ',', $rowTuples );
1318  $sql .= " ON DUPLICATE KEY UPDATE " . $this->makeList( $set, self::LIST_SET );
1319 
1320  $this->query( $sql, $fname );
1321 
1322  return true;
1323  }
1324 
1330  public function getServerUptime() {
1331  $vars = $this->getMysqlStatus( 'Uptime' );
1332 
1333  return (int)$vars['Uptime'];
1334  }
1335 
1341  public function wasDeadlock() {
1342  return $this->lastErrno() == 1213;
1343  }
1344 
1350  public function wasLockTimeout() {
1351  return $this->lastErrno() == 1205;
1352  }
1353 
1359  public function wasReadOnlyError() {
1360  return $this->lastErrno() == 1223 ||
1361  ( $this->lastErrno() == 1290 && strpos( $this->lastError(), '--read-only' ) !== false );
1362  }
1363 
1364  public function wasConnectionError( $errno ) {
1365  return $errno == 2013 || $errno == 2006;
1366  }
1367 
1368  protected function wasKnownStatementRollbackError() {
1369  $errno = $this->lastErrno();
1370 
1371  if ( $errno === 1205 ) { // lock wait timeout
1372  // Note that this is uncached to avoid stale values of SET is used
1373  $row = $this->selectRow(
1374  false,
1375  [ 'innodb_rollback_on_timeout' => '@@innodb_rollback_on_timeout' ],
1376  [],
1377  __METHOD__
1378  );
1379  // https://dev.mysql.com/doc/refman/5.7/en/innodb-error-handling.html
1380  // https://dev.mysql.com/doc/refman/5.5/en/innodb-parameters.html
1381  return $row->innodb_rollback_on_timeout ? false : true;
1382  }
1383 
1384  // See https://dev.mysql.com/doc/refman/5.5/en/error-messages-server.html
1385  return in_array( $errno, [ 1022, 1062, 1216, 1217, 1137, 1146, 1051, 1054 ], true );
1386  }
1387 
1395  public function duplicateTableStructure(
1396  $oldName, $newName, $temporary = false, $fname = __METHOD__
1397  ) {
1398  $tmp = $temporary ? 'TEMPORARY ' : '';
1399  $newName = $this->addIdentifierQuotes( $newName );
1400  $oldName = $this->addIdentifierQuotes( $oldName );
1401  $query = "CREATE $tmp TABLE $newName (LIKE $oldName)";
1402 
1403  return $this->query( $query, $fname, $this::QUERY_PSEUDO_PERMANENT );
1404  }
1405 
1413  public function listTables( $prefix = null, $fname = __METHOD__ ) {
1414  $result = $this->query( "SHOW TABLES", $fname );
1415 
1416  $endArray = [];
1417 
1418  foreach ( $result as $table ) {
1419  $vars = get_object_vars( $table );
1420  $table = array_pop( $vars );
1421 
1422  if ( !$prefix || strpos( $table, $prefix ) === 0 ) {
1423  $endArray[] = $table;
1424  }
1425  }
1426 
1427  return $endArray;
1428  }
1429 
1435  public function dropTable( $tableName, $fName = __METHOD__ ) {
1436  if ( !$this->tableExists( $tableName, $fName ) ) {
1437  return false;
1438  }
1439 
1440  return $this->query( "DROP TABLE IF EXISTS " . $this->tableName( $tableName ), $fName );
1441  }
1442 
1449  private function getMysqlStatus( $which = "%" ) {
1450  $flags = self::QUERY_IGNORE_DBO_TRX;
1451  $res = $this->query( "SHOW STATUS LIKE '{$which}'", __METHOD__, $flags );
1452  $status = [];
1453 
1454  foreach ( $res as $row ) {
1455  $status[$row->Variable_name] = $row->Value;
1456  }
1457 
1458  return $status;
1459  }
1460 
1470  public function listViews( $prefix = null, $fname = __METHOD__ ) {
1471  // The name of the column containing the name of the VIEW
1472  $propertyName = 'Tables_in_' . $this->getDBname();
1473 
1474  // Query for the VIEWS
1475  $res = $this->query( 'SHOW FULL TABLES WHERE TABLE_TYPE = "VIEW"' );
1476  $allViews = [];
1477  foreach ( $res as $row ) {
1478  array_push( $allViews, $row->$propertyName );
1479  }
1480 
1481  if ( is_null( $prefix ) || $prefix === '' ) {
1482  return $allViews;
1483  }
1484 
1485  $filteredViews = [];
1486  foreach ( $allViews as $viewName ) {
1487  // Does the name of this VIEW start with the table-prefix?
1488  if ( strpos( $viewName, $prefix ) === 0 ) {
1489  array_push( $filteredViews, $viewName );
1490  }
1491  }
1492 
1493  return $filteredViews;
1494  }
1495 
1504  public function isView( $name, $prefix = null ) {
1505  return in_array( $name, $this->listViews( $prefix ) );
1506  }
1507 
1508  protected function isTransactableQuery( $sql ) {
1509  return parent::isTransactableQuery( $sql ) &&
1510  !preg_match( '/^SELECT\s+(GET|RELEASE|IS_FREE)_LOCK\(/', $sql );
1511  }
1512 
1513  public function buildStringCast( $field ) {
1514  return "CAST( $field AS BINARY )";
1515  }
1516 
1521  public function buildIntegerCast( $field ) {
1522  return 'CAST( ' . $field . ' AS SIGNED )';
1523  }
1524 
1525  /*
1526  * @return bool Whether GTID support is used (mockable for testing)
1527  */
1528  protected function useGTIDs() {
1529  return $this->useGTIDs;
1530  }
1531 }
1532 
1536 class_alias( DatabaseMysqlBase::class, 'DatabaseMysqlBase' );
wasLockTimeout()
Determines if the last failure was due to a lock timeout.
normalizeConditions( $conds, $fname)
Definition: Database.php:1994
clearFlag( $flag, $remember=self::REMEMBER_NOTHING)
Clear a flag for this connection.
Definition: Database.php:754
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:2621
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
return true to allow those checks to and false if checking is done remove or add to the links of a group of changes in EnhancedChangesList Hook subscribers can return false to omit this line from recentchanges use this to change the tables headers change it to an object instance and return false override the list derivative used $groups Array of ChangesListFilterGroup objects(added in 1.34) 'FileDeleteComplete' 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:1529
addIdentifierQuotes( $s)
MySQL uses backticks for identifier quoting instead of the sql standard "double quotes".
bool $utf8Mode
Use experimental UTF-8 transmission encoding.
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:2758
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
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2147
executeQuery( $sql, $fname, $flags)
Execute a query, retrying it if there is a recoverable connection loss.
Definition: Database.php:1179
getServer()
Get the server hostname or IP address.
Definition: Database.php:2392
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:1621
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
int $flags
Bit field of class DBO_* constants.
Definition: Database.php:65
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:2892
static getCommonDomainGTIDs(MySQLMasterPos $pos, MySQLMasterPos $refPos)
query( $sql, $fname=__METHOD__, $flags=0)
Run an SQL query and return the result.
Definition: Database.php:1142
string $server
Server that this instance is currently connected to.
Definition: Database.php:51
getLBInfo( $name=null)
Get properties passed down from the server info array of the load balancer.
Definition: Database.php:581
see documentation in includes Linker php for Linker::makeImageLink & $time
Definition: hooks.txt:1781
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)
newExceptionAfterConnectError( $error)
Definition: Database.php:1603
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. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\*-\*)") will be honored when streaming the file. '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:1970
getMysqlStatus( $which="%")
Get status information from SHOW STATUS in an associative array.
close()
Close the database connection.
Definition: Database.php:872
getServerUptime()
Determines how long the server has been up.
installErrorHandler()
Set a custom error handler for logging errors during database connection.
Definition: Database.php:810
bool $useGTIDs
bool Whether to use GTID methods
getDBname()
Get the current DB name.
Definition: Database.php:2388
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:1244
mysqlFieldType( $res, $n)
Get the type of the specified field in a result.
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:1560
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:2715
$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:2396
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
$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:1972
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:767
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:769
doLockTables(array $read, array $write, $method)
makeList( $a, $mode=self::LIST_COMMA)
Makes an encoded list of strings from an array.
Definition: Database.php:2180
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:2454
getRecordedTransactionLagStatus()
Get the replica DB lag when the current transaction started.
Definition: Database.php:4355
if(defined( 'MW_SETUP_CALLBACK')) $fname
Customization point after all loading (constants, functions, classes, DefaultSettings, LocalSettings).
Definition: Setup.php:131
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:82
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.
getLogContext(array $extras=[])
Create a log context to pass to PSR-3 logger functions.
Definition: Database.php:861
selectRow( $table, $vars, $conds, $fname=__METHOD__, $options=[], $join_conds=[])
Single row SELECT wrapper.
Definition: Database.php:1882
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.
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:49
select( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
Execute a SELECT query constructed using the various parameters provided.
Definition: Database.php:1791
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:821
string $sqlMode
sql_mode value to send on connection
object resource null $conn
Database connection.
Definition: Database.php:98
isInsertSelectSafe(array $insertOptions, array $selectOptions)
string $user
User that this instance is currently connected under the name of.
Definition: Database.php:53
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:2205
Database abstraction object for MySQL.
listTables( $prefix=null, $fname=__METHOD__)
List all tables on the database.
Database error base class.
Definition: DBError.php:30
static & unwrap(&$res)
Get the underlying RDBMS driver-specific result resource.
string $password
Password used to establish the current connection.
Definition: Database.php:55
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.