4use Liuggio\StatsdClient\Factory\StatsdDataFactoryInterface;
7use Wikimedia\Assert\Assert;
8use Wikimedia\ScopedCallback;
76 $this->loadBalancer = $loadBalancer;
78 $this->readOnlyMode = $readOnlyMode;
80 $this->deferredUpdatesAddCallableUpdateCallback = [
'DeferredUpdates',
'addCallableUpdate' ];
81 $this->revisionGetTimestampFromIdCallback = [
'Revision',
'getTimestampFromId' ];
85 $this->stats = $stats;
100 if ( !defined(
'MW_PHPUNIT_TEST' ) ) {
102 'Cannot override DeferredUpdates::addCallableUpdate callback in operation.'
105 $previousValue = $this->deferredUpdatesAddCallableUpdateCallback;
106 $this->deferredUpdatesAddCallableUpdateCallback = $callback;
107 return new ScopedCallback(
function ()
use ( $previousValue ) {
108 $this->deferredUpdatesAddCallableUpdateCallback = $previousValue;
123 if ( !defined(
'MW_PHPUNIT_TEST' ) ) {
125 'Cannot override Revision::getTimestampFromId callback in operation.'
128 $previousValue = $this->revisionGetTimestampFromIdCallback;
129 $this->revisionGetTimestampFromIdCallback = $callback;
130 return new ScopedCallback(
function ()
use ( $previousValue ) {
131 $this->revisionGetTimestampFromIdCallback = $previousValue;
136 return $this->
cache->makeKey(
139 (
string)
$user->getId()
147 $this->
cache->set( $key, $item );
148 $this->cacheIndex[$target->getNamespace()][$target->getDBkey()][
$user->getId()] = $key;
149 $this->stats->increment(
'WatchedItemStore.cache' );
155 $this->stats->increment(
'WatchedItemStore.uncache' );
159 $this->stats->increment(
'WatchedItemStore.uncacheLinkTarget' );
164 $this->stats->increment(
'WatchedItemStore.uncacheLinkTarget.items' );
165 $this->
cache->delete( $key );
170 $this->stats->increment(
'WatchedItemStore.uncacheUser' );
171 foreach ( $this->cacheIndex
as $ns => $dbKeyArray ) {
172 foreach ( $dbKeyArray
as $dbKey => $userArray ) {
173 if ( isset( $userArray[
$user->getId()] ) ) {
174 $this->stats->increment(
'WatchedItemStore.uncacheUser.items' );
175 $this->
cache->delete( $userArray[
$user->getId()] );
202 'wl_user' =>
$user->getId(),
215 return $this->loadBalancer->getConnectionRef( $dbIndex, [
'watchlist' ] );
228 $return = (int)
$dbr->selectField(
232 'wl_user' =>
$user->getId()
247 $return = (int)
$dbr->selectField(
272 $visitingWatchers = (int)
$dbr->selectField(
278 'wl_notificationtimestamp >= ' .
279 $dbr->addQuotes(
$dbr->timestamp( $threshold ) ) .
280 ' OR wl_notificationtimestamp IS NULL'
285 return $visitingWatchers;
298 if ( $targets === [] ) {
303 $dbOptions = [
'GROUP BY' => [
'wl_namespace',
'wl_title' ] ];
307 if ( array_key_exists(
'minimumWatchers',
$options ) ) {
308 $dbOptions[
'HAVING'] =
'COUNT(*) >= ' . (int)
$options[
'minimumWatchers'];
314 [
'wl_title',
'wl_namespace',
'watchers' =>
'COUNT(*)' ],
315 [ $lb->constructSet(
'wl',
$dbr ) ],
321 foreach ( $targets
as $linkTarget ) {
322 $watchCounts[$linkTarget->getNamespace()][$linkTarget->getDBkey()] = 0;
325 foreach (
$res as $row ) {
326 $watchCounts[$row->wl_namespace][$row->wl_title] = (int)$row->watchers;
348 array $targetsWithVisitThresholds,
349 $minimumWatchers =
null
355 $dbOptions = [
'GROUP BY' => [
'wl_namespace',
'wl_title' ] ];
356 if ( $minimumWatchers !==
null ) {
357 $dbOptions[
'HAVING'] =
'COUNT(*) >= ' . (int)$minimumWatchers;
361 [
'wl_namespace',
'wl_title',
'watchers' =>
'COUNT(*)' ],
368 foreach ( $targetsWithVisitThresholds
as list( $target ) ) {
370 $watcherCounts[$target->getNamespace()][$target->getDBkey()] = 0;
373 foreach (
$res as $row ) {
374 $watcherCounts[$row->wl_namespace][$row->wl_title] = (int)$row->watchers;
377 return $watcherCounts;
389 array $targetsWithVisitThresholds
391 $missingTargets = [];
392 $namespaceConds = [];
393 foreach ( $targetsWithVisitThresholds
as list( $target, $threshold ) ) {
394 if ( $threshold ===
null ) {
395 $missingTargets[] = $target;
399 $namespaceConds[$target->getNamespace()][] = $db->
makeList( [
400 'wl_title = ' . $db->
addQuotes( $target->getDBkey() ),
403 'wl_notificationtimestamp IS NULL'
409 foreach ( $namespaceConds
as $namespace => $pageConds ) {
411 'wl_namespace = ' . $namespace,
416 if ( $missingTargets ) {
418 $conds[] = $lb->constructSet(
'wl', $db );
433 if (
$user->isAnon() ) {
439 $this->stats->increment(
'WatchedItemStore.getWatchedItem.cached' );
442 $this->stats->increment(
'WatchedItemStore.getWatchedItem.load' );
456 if (
$user->isAnon() ) {
461 $row =
$dbr->selectRow(
463 'wl_notificationtimestamp',
477 $this->
cache( $item );
495 if ( array_key_exists(
'sort',
$options ) ) {
497 ( in_array(
$options[
'sort'], [ self::SORT_ASC, self::SORT_DESC ] ) ),
498 '$options[\'sort\']',
499 'must be SORT_ASC or SORT_DESC'
501 $dbOptions[
'ORDER BY'] = [
502 "wl_namespace {$options['sort']}",
503 "wl_title {$options['sort']}"
510 [
'wl_namespace',
'wl_title',
'wl_notificationtimestamp' ],
511 [
'wl_user' =>
$user->getId() ],
517 foreach (
$res as $row ) {
521 new TitleValue( (
int)$row->wl_namespace, $row->wl_title ),
522 $row->wl_notificationtimestamp
526 return $watchedItems;
552 foreach ( $targets
as $target ) {
553 $timestamps[$target->getNamespace()][$target->getDBkey()] =
false;
556 if (
$user->isAnon() ) {
561 foreach ( $targets
as $target ) {
564 $timestamps[$target->getNamespace()][$target->getDBkey()] =
565 $cachedItem->getNotificationTimestamp();
567 $targetsToLoad[] = $target;
571 if ( !$targetsToLoad ) {
580 [
'wl_namespace',
'wl_title',
'wl_notificationtimestamp' ],
582 $lb->constructSet(
'wl',
$dbr ),
583 'wl_user' =>
$user->getId(),
588 foreach (
$res as $row ) {
589 $timestamps[$row->wl_namespace][$row->wl_title] =
613 if ( $this->readOnlyMode->isReadOnly() ) {
617 if (
$user->isAnon() ) {
627 foreach ( $targets
as $target ) {
629 'wl_user' =>
$user->getId(),
630 'wl_namespace' => $target->getNamespace(),
631 'wl_title' => $target->getDBkey(),
632 'wl_notificationtimestamp' =>
null,
643 foreach ( array_chunk(
$rows, 100 )
as $toInsert ) {
646 $dbw->insert(
'watchlist', $toInsert, __METHOD__,
'IGNORE' );
651 foreach ( $items
as $item ) {
652 $this->
cache( $item );
671 if ( $this->readOnlyMode->isReadOnly() ||
$user->isAnon() ) {
678 $dbw->delete(
'watchlist',
680 'wl_user' =>
$user->getId(),
685 $success = (bool)$dbw->affectedRows();
699 if (
$user->isAnon() ) {
705 $conds = [
'wl_user' =>
$user->getId() ];
708 $conds[] =
$batch->constructSet(
'wl', $dbw );
711 if ( $timestamp !==
null ) {
712 $timestamp = $dbw->timestamp( $timestamp );
717 [
'wl_notificationtimestamp' => $timestamp ],
737 $uids = $dbw->selectFieldValues(
741 'wl_user != ' . intval(
$editor->getId() ),
744 'wl_notificationtimestamp IS NULL',
749 $watchers = array_map(
'intval', $uids );
753 DeferredUpdates::addCallableUpdate(
754 function ()
use ( $timestamp, $watchers, $target,
$fname ) {
758 $factory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
759 $ticket = $factory->getEmptyTransactionTicket( __METHOD__ );
762 foreach ( $watchersChunks
as $watchersChunk ) {
763 $dbw->update(
'watchlist',
765 'wl_notificationtimestamp' => $dbw->timestamp( $timestamp )
767 'wl_user' => $watchersChunk,
772 if ( count( $watchersChunks ) > 1 ) {
773 $factory->commitAndWaitForReplication(
774 __METHOD__, $ticket, [
'domain' => $dbw->getDomainID() ]
780 DeferredUpdates::POSTSEND,
802 if ( $this->readOnlyMode->isReadOnly() ||
$user->isAnon() ) {
807 if ( $force !=
'force' ) {
809 if ( !$item || $item->getNotificationTimestamp() ===
null ) {
818 'type' =>
'updateWatchlistNotification',
819 'userid' =>
$user->getId(),
820 'notifTime' => $this->getNotificationTimestamp(
$user,
$title, $item, $force, $oldid ),
828 $this->deferredUpdatesAddCallableUpdateCallback,
845 if ( !
$title->getNextRevisionID( $oldid ) ) {
850 if ( $item ===
null ) {
862 $notificationTimestamp = call_user_func(
863 $this->revisionGetTimestampFromIdCallback,
871 $ts->timestamp->add(
new DateInterval(
'PT1S' ) );
872 $notificationTimestamp = $ts->getTimestamp( TS_MW );
875 if ( $force !=
'force' ) {
879 return $item->getNotificationTimestamp();
883 return $notificationTimestamp;
895 if ( $unreadLimit !==
null ) {
896 $unreadLimit = (int)$unreadLimit;
897 $queryOptions[
'LIMIT'] = $unreadLimit;
901 $rowCount =
$dbr->selectRowCount(
905 'wl_user' =>
$user->getId(),
906 'wl_notificationtimestamp IS NOT NULL',
912 if ( !isset( $unreadLimit ) ) {
916 if ( $rowCount >= $unreadLimit ) {
933 $oldTarget = Title::newFromLinkTarget( $oldTarget );
934 $newTarget = Title::newFromLinkTarget( $newTarget );
936 $this->
duplicateEntry( $oldTarget->getSubjectPage(), $newTarget->getSubjectPage() );
937 $this->
duplicateEntry( $oldTarget->getTalkPage(), $newTarget->getTalkPage() );
955 [
'wl_user',
'wl_notificationtimestamp' ],
958 'wl_title' => $oldTarget->
getDBkey(),
967 # Construct array to replace into the watchlist
971 'wl_user' => $row->wl_user,
972 'wl_namespace' => $newNamespace,
973 'wl_title' => $newDBkey,
974 'wl_notificationtimestamp' => $row->wl_notificationtimestamp,
978 if ( !empty( $values ) ) {
980 # Note that multi-row replace is very efficient for MySQL but may be inefficient for
981 # some other DBMSes, mostly due to poor simulation by us
984 [ [
'wl_user',
'wl_namespace',
'wl_title' ] ],
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
$wgUpdateRowsPerQuery
Number of rows to update per query.
wfTimestampOrNull( $outputtype=TS_UNIX, $ts=null)
Return a formatted timestamp, or null if input is null.
if(!defined( 'MEDIAWIKI')) $fname
This file is not a valid entry point, perform no further processing unless MEDIAWIKI is defined.
Job for updating user activity like "last viewed" timestamps.
Simple store for keeping values in an associative array for the current process.
Class representing a list of titles The execute() method checks them all for existence and adds them ...
Library for creating and parsing MW-style timestamps.
A service class for fetching the wiki's current read-only mode.
Represents a page (or page fragment) title within MediaWiki.
Represents a title within MediaWiki.
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Storage layer class for WatchedItems.
getCacheKey(User $user, LinkTarget $target)
countWatchedItems(User $user)
Count the number of individual items that are watched by the user.
uncacheLinkTarget(LinkTarget $target)
callable null $deferredUpdatesAddCallableUpdateCallback
loadWatchedItem(User $user, LinkTarget $target)
Loads an item from the db.
duplicateEntry(LinkTarget $oldTarget, LinkTarget $newTarget)
Check if the given title already is watched by the user, and if so add a watch for the new title.
duplicateAllAssociatedEntries(LinkTarget $oldTarget, LinkTarget $newTarget)
Check if the given title already is watched by the user, and if so add a watch for the new title.
setNotificationTimestampsForUser(User $user, $timestamp, array $targets=[])
countVisitingWatchersMultiple(array $targetsWithVisitThresholds, $minimumWatchers=null)
Number of watchers of each page who have visited recent edits to that page.
countUnreadNotifications(User $user, $unreadLimit=null)
ReadOnlyMode $readOnlyMode
updateNotificationTimestamp(User $editor, LinkTarget $target, $timestamp)
getNotificationTimestamp(User $user, Title $title, $item, $force, $oldid)
uncache(User $user, LinkTarget $target)
countVisitingWatchers(LinkTarget $target, $threshold)
Number of page watchers who also visited a "recent" edit.
setStatsdDataFactory(StatsdDataFactoryInterface $stats)
Sets a StatsdDataFactory instance on the object.
addWatchBatchForUser(User $user, array $targets)
getWatchedItemsForUser(User $user, array $options=[])
dbCond(User $user, LinkTarget $target)
Return an array of conditions to select or update the appropriate database row.
__construct(LoadBalancer $loadBalancer, HashBagOStuff $cache, ReadOnlyMode $readOnlyMode)
callable null $revisionGetTimestampFromIdCallback
getConnectionRef( $dbIndex)
countWatchers(LinkTarget $target)
overrideRevisionGetTimestampFromIdCallback(callable $callback)
Overrides the Revision::getTimestampFromId callback This is intended for use while testing and will f...
resetNotificationTimestamp(User $user, Title $title, $force='', $oldid=0)
Reset the notification timestamp of this entry.
addWatch(User $user, LinkTarget $target)
Must be called separately for Subject & Talk namespaces.
countWatchersMultiple(array $targets, array $options=[])
isWatched(User $user, LinkTarget $target)
Must be called separately for Subject & Talk namespaces.
StatsdDataFactoryInterface $stats
getNotificationTimestampsBatch(User $user, array $targets)
getWatchedItem(User $user, LinkTarget $target)
Get an item (may be cached)
getVisitingWatchersCondition(IDatabase $db, array $targetsWithVisitThresholds)
Generates condition for the query used in a batch count visiting watchers.
removeWatch(User $user, LinkTarget $target)
Removes the an entry for the User watching the LinkTarget Must be called separately for Subject & Tal...
getCached(User $user, LinkTarget $target)
LoadBalancer $loadBalancer
overrideDeferredUpdatesAddCallableUpdateCallback(callable $callback)
Overrides the DeferredUpdates::addCallableUpdate callback This is intended for use while testing and ...
array[] $cacheIndex
Looks like $cacheIndex[Namespace ID][Target DB Key][User Id] => 'key' The index is needed so that on ...
Representation of a pair of user and title for watchlist entries.
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
when a variable name is used in a it is silently declared as a new local masking the global
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
the array() calling protocol came about after MediaWiki 1.4rc1.
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. '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 '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. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) '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 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) '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! 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
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
passed in as a query string parameter to the various URLs constructed here(i.e. $prevlink) $ldel you ll need to handle error etc yourself modifying $error and returning true will cause the contents of $error to be echoed at the top of the edit form as wikitext Return true without altering $error to allow the edit to proceed & $editor
namespace and then decline to actually register it file or subcat img or subcat $title
processing should stop and the error should be shown to the user * false
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
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
Describes a Statsd aware interface.
you have access to all of the normal MediaWiki so you can get a DB use the cache
if(count( $args)< 1) $job