31use Wikimedia\ScopedCallback;
32use Wikimedia\WaitConditionLoop;
107 parent::__construct(
$params );
112 if ( isset(
$params[
'servers'] ) ) {
113 $this->serverInfos = [];
114 $this->serverTags = [];
115 $this->numServers = count(
$params[
'servers'] );
117 foreach (
$params[
'servers']
as $tag => $info ) {
118 $this->serverInfos[$index] = $info;
119 if ( is_string( $tag ) ) {
120 $this->serverTags[$index] = $tag;
122 $this->serverTags[$index] = $info[
'host'] ??
"#$index";
126 } elseif ( isset(
$params[
'server'] ) ) {
127 $this->serverInfos = [
$params[
'server'] ];
128 $this->numServers = count( $this->serverInfos );
131 $this->serverInfos =
false;
132 $this->numServers = 1;
135 if ( isset(
$params[
'purgePeriod'] ) ) {
136 $this->purgePeriod = intval(
$params[
'purgePeriod'] );
138 if ( isset(
$params[
'tableName'] ) ) {
141 if ( isset(
$params[
'shards'] ) ) {
142 $this->shards = intval(
$params[
'shards'] );
144 if ( isset(
$params[
'syncTimeout'] ) ) {
145 $this->syncTimeout =
$params[
'syncTimeout'];
147 $this->replicaOnly = !empty(
$params[
'slaveOnly'] );
157 protected function getDB( $serverIndex ) {
158 if ( !isset( $this->conns[$serverIndex] ) ) {
159 if ( $serverIndex >= $this->numServers ) {
160 throw new MWException( __METHOD__ .
": Invalid server index \"$serverIndex\"" );
163 # Don't keep timing out trying to connect for each call if the DB is down
164 if ( isset( $this->connFailureErrors[$serverIndex] )
165 && ( time() - $this->connFailureTimes[$serverIndex] ) < 60
167 throw $this->connFailureErrors[$serverIndex];
170 if ( $this->serverInfos ) {
172 $info = $this->serverInfos[$serverIndex];
173 $type = $info[
'type'] ??
'mysql';
174 $host = $info[
'host'] ??
'[unknown]';
175 $this->logger->debug( __CLASS__ .
": connecting to $host" );
176 $db = Database::factory(
$type, $info );
180 $lb = MediaWikiServices::getInstance()->getDBLoadBalancer();
182 if ( $lb->getServerType( $lb->getWriterIndex() ) !==
'sqlite' ) {
184 $db = $lb->getConnection( $index, [],
false, $lb::CONN_TRX_AUTOCOMMIT );
188 $db = $lb->getConnection( $index );
192 $this->logger->debug( sprintf(
"Connection %s will be used for SqlBagOStuff", $db ) );
193 $this->conns[$serverIndex] = $db;
196 return $this->conns[$serverIndex];
205 if ( $this->shards > 1 ) {
206 $hash = hexdec( substr( md5( $key ), 0, 8 ) ) & 0x7fffffff;
211 if ( $this->numServers > 1 ) {
213 ArrayUtils::consistentHashSort( $sortedServers, $key );
214 reset( $sortedServers );
215 $serverIndex =
key( $sortedServers );
228 if ( $this->shards > 1 ) {
229 $decimals = strlen( $this->shards - 1 );
231 sprintf(
"%0{$decimals}d", $index );
237 protected function doGet( $key, $flags = 0, &$casToken =
null ) {
241 if ( array_key_exists( $key, $blobs ) ) {
242 $blob = $blobs[$key];
257 foreach ( $blobs
as $key =>
$blob ) {
270 $keysByTable[$serverIndex][
$tableName][] = $key;
276 foreach ( $keysByTable
as $serverIndex => $serverKeys ) {
278 $db = $this->
getDB( $serverIndex );
281 [
'keyname',
'value',
'exptime' ],
282 [
'keyname' => $tableKeys ],
287 $db->trxLevel() ? [
'LOCK IN SHARE MODE' ] : []
289 if (
$res ===
false ) {
292 foreach (
$res as $row ) {
293 $row->serverIndex = $serverIndex;
295 $dataRows[$row->keyname] = $row;
304 if ( isset( $dataRows[$key] ) ) {
305 $row = $dataRows[$key];
306 $this->
debug(
"get: retrieved data; expiry time is " . $row->exptime );
309 $db = $this->
getDB( $row->serverIndex );
310 if ( $this->
isExpired( $db, $row->exptime ) ) {
311 $this->
debug(
"get: key has expired" );
313 $values[$key] = $db->decodeBlob( $row->value );
319 $this->
debug(
'get: no matching rows' );
327 return $this->
insertMulti( $data, $expiry, $flags,
true );
334 $keysByTable[$serverIndex][
$tableName][] = $key;
340 $exptime = (int)$expiry;
342 foreach ( $keysByTable
as $serverIndex => $serverKeys ) {
345 $db = $this->
getDB( $serverIndex );
352 if ( $exptime < 0 ) {
356 if ( $exptime == 0 ) {
360 $encExpiry = $db->timestamp( $exptime );
364 foreach ( $tableKeys
as $key ) {
367 'value' => $db->encodeBlob( $this->
serialize( $data[$key] ) ),
368 'exptime' => $encExpiry,
387 if ( ( $flags & self::WRITE_SYNC ) == self::WRITE_SYNC ) {
394 public function set( $key,
$value, $exptime = 0, $flags = 0 ) {
400 public function add( $key,
$value, $exptime = 0, $flags = 0 ) {
406 protected function cas( $casToken, $key,
$value, $exptime = 0, $flags = 0 ) {
411 $db = $this->
getDB( $serverIndex );
412 $exptime = intval( $exptime );
414 if ( $exptime < 0 ) {
418 if ( $exptime == 0 ) {
422 $encExpiry = $db->timestamp( $exptime );
430 'value' => $db->encodeBlob( $this->serialize(
$value ) ),
431 'exptime' => $encExpiry
435 'value' => $db->encodeBlob( $casToken )
445 return (
bool)$db->affectedRows();
452 $keysByTable[$serverIndex][
$tableName][] = $key;
457 foreach ( $keysByTable
as $serverIndex => $serverKeys ) {
460 $db = $this->
getDB( $serverIndex );
469 $db->delete(
$tableName, [
'keyname' => $tableKeys ], __METHOD__ );
478 if ( ( $flags & self::WRITE_SYNC ) == self::WRITE_SYNC ) {
485 public function delete( $key, $flags = 0 ) {
491 public function incr( $key, $step = 1 ) {
496 $db = $this->
getDB( $serverIndex );
497 $step = intval( $step );
498 $row = $db->selectRow(
500 [
'value',
'exptime' ],
501 [
'keyname' => $key ],
505 if ( $row ===
false ) {
509 $db->delete(
$tableName, [
'keyname' => $key ], __METHOD__ );
510 if ( $this->
isExpired( $db, $row->exptime ) ) {
515 $oldValue = intval( $this->
unserialize( $db->decodeBlob( $row->value ) ) );
516 $newValue = $oldValue + $step;
521 'value' => $db->encodeBlob( $this->serialize( $newValue ) ),
522 'exptime' => $row->exptime
528 if ( $db->affectedRows() == 0 ) {
540 public function merge( $key, callable $callback, $exptime = 0, $attempts = 10, $flags = 0 ) {
541 $ok = $this->
mergeViaCas( $key, $callback, $exptime, $attempts, $flags );
542 if ( ( $flags & self::WRITE_SYNC ) == self::WRITE_SYNC ) {
549 public function changeTTL( $key, $exptime = 0, $flags = 0 ) {
554 $db = $this->
getDB( $serverIndex );
555 if ( $exptime == 0 ) {
562 [
'exptime' => $timestamp ],
563 [
'keyname' => $key,
'exptime > ' . $db->addQuotes( $db->timestamp( time() ) ) ],
566 if ( $db->affectedRows() == 0 ) {
567 $exists = (bool)$db->selectField(
570 [
'keyname' => $key,
'exptime' => $timestamp ],
599 if ( time() > 0x7fffffff ) {
600 return $db->timestamp( 1 << 62 );
602 return $db->timestamp( 0x7fffffff );
607 if ( !$this->purgePeriod || $this->replicaOnly ) {
612 if ( $this->purgePeriod !== 1 && mt_rand( 0, $this->purgePeriod - 1 ) ) {
617 if ( $now > ( $this->lastExpireAll + 1 ) ) {
618 $this->lastExpireAll = $now;
638 $db = $this->
getDB( $serverIndex );
639 $dbTimestamp = $db->timestamp( $timestamp );
640 $totalSeconds =
false;
641 $baseConds = [
'exptime < ' . $db->addQuotes( $dbTimestamp ) ];
646 if ( $maxExpTime !==
false ) {
647 $conds[] =
'exptime >= ' . $db->addQuotes( $maxExpTime );
651 [
'keyname',
'exptime' ],
654 [
'LIMIT' => 100,
'ORDER BY' =>
'exptime' ] );
659 $row =
$rows->current();
660 $minExpTime = $row->exptime;
661 if ( $totalSeconds ===
false ) {
666 $keys[] = $row->keyname;
667 $maxExpTime = $row->exptime;
673 'exptime >= ' . $db->addQuotes( $minExpTime ),
674 'exptime < ' . $db->addQuotes( $dbTimestamp ),
679 if ( $progressCallback ) {
680 if ( intval( $totalSeconds ) === 0 ) {
683 $remainingSeconds =
wfTimestamp( TS_UNIX, $timestamp )
685 if ( $remainingSeconds > $totalSeconds ) {
686 $totalSeconds = $remainingSeconds;
688 $processedSeconds = $totalSeconds - $remainingSeconds;
689 $percent = ( $i + $processedSeconds / $totalSeconds )
690 / $this->shards * 100;
693 + ( $serverIndex / $this->numServers * 100 );
694 call_user_func( $progressCallback, $percent );
716 $db = $this->
getDB( $serverIndex );
739 if ( function_exists(
'gzdeflate' ) ) {
740 return gzdeflate( $serial );
752 if ( function_exists(
'gzinflate' ) ) {
753 Wikimedia\suppressWarnings();
754 $decomp = gzinflate( $serial );
755 Wikimedia\restoreWarnings();
757 if ( $decomp !==
false ) {
801 $this->logger->error(
"DBError: {$exception->getMessage()}" );
804 $this->logger->debug( __METHOD__ .
": ignoring connection error" );
807 $this->logger->debug( __METHOD__ .
": ignoring query error" );
818 unset( $this->conns[$serverIndex] );
820 if ( isset( $this->connFailureTimes[$serverIndex] ) ) {
821 if ( time() - $this->connFailureTimes[$serverIndex] >= 60 ) {
822 unset( $this->connFailureTimes[$serverIndex] );
823 unset( $this->connFailureErrors[$serverIndex] );
825 $this->logger->debug( __METHOD__ .
": Server #$serverIndex already down" );
830 $this->logger->info( __METHOD__ .
": Server #$serverIndex down until " . ( $now + 60 ) );
831 $this->connFailureTimes[$serverIndex] = $now;
832 $this->connFailureErrors[$serverIndex] = $exception;
840 $db = $this->
getDB( $serverIndex );
841 if ( $db->getType() !==
'mysql' ) {
842 throw new MWException( __METHOD__ .
' is not supported on this DB server' );
847 'CREATE TABLE ' . $db->tableName( $this->getTableNameByShard( $i ) ) .
848 ' LIKE ' . $db->tableName(
'objectcache' ),
867 $lb = MediaWikiServices::getInstance()->getDBLoadBalancer();
868 if ( $lb->getServerCount() <= 1 ) {
874 $masterPos = $lb->getMasterPos();
879 $loop =
new WaitConditionLoop(
880 function ()
use ( $lb, $masterPos ) {
881 return $lb->waitForAll( $masterPos, 1 );
887 return ( $loop->invoke() === $loop::CONDITION_REACHED );
902 $trxProfiler = Profiler::instance()->getTransactionProfiler();
903 $oldSilenced = $trxProfiler->setSilenced(
true );
904 return new ScopedCallback(
function ()
use ( $trxProfiler, $oldSilenced ) {
905 $trxProfiler->setSilenced( $oldSilenced );
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
wfTimestampNow()
Convenience function; returns MediaWiki timestamp for the present time.
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
Class representing a cache/ephemeral data store.
convertToExpiry( $exptime)
Convert an optionally relative time to an absolute time.
mergeViaCas( $key, $callback, $exptime=0, $attempts=10, $flags=0)
callable[] $busyCallbacks
setLastError( $err)
Set the "last error" registry.
Class to store objects in the database.
setMulti(array $data, $expiry=0, $flags=0)
Batch insertion/replace.
getDB( $serverIndex)
Get a connection to the specified database.
changeTTL( $key, $exptime=0, $flags=0)
Change the expiration on a key if it exists.
string[] $serverTags
(server index => tag/host name)
LoadBalancer null $separateMainLB
deleteMulti(array $keys, $flags=0)
Batch deletion.
createTables()
Create shard tables.
getTableByKey( $key)
Get the server index and table name for a given key.
insertMulti(array $data, $expiry, $flags, $replace)
fetchBlobMulti(array $keys, $flags=0)
getMulti(array $keys, $flags=0)
Get an associative array containing the item for each of the keys that have items.
add( $key, $value, $exptime=0, $flags=0)
Insert an item if it does not already exist.
array[] $serverInfos
(server index => server config)
deleteAll()
Delete content of shard tables in every server.
__construct( $params)
Constructor.
doGet( $key, $flags=0, &$casToken=null)
isExpired( $db, $exptime)
handleWriteError(DBError $exception, IDatabase $db=null, $serverIndex)
Handle a DBQueryError which occurred during a write operation.
silenceTransactionProfiler()
Returns a ScopedCallback which resets the silence flag in the transaction profiler when it is destroy...
array $connFailureTimes
UNIX timestamps.
array $connFailureErrors
Exceptions.
deleteObjectsExpiringBefore( $timestamp, $progressCallback=false)
Delete objects from the database which expire before a certain date.
merge( $key, callable $callback, $exptime=0, $attempts=10, $flags=0)
Merge changes into the existing cache value (possibly creating a new one)
setAndLogDBError(DBError $exception)
serialize(&$data)
Serialize an object and, if possible, compress the representation.
markServerDown(DBError $exception, $serverIndex)
Mark a server down due to a DBConnectionError exception.
unserialize( $serial)
Unserialize and, if necessary, decompress an object.
getTableNameByShard( $index)
Get the table name for a given shard index.
incr( $key, $step=1)
Increase stored value of $key by $value while preserving its TTL.
handleReadError(DBError $exception, $serverIndex)
Handle a DBError which occurred during a read operation.
cas( $casToken, $key, $value, $exptime=0, $flags=0)
Check and set an item.
We use the convention $dbr for read and $dbw for write to help you keep track of whether the database object is a the world will explode Or to be a subsequent write query which succeeded on the master may fail when replicated to the slave due to a unique key collision Replication on the slave will stop and it may take hours to repair the database and get it back online Setting read_only in my cnf on the slave will avoid this but given the dire we prefer to have as many checks as possible We provide a but the wrapper functions like please read the documentation for tableName() and addQuotes(). You will need both of them. ------------------------------------------------------------------------ Basic query optimisation ------------------------------------------------------------------------ MediaWiki developers who need to write DB queries should have some understanding of databases and the performance issues associated with them. Patches containing unacceptably slow features will not be accepted. Unindexed queries are generally not welcome in MediaWiki
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 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
$data
Utility to generate mapping file used in mw.Title (phpCharToUpper.json)
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
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=(\d*-\d*)") 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
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation use $formDescriptor instead default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message key
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
processing should stop and the error should be shown to the user * false
returning false will NOT prevent logging $e
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
const QOS_SYNCWRITES_NONE
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))