Go to the documentation of this file.
28 use InvalidArgumentException;
78 const LAG_STALE_WARN_THRESHOLD = 0.100;
100 $this->lagDetectionMethod =
$params[
'lagDetectionMethod'] ??
'Seconds_Behind_Master';
101 $this->lagDetectionOptions =
$params[
'lagDetectionOptions'] ?? [];
103 foreach ( [
'KeyPath',
'CertPath',
'CAFile',
'CAPath',
'Ciphers' ]
as $name ) {
105 if ( isset(
$params[$var] ) ) {
109 $this->sqlMode =
$params[
'sqlMode'] ??
null;
110 $this->utf8Mode = !empty(
$params[
'utf8Mode'] );
111 $this->insertSelectIsSafe = isset(
$params[
'insertSelectIsSafe'] )
112 ? (bool)
$params[
'insertSelectIsSafe'] :
null;
114 parent::__construct(
$params );
125 # Close/unset connection handle
135 }
catch ( Exception $ex ) {
141 # Always log connection errors
142 if ( !$this->conn ) {
144 $this->connLogger->error(
145 "Error connecting to {db_server}: {error}",
147 'method' => __METHOD__,
151 $this->connLogger->debug(
"DB connection error\n" .
152 "Server: $server, User: $user, Password: " .
153 substr(
$password, 0, 3 ) .
"..., error: " . $error .
"\n" );
158 if ( strlen( $dbName ) ) {
161 $this->currentDomain =
new DatabaseDomain(
null,
null, $tablePrefix );
167 $this->queryLogger->error(
168 "Error setting character set: {error}",
170 'method' => __METHOD__,
178 $set = [
'group_concat_max_len = 262144' ];
180 if ( is_string( $this->sqlMode ) ) {
181 $set[] =
'sql_mode = ' . $this->
addQuotes( $this->sqlMode );
185 foreach ( $this->sessionVars
as $var => $val ) {
187 if ( !is_int( $val ) && !is_float( $val ) ) {
198 $this->queryLogger->error(
199 'Error setting MySQL variables on server {db_server}: {error}',
201 'method' => __METHOD__,
209 $this->opened =
true;
219 if ( $this->utf8Mode ) {
230 throw new DBExpectedError( $this, __CLASS__ .
": domain schemas are not supported." );
235 if ( $database ===
null ) {
237 $this->currentDomain->getDatabase(),
245 if ( $database !== $this->
getDBname() ) {
248 if (
$ret ===
false ) {
256 $this->currentDomain = $domain;
269 abstract protected function mysqlConnect( $realServer, $dbName );
287 Wikimedia\suppressWarnings();
289 Wikimedia\restoreWarnings();
312 Wikimedia\suppressWarnings();
314 Wikimedia\restoreWarnings();
321 if ( $errno == 2000 || $errno == 2013 ) {
324 'Error in fetchObject(): ' . htmlspecialchars( $this->
lastError() )
348 Wikimedia\suppressWarnings();
350 Wikimedia\restoreWarnings();
357 if ( $errno == 2000 || $errno == 2013 ) {
360 'Error in fetchRow(): ' . htmlspecialchars( $this->
lastError() )
384 Wikimedia\suppressWarnings();
386 Wikimedia\restoreWarnings();
496 # Even if it's non-zero, it can still be invalid
497 Wikimedia\suppressWarnings();
502 Wikimedia\restoreWarnings();
507 $error .=
' (' . $this->
server .
')';
524 return in_array( $errno, [ 2062, 3024 ] );
534 if ( $row->binlog_format ===
'ROW' ) {
538 if ( isset( $selectOptions[
'LIMIT'] ) ) {
549 in_array(
'NO_AUTO_COLUMNS', $insertOptions ) ||
550 (
int)$row->innodb_autoinc_lock_mode === 0
558 if ( $this->replicationInfoRow ===
null ) {
559 $this->replicationInfoRow = $this->
selectRow(
562 'innodb_autoinc_lock_mode' =>
'@@innodb_autoinc_lock_mode',
563 'binlog_format' =>
'@@binlog_format',
591 if ( is_string( $column ) && !in_array( $column, [
'*',
'1' ] ) ) {
592 $conds[] =
"$column IS NOT NULL";
597 if (
$res ===
false ) {
605 foreach (
$res as $plan ) {
606 $rows *= $plan->rows > 0 ? $plan->rows : 1;
616 $tableName =
"{$prefix}{$table}";
618 if ( isset( $this->sessionTempTables[$tableName] ) ) {
627 if ( $database !==
'' ) {
629 $query =
"SHOW TABLES FROM $encDatabase LIKE '$encLike'";
631 $query =
"SHOW TABLES LIKE '$encLike'";
644 $res = $this->
query(
"SELECT * FROM $table LIMIT 1", __METHOD__,
true );
649 for ( $i = 0; $i < $n; $i++ ) {
651 if ( $field == $meta->name ) {
678 # SHOW INDEX works in MySQL 3.23.58, but SHOW INDEXES does not.
679 # SHOW INDEX should work for 3.x and up:
680 # https://dev.mysql.com/doc/mysql/en/SHOW_INDEX.html
684 $sql =
'SHOW INDEX FROM ' . $table;
693 foreach (
$res as $row ) {
694 if ( $row->Key_name == $index ) {
717 if ( is_bool(
$s ) ) {
723 return parent::addQuotes(
$s );
735 return '`' . str_replace( [
"\0",
'`' ], [
'',
'``' ],
$s ) .
'`';
743 return strlen(
$name ) &&
$name[0] ==
'`' && substr(
$name, -1, 1 ) ==
'`';
765 $res = $this->
query(
'SHOW SLAVE STATUS', __METHOD__ );
766 $row =
$res ?
$res->fetchObject() :
false;
768 if ( $row && strval( $row->Seconds_Behind_Master ) !==
'' ) {
769 return intval( $row->Seconds_Behind_Master );
782 if ( $currentTrxInfo ) {
784 $staleness = microtime(
true ) - $currentTrxInfo[
'since'];
785 if ( $staleness > self::LAG_STALE_WARN_THRESHOLD ) {
788 $this->queryLogger->warning(
789 "Using cached lag value for {db_server} due to active transaction",
791 'method' => __METHOD__,
793 'trace' => (
new RuntimeException() )->getTraceAsString()
798 return $currentTrxInfo[
'lag'];
807 if ( !$masterInfo ) {
808 $this->queryLogger->error(
809 "Unable to query master of {db_server} for server ID",
811 'method' => __METHOD__
818 $conds = [
'server_id' => intval( $masterInfo[
'serverId'] ) ];
823 if (
$time !==
null ) {
825 $dateTime =
new DateTime(
$time,
new DateTimeZone(
'UTC' ) );
826 $timeUnix = (int)$dateTime->format(
'U' ) + $dateTime->format(
'u' ) / 1e6;
828 return max( $nowUnix - $timeUnix, 0.0 );
831 $this->queryLogger->error(
832 "Unable to find pt-heartbeat row for {db_server}",
834 'method' => __METHOD__
843 $key =
$cache->makeGlobalKey(
851 return $cache->getWithSetCallback(
853 $cache::TTL_INDEFINITE,
856 if ( !
$cache->lock( $key, 0, 10 ) ) {
868 $row =
$res ?
$res->fetchObject() :
false;
869 $id = $row ? (int)$row->id : 0;
875 return $id ? [
'serverId' => $id,
'asOf' => time() ] :
false;
887 $nowUnix = microtime(
true );
896 "SELECT ts FROM heartbeat.heartbeat WHERE $whereSQL ORDER BY ts DESC LIMIT 1",
899 $row =
$res ?
$res->fetchObject() :
false;
904 return [ $row ? $row->ts :
null, $nowUnix ];
912 return parent::getApproximateLagStatus();
915 $key = $this->srvCache->makeGlobalKey(
'mysql-lag', $this->
getServer() );
916 $approxLag = $this->srvCache->get( $key );
918 $approxLag = parent::getApproximateLagStatus();
919 $this->srvCache->set( $key, $approxLag, 1 );
927 throw new InvalidArgumentException(
"Position not an instance of MySQLMasterPos" );
930 if ( $this->
getLBInfo(
'is static' ) ===
true ) {
932 } elseif ( $this->lastKnownReplicaPos && $this->lastKnownReplicaPos->hasReached( $pos ) ) {
937 if ( $pos->getGTIDs() ) {
942 $this->queryLogger->error(
943 "No GTIDs with the same domain between master ($pos) and replica ($rpos)",
945 'method' => __METHOD__,
952 $gtidArg = $this->
addQuotes( implode(
',', $gtidsWait ) );
953 if ( strpos( $gtidArg,
':' ) !==
false ) {
955 $res = $this->
doQuery(
"SELECT WAIT_FOR_EXECUTED_GTID_SET($gtidArg, $timeout)" );
958 $res = $this->
doQuery(
"SELECT MASTER_GTID_WAIT($gtidArg, $timeout)" );
962 $encFile = $this->
addQuotes( $pos->getLogFile() );
963 $encPos = intval( $pos->getLogPosition()[$pos::CORD_EVENT] );
964 $res = $this->
doQuery(
"SELECT MASTER_POS_WAIT($encFile, $encPos, $timeout)" );
969 throw new DBExpectedError( $this,
"Replication wait failed: {$this->lastError()}" );
973 $status = ( $row[0] !==
null ) ? intval( $row[0] ) :
null;
975 if ( !$pos->getGTIDs() ) {
982 if ( $replicationPos && !$replicationPos->channelsMatch( $pos ) ) {
983 $this->lastKnownReplicaPos = $replicationPos;
989 $this->lastKnownReplicaPos = $pos;
1001 $now = microtime(
true );
1007 foreach ( [
'gtid_slave_pos',
'gtid_executed' ]
as $name ) {
1015 if (
$data && strlen(
$data[
'Relay_Master_Log_File'] ) ) {
1017 "{$data['Relay_Master_Log_File']}/{$data['Exec_Master_Log_Pos']}",
1031 $now = microtime(
true );
1038 foreach ( [
'gtid_binlog_pos',
'gtid_executed' ]
as $name ) {
1046 $pos->setActiveOriginServerId( $this->
getServerId() );
1048 if ( isset(
$data[
'gtid_domain_id'] ) ) {
1049 $pos->setActiveDomain(
$data[
'gtid_domain_id'] );
1057 $pos =
new MySQLMasterPos(
"{$data['File']}/{$data['Position']}", $now );
1070 return $this->srvCache->getWithSetCallback(
1071 $this->srvCache->makeGlobalKey(
'mysql-server-id', $this->getServer() ),
1072 self::SERVER_ID_CACHE_TTL,
1084 return $this->srvCache->getWithSetCallback(
1085 $this->srvCache->makeGlobalKey(
'mysql-server-uuid', $this->getServer() ),
1086 self::SERVER_ID_CACHE_TTL,
1088 $res = $this->
query(
"SHOW GLOBAL VARIABLES LIKE 'server_uuid'" );
1091 return $row ? $row->Value :
null;
1104 foreach (
$res as $row ) {
1105 $map[$row->Variable_name] = $row->Value;
1108 $res = $this->
query(
"SHOW SESSION VARIABLES LIKE 'gtid_%'",
$fname );
1109 foreach (
$res as $row ) {
1110 $map[$row->Variable_name] = $row->Value;
1122 return $this->
query(
"SHOW $role STATUS",
$fname )->fetchRow() ?: [];
1126 $res = $this->
query(
"SHOW GLOBAL VARIABLES LIKE 'read_only'", __METHOD__ );
1129 return $row ? ( strtolower( $row->Value ) ===
'on' ) :
false;
1137 return "FORCE INDEX (" . $this->
indexName( $index ) .
")";
1145 return "IGNORE INDEX (" . $this->
indexName( $index ) .
")";
1152 return 'LOW_PRIORITY';
1163 if ( strpos( $version,
'MariaDB' ) !==
false || strpos( $version,
'-maria-' ) !==
false ) {
1164 return '[{{int:version-db-mariadb-url}} MariaDB]';
1170 return '[{{int:version-db-mysql-url}} MySQL]';
1180 if ( $this->serverVersion ===
null ) {
1181 $this->serverVersion = $this->
selectField(
'',
'VERSION()',
'', __METHOD__ );
1190 if ( isset(
$options[
'connTimeout'] ) ) {
1191 $timeout = (int)
$options[
'connTimeout'];
1192 $this->
query(
"SET net_read_timeout=$timeout" );
1193 $this->
query(
"SET net_write_timeout=$timeout" );
1203 if ( strtoupper( substr( $newLine, 0, 9 ) ) ==
'DELIMITER' ) {
1204 preg_match(
'/^DELIMITER\s+(\S+)/', $newLine, $m );
1205 $this->delimiter = $m[1];
1209 return parent::streamStatementEnd( $sql, $newLine );
1221 if ( !parent::lockIsFree( $lockName, $method ) ) {
1226 $result = $this->
query(
"SELECT IS_FREE_LOCK($encName) AS lockstatus", $method );
1229 return ( $row->lockstatus == 1 );
1238 public function lock( $lockName, $method, $timeout = 5 ) {
1240 $result = $this->
query(
"SELECT GET_LOCK($encName, $timeout) AS lockstatus", $method );
1243 if ( $row->lockstatus == 1 ) {
1244 parent::lock( $lockName, $method, $timeout );
1248 $this->queryLogger->info( __METHOD__ .
" failed to acquire lock '{lockname}'",
1249 [
'lockname' => $lockName ] );
1261 public function unlock( $lockName, $method ) {
1263 $result = $this->
query(
"SELECT RELEASE_LOCK($encName) as lockstatus", $method );
1266 if ( $row->lockstatus == 1 ) {
1267 parent::unlock( $lockName, $method );
1271 $this->queryLogger->warning( __METHOD__ .
" failed to release lock '$lockName'\n" );
1279 return ( strlen( $lockName ) > 64 ) ? sha1( $lockName ) : $lockName;
1292 foreach ( $write
as $table ) {
1293 $items[] = $this->
tableName( $table ) .
' WRITE';
1295 foreach ( $read
as $table ) {
1296 $items[] = $this->
tableName( $table ) .
' READ';
1299 $sql =
"LOCK TABLES " . implode(
',', $items );
1300 $this->
query( $sql, $method );
1306 $this->
query(
"UNLOCK TABLES", $method );
1315 if (
$value ===
'default' ) {
1316 if ( $this->defaultBigSelects ===
null ) {
1317 # Function hasn't been called before so it must already be set to the default
1322 } elseif ( $this->defaultBigSelects ===
null ) {
1323 $this->defaultBigSelects =
1324 (bool)$this->
selectField(
false,
'@@sql_big_selects',
'', __METHOD__ );
1326 $encValue =
$value ?
'1' :
'0';
1327 $this->
query(
"SET sql_big_selects=$encValue", __METHOD__ );
1341 $delTable, $joinTable, $delVar, $joinVar, $conds,
$fname = __METHOD__
1347 $delTable = $this->
tableName( $delTable );
1348 $joinTable = $this->
tableName( $joinTable );
1349 $sql =
"DELETE $delTable FROM $delTable, $joinTable WHERE $delVar=$joinVar ";
1351 if ( $conds !=
'*' ) {
1361 if (
$rows === [] ) {
1365 if ( !is_array( reset(
$rows ) ) ) {
1370 $columns = array_keys(
$rows[0] );
1372 $sql =
"INSERT INTO $table (" . implode(
',', $columns ) .
') VALUES ';
1375 $rowTuples[] =
'(' . $this->
makeList( $row ) .
')';
1377 $sql .= implode(
',', $rowTuples );
1393 return (
int)
$vars[
'Uptime'];
1425 return $errno == 2013 || $errno == 2006;
1431 if ( $errno === 1205 ) {
1435 [
'innodb_rollback_on_timeout' =>
'@@innodb_rollback_on_timeout' ],
1441 return $row->innodb_rollback_on_timeout ?
false :
true;
1445 return in_array( $errno, [ 1022, 1062, 1216, 1217, 1137, 1146, 1051, 1054 ],
true );
1456 $oldName, $newName, $temporary =
false,
$fname = __METHOD__
1458 $tmp = $temporary ?
'TEMPORARY ' :
'';
1461 $query =
"CREATE $tmp TABLE $newName (LIKE $oldName)";
1479 $vars = get_object_vars( $table );
1480 $table = array_pop(
$vars );
1482 if ( !$prefix || strpos( $table, $prefix ) === 0 ) {
1483 $endArray[] = $table;
1495 public function dropTable( $tableName, $fName = __METHOD__ ) {
1496 if ( !$this->
tableExists( $tableName, $fName ) ) {
1500 return $this->
query(
"DROP TABLE IF EXISTS " . $this->
tableName( $tableName ), $fName );
1510 $res = $this->
query(
"SHOW STATUS LIKE '{$which}'" );
1513 foreach (
$res as $row ) {
1514 $status[$row->Variable_name] = $row->Value;
1531 $propertyName =
'Tables_in_' . $this->
getDBname();
1534 $res = $this->
query(
'SHOW FULL TABLES WHERE TABLE_TYPE = "VIEW"' );
1536 foreach (
$res as $row ) {
1537 array_push( $allViews, $row->$propertyName );
1540 if ( is_null( $prefix ) || $prefix ===
'' ) {
1544 $filteredViews = [];
1545 foreach ( $allViews
as $viewName ) {
1547 if ( strpos( $viewName, $prefix ) === 0 ) {
1548 array_push( $filteredViews, $viewName );
1552 return $filteredViews;
1568 return parent::isTransactableQuery( $sql ) &&
1569 !preg_match(
'/^SELECT\s+(GET|RELEASE|IS_FREE)_LOCK\(/', $sql );
1573 return "CAST( $field AS BINARY )";
1581 return 'CAST( ' . $field .
' AS SIGNED )';
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 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object '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
processing should stop and the error should be shown to the user * false
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
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
null for the 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
$data
Utility to generate mapping file used in mw.Title (phpCharToUpper.json)
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
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
static configuration should be added through ResourceLoaderGetConfigVars instead & $vars
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
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
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
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
if(defined( 'MW_SETUP_CALLBACK')) $fname
Customization point after all loading (constants, functions, classes, DefaultSettings,...
Allows to change the fields on the form that will be generated $name
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
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 noclasses & $ret
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
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
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
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
see documentation in includes Linker php for Linker::makeImageLink & $time
Class to handle database/prefix specification for IDatabase domains.
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