MediaWiki REL1_28
WatchedItemStore.php
Go to the documentation of this file.
1<?php
2
3use Liuggio\StatsdClient\Factory\StatsdDataFactoryInterface;
5use Wikimedia\Assert\Assert;
6use Wikimedia\ScopedCallback;
7
17
18 const SORT_DESC = 'DESC';
19 const SORT_ASC = 'ASC';
20
25
29 private $cache;
30
37 private $cacheIndex = [];
38
43
48
52 private $stats;
53
58 public function __construct(
59 LoadBalancer $loadBalancer,
61 ) {
62 $this->loadBalancer = $loadBalancer;
63 $this->cache = $cache;
64 $this->stats = new NullStatsdDataFactory();
65 $this->deferredUpdatesAddCallableUpdateCallback = [ 'DeferredUpdates', 'addCallableUpdate' ];
66 $this->revisionGetTimestampFromIdCallback = [ 'Revision', 'getTimestampFromId' ];
67 }
68
69 public function setStatsdDataFactory( StatsdDataFactoryInterface $stats ) {
70 $this->stats = $stats;
71 }
72
84 public function overrideDeferredUpdatesAddCallableUpdateCallback( callable $callback ) {
85 if ( !defined( 'MW_PHPUNIT_TEST' ) ) {
86 throw new MWException(
87 'Cannot override DeferredUpdates::addCallableUpdate callback in operation.'
88 );
89 }
90 $previousValue = $this->deferredUpdatesAddCallableUpdateCallback;
91 $this->deferredUpdatesAddCallableUpdateCallback = $callback;
92 return new ScopedCallback( function() use ( $previousValue ) {
93 $this->deferredUpdatesAddCallableUpdateCallback = $previousValue;
94 } );
95 }
96
107 public function overrideRevisionGetTimestampFromIdCallback( callable $callback ) {
108 if ( !defined( 'MW_PHPUNIT_TEST' ) ) {
109 throw new MWException(
110 'Cannot override Revision::getTimestampFromId callback in operation.'
111 );
112 }
113 $previousValue = $this->revisionGetTimestampFromIdCallback;
114 $this->revisionGetTimestampFromIdCallback = $callback;
115 return new ScopedCallback( function() use ( $previousValue ) {
116 $this->revisionGetTimestampFromIdCallback = $previousValue;
117 } );
118 }
119
120 private function getCacheKey( User $user, LinkTarget $target ) {
121 return $this->cache->makeKey(
122 (string)$target->getNamespace(),
123 $target->getDBkey(),
124 (string)$user->getId()
125 );
126 }
127
128 private function cache( WatchedItem $item ) {
129 $user = $item->getUser();
130 $target = $item->getLinkTarget();
131 $key = $this->getCacheKey( $user, $target );
132 $this->cache->set( $key, $item );
133 $this->cacheIndex[$target->getNamespace()][$target->getDBkey()][$user->getId()] = $key;
134 $this->stats->increment( 'WatchedItemStore.cache' );
135 }
136
137 private function uncache( User $user, LinkTarget $target ) {
138 $this->cache->delete( $this->getCacheKey( $user, $target ) );
139 unset( $this->cacheIndex[$target->getNamespace()][$target->getDBkey()][$user->getId()] );
140 $this->stats->increment( 'WatchedItemStore.uncache' );
141 }
142
143 private function uncacheLinkTarget( LinkTarget $target ) {
144 $this->stats->increment( 'WatchedItemStore.uncacheLinkTarget' );
145 if ( !isset( $this->cacheIndex[$target->getNamespace()][$target->getDBkey()] ) ) {
146 return;
147 }
148 foreach ( $this->cacheIndex[$target->getNamespace()][$target->getDBkey()] as $key ) {
149 $this->stats->increment( 'WatchedItemStore.uncacheLinkTarget.items' );
150 $this->cache->delete( $key );
151 }
152 }
153
154 private function uncacheUser( User $user ) {
155 $this->stats->increment( 'WatchedItemStore.uncacheUser' );
156 foreach ( $this->cacheIndex as $ns => $dbKeyArray ) {
157 foreach ( $dbKeyArray as $dbKey => $userArray ) {
158 if ( isset( $userArray[$user->getId()] ) ) {
159 $this->stats->increment( 'WatchedItemStore.uncacheUser.items' );
160 $this->cache->delete( $userArray[$user->getId()] );
161 }
162 }
163 }
164 }
165
172 private function getCached( User $user, LinkTarget $target ) {
173 return $this->cache->get( $this->getCacheKey( $user, $target ) );
174 }
175
185 private function dbCond( User $user, LinkTarget $target ) {
186 return [
187 'wl_user' => $user->getId(),
188 'wl_namespace' => $target->getNamespace(),
189 'wl_title' => $target->getDBkey(),
190 ];
191 }
192
199 private function getConnectionRef( $dbIndex ) {
200 return $this->loadBalancer->getConnectionRef( $dbIndex, [ 'watchlist' ] );
201 }
202
211 public function countWatchedItems( User $user ) {
212 $dbr = $this->getConnectionRef( DB_REPLICA );
213 $return = (int)$dbr->selectField(
214 'watchlist',
215 'COUNT(*)',
216 [
217 'wl_user' => $user->getId()
218 ],
219 __METHOD__
220 );
221
222 return $return;
223 }
224
230 public function countWatchers( LinkTarget $target ) {
231 $dbr = $this->getConnectionRef( DB_REPLICA );
232 $return = (int)$dbr->selectField(
233 'watchlist',
234 'COUNT(*)',
235 [
236 'wl_namespace' => $target->getNamespace(),
237 'wl_title' => $target->getDBkey(),
238 ],
239 __METHOD__
240 );
241
242 return $return;
243 }
244
255 public function countVisitingWatchers( LinkTarget $target, $threshold ) {
256 $dbr = $this->getConnectionRef( DB_REPLICA );
257 $visitingWatchers = (int)$dbr->selectField(
258 'watchlist',
259 'COUNT(*)',
260 [
261 'wl_namespace' => $target->getNamespace(),
262 'wl_title' => $target->getDBkey(),
263 'wl_notificationtimestamp >= ' .
264 $dbr->addQuotes( $dbr->timestamp( $threshold ) ) .
265 ' OR wl_notificationtimestamp IS NULL'
266 ],
267 __METHOD__
268 );
269
270 return $visitingWatchers;
271 }
272
282 public function countWatchersMultiple( array $targets, array $options = [] ) {
283 $dbOptions = [ 'GROUP BY' => [ 'wl_namespace', 'wl_title' ] ];
284
285 $dbr = $this->getConnectionRef( DB_REPLICA );
286
287 if ( array_key_exists( 'minimumWatchers', $options ) ) {
288 $dbOptions['HAVING'] = 'COUNT(*) >= ' . (int)$options['minimumWatchers'];
289 }
290
291 $lb = new LinkBatch( $targets );
292 $res = $dbr->select(
293 'watchlist',
294 [ 'wl_title', 'wl_namespace', 'watchers' => 'COUNT(*)' ],
295 [ $lb->constructSet( 'wl', $dbr ) ],
296 __METHOD__,
297 $dbOptions
298 );
299
300 $watchCounts = [];
301 foreach ( $targets as $linkTarget ) {
302 $watchCounts[$linkTarget->getNamespace()][$linkTarget->getDBkey()] = 0;
303 }
304
305 foreach ( $res as $row ) {
306 $watchCounts[$row->wl_namespace][$row->wl_title] = (int)$row->watchers;
307 }
308
309 return $watchCounts;
310 }
311
328 array $targetsWithVisitThresholds,
329 $minimumWatchers = null
330 ) {
331 $dbr = $this->getConnectionRef( DB_REPLICA );
332
333 $conds = $this->getVisitingWatchersCondition( $dbr, $targetsWithVisitThresholds );
334
335 $dbOptions = [ 'GROUP BY' => [ 'wl_namespace', 'wl_title' ] ];
336 if ( $minimumWatchers !== null ) {
337 $dbOptions['HAVING'] = 'COUNT(*) >= ' . (int)$minimumWatchers;
338 }
339 $res = $dbr->select(
340 'watchlist',
341 [ 'wl_namespace', 'wl_title', 'watchers' => 'COUNT(*)' ],
342 $conds,
343 __METHOD__,
344 $dbOptions
345 );
346
347 $watcherCounts = [];
348 foreach ( $targetsWithVisitThresholds as list( $target ) ) {
349 /* @var LinkTarget $target */
350 $watcherCounts[$target->getNamespace()][$target->getDBkey()] = 0;
351 }
352
353 foreach ( $res as $row ) {
354 $watcherCounts[$row->wl_namespace][$row->wl_title] = (int)$row->watchers;
355 }
356
357 return $watcherCounts;
358 }
359
368 IDatabase $db,
369 array $targetsWithVisitThresholds
370 ) {
371 $missingTargets = [];
372 $namespaceConds = [];
373 foreach ( $targetsWithVisitThresholds as list( $target, $threshold ) ) {
374 if ( $threshold === null ) {
375 $missingTargets[] = $target;
376 continue;
377 }
378 /* @var LinkTarget $target */
379 $namespaceConds[$target->getNamespace()][] = $db->makeList( [
380 'wl_title = ' . $db->addQuotes( $target->getDBkey() ),
381 $db->makeList( [
382 'wl_notificationtimestamp >= ' . $db->addQuotes( $db->timestamp( $threshold ) ),
383 'wl_notificationtimestamp IS NULL'
384 ], LIST_OR )
385 ], LIST_AND );
386 }
387
388 $conds = [];
389 foreach ( $namespaceConds as $namespace => $pageConds ) {
390 $conds[] = $db->makeList( [
391 'wl_namespace = ' . $namespace,
392 '(' . $db->makeList( $pageConds, LIST_OR ) . ')'
393 ], LIST_AND );
394 }
395
396 if ( $missingTargets ) {
397 $lb = new LinkBatch( $missingTargets );
398 $conds[] = $lb->constructSet( 'wl', $db );
399 }
400
401 return $db->makeList( $conds, LIST_OR );
402 }
403
412 public function getWatchedItem( User $user, LinkTarget $target ) {
413 if ( $user->isAnon() ) {
414 return false;
415 }
416
417 $cached = $this->getCached( $user, $target );
418 if ( $cached ) {
419 $this->stats->increment( 'WatchedItemStore.getWatchedItem.cached' );
420 return $cached;
421 }
422 $this->stats->increment( 'WatchedItemStore.getWatchedItem.load' );
423 return $this->loadWatchedItem( $user, $target );
424 }
425
434 public function loadWatchedItem( User $user, LinkTarget $target ) {
435 // Only loggedin user can have a watchlist
436 if ( $user->isAnon() ) {
437 return false;
438 }
439
440 $dbr = $this->getConnectionRef( DB_REPLICA );
441 $row = $dbr->selectRow(
442 'watchlist',
443 'wl_notificationtimestamp',
444 $this->dbCond( $user, $target ),
445 __METHOD__
446 );
447
448 if ( !$row ) {
449 return false;
450 }
451
452 $item = new WatchedItem(
453 $user,
454 $target,
455 $row->wl_notificationtimestamp
456 );
457 $this->cache( $item );
458
459 return $item;
460 }
461
471 public function getWatchedItemsForUser( User $user, array $options = [] ) {
472 $options += [ 'forWrite' => false ];
473
474 $dbOptions = [];
475 if ( array_key_exists( 'sort', $options ) ) {
476 Assert::parameter(
477 ( in_array( $options['sort'], [ self::SORT_ASC, self::SORT_DESC ] ) ),
478 '$options[\'sort\']',
479 'must be SORT_ASC or SORT_DESC'
480 );
481 $dbOptions['ORDER BY'] = [
482 "wl_namespace {$options['sort']}",
483 "wl_title {$options['sort']}"
484 ];
485 }
486 $db = $this->getConnectionRef( $options['forWrite'] ? DB_MASTER : DB_REPLICA );
487
488 $res = $db->select(
489 'watchlist',
490 [ 'wl_namespace', 'wl_title', 'wl_notificationtimestamp' ],
491 [ 'wl_user' => $user->getId() ],
492 __METHOD__,
493 $dbOptions
494 );
495
496 $watchedItems = [];
497 foreach ( $res as $row ) {
498 // todo these could all be cached at some point?
499 $watchedItems[] = new WatchedItem(
500 $user,
501 new TitleValue( (int)$row->wl_namespace, $row->wl_title ),
502 $row->wl_notificationtimestamp
503 );
504 }
505
506 return $watchedItems;
507 }
508
517 public function isWatched( User $user, LinkTarget $target ) {
518 return (bool)$this->getWatchedItem( $user, $target );
519 }
520
530 public function getNotificationTimestampsBatch( User $user, array $targets ) {
531 $timestamps = [];
532 foreach ( $targets as $target ) {
533 $timestamps[$target->getNamespace()][$target->getDBkey()] = false;
534 }
535
536 if ( $user->isAnon() ) {
537 return $timestamps;
538 }
539
540 $targetsToLoad = [];
541 foreach ( $targets as $target ) {
542 $cachedItem = $this->getCached( $user, $target );
543 if ( $cachedItem ) {
544 $timestamps[$target->getNamespace()][$target->getDBkey()] =
545 $cachedItem->getNotificationTimestamp();
546 } else {
547 $targetsToLoad[] = $target;
548 }
549 }
550
551 if ( !$targetsToLoad ) {
552 return $timestamps;
553 }
554
555 $dbr = $this->getConnectionRef( DB_REPLICA );
556
557 $lb = new LinkBatch( $targetsToLoad );
558 $res = $dbr->select(
559 'watchlist',
560 [ 'wl_namespace', 'wl_title', 'wl_notificationtimestamp' ],
561 [
562 $lb->constructSet( 'wl', $dbr ),
563 'wl_user' => $user->getId(),
564 ],
565 __METHOD__
566 );
567
568 foreach ( $res as $row ) {
569 $timestamps[$row->wl_namespace][$row->wl_title] = $row->wl_notificationtimestamp;
570 }
571
572 return $timestamps;
573 }
574
581 public function addWatch( User $user, LinkTarget $target ) {
582 $this->addWatchBatchForUser( $user, [ $target ] );
583 }
584
591 public function addWatchBatchForUser( User $user, array $targets ) {
592 if ( $this->loadBalancer->getReadOnlyReason() !== false ) {
593 return false;
594 }
595 // Only loggedin user can have a watchlist
596 if ( $user->isAnon() ) {
597 return false;
598 }
599
600 if ( !$targets ) {
601 return true;
602 }
603
604 $rows = [];
605 foreach ( $targets as $target ) {
606 $rows[] = [
607 'wl_user' => $user->getId(),
608 'wl_namespace' => $target->getNamespace(),
609 'wl_title' => $target->getDBkey(),
610 'wl_notificationtimestamp' => null,
611 ];
612 $this->uncache( $user, $target );
613 }
614
615 $dbw = $this->getConnectionRef( DB_MASTER );
616 foreach ( array_chunk( $rows, 100 ) as $toInsert ) {
617 // Use INSERT IGNORE to avoid overwriting the notification timestamp
618 // if there's already an entry for this page
619 $dbw->insert( 'watchlist', $toInsert, __METHOD__, 'IGNORE' );
620 }
621
622 return true;
623 }
624
636 public function removeWatch( User $user, LinkTarget $target ) {
637 // Only logged in user can have a watchlist
638 if ( $this->loadBalancer->getReadOnlyReason() !== false || $user->isAnon() ) {
639 return false;
640 }
641
642 $this->uncache( $user, $target );
643
644 $dbw = $this->getConnectionRef( DB_MASTER );
645 $dbw->delete( 'watchlist',
646 [
647 'wl_user' => $user->getId(),
648 'wl_namespace' => $target->getNamespace(),
649 'wl_title' => $target->getDBkey(),
650 ], __METHOD__
651 );
652 $success = (bool)$dbw->affectedRows();
653
654 return $success;
655 }
656
664 public function setNotificationTimestampsForUser( User $user, $timestamp, array $targets = [] ) {
665 // Only loggedin user can have a watchlist
666 if ( $user->isAnon() ) {
667 return false;
668 }
669
670 $dbw = $this->getConnectionRef( DB_MASTER );
671
672 $conds = [ 'wl_user' => $user->getId() ];
673 if ( $targets ) {
674 $batch = new LinkBatch( $targets );
675 $conds[] = $batch->constructSet( 'wl', $dbw );
676 }
677
678 $success = $dbw->update(
679 'watchlist',
680 [ 'wl_notificationtimestamp' => $dbw->timestamp( $timestamp ) ],
681 $conds,
682 __METHOD__
683 );
684
685 $this->uncacheUser( $user );
686
687 return $success;
688 }
689
699 $dbw = $this->getConnectionRef( DB_MASTER );
700 $uids = $dbw->selectFieldValues(
701 'watchlist',
702 'wl_user',
703 [
704 'wl_user != ' . intval( $editor->getId() ),
705 'wl_namespace' => $target->getNamespace(),
706 'wl_title' => $target->getDBkey(),
707 'wl_notificationtimestamp IS NULL',
708 ],
709 __METHOD__
710 );
711
712 $watchers = array_map( 'intval', $uids );
713 if ( $watchers ) {
714 // Update wl_notificationtimestamp for all watching users except the editor
715 $fname = __METHOD__;
716 DeferredUpdates::addCallableUpdate(
717 function () use ( $timestamp, $watchers, $target, $fname ) {
719
720 $dbw = $this->getConnectionRef( DB_MASTER );
721 $factory = wfGetLBFactory();
722 $ticket = $factory->getEmptyTransactionTicket( __METHOD__ );
723
724 $watchersChunks = array_chunk( $watchers, $wgUpdateRowsPerQuery );
725 foreach ( $watchersChunks as $watchersChunk ) {
726 $dbw->update( 'watchlist',
727 [ /* SET */
728 'wl_notificationtimestamp' => $dbw->timestamp( $timestamp )
729 ], [ /* WHERE - TODO Use wl_id T130067 */
730 'wl_user' => $watchersChunk,
731 'wl_namespace' => $target->getNamespace(),
732 'wl_title' => $target->getDBkey(),
733 ], $fname
734 );
735 if ( count( $watchersChunks ) > 1 ) {
736 $factory->commitAndWaitForReplication(
737 __METHOD__, $ticket, [ 'wiki' => $dbw->getWikiID() ]
738 );
739 }
740 }
741 $this->uncacheLinkTarget( $target );
742 },
743 DeferredUpdates::POSTSEND,
744 $dbw
745 );
746 }
747
748 return $watchers;
749 }
750
763 public function resetNotificationTimestamp( User $user, Title $title, $force = '', $oldid = 0 ) {
764 // Only loggedin user can have a watchlist
765 if ( $this->loadBalancer->getReadOnlyReason() !== false || $user->isAnon() ) {
766 return false;
767 }
768
769 $item = null;
770 if ( $force != 'force' ) {
771 $item = $this->loadWatchedItem( $user, $title );
772 if ( !$item || $item->getNotificationTimestamp() === null ) {
773 return false;
774 }
775 }
776
777 // If the page is watched by the user (or may be watched), update the timestamp
779 $title,
780 [
781 'type' => 'updateWatchlistNotification',
782 'userid' => $user->getId(),
783 'notifTime' => $this->getNotificationTimestamp( $user, $title, $item, $force, $oldid ),
784 'curTime' => time()
785 ]
786 );
787
788 // Try to run this post-send
789 // Calls DeferredUpdates::addCallableUpdate in normal operation
790 call_user_func(
791 $this->deferredUpdatesAddCallableUpdateCallback,
792 function() use ( $job ) {
793 $job->run();
794 }
795 );
796
797 $this->uncache( $user, $title );
798
799 return true;
800 }
801
802 private function getNotificationTimestamp( User $user, Title $title, $item, $force, $oldid ) {
803 if ( !$oldid ) {
804 // No oldid given, assuming latest revision; clear the timestamp.
805 return null;
806 }
807
808 if ( !$title->getNextRevisionID( $oldid ) ) {
809 // Oldid given and is the latest revision for this title; clear the timestamp.
810 return null;
811 }
812
813 if ( $item === null ) {
814 $item = $this->loadWatchedItem( $user, $title );
815 }
816
817 if ( !$item ) {
818 // This can only happen if $force is enabled.
819 return null;
820 }
821
822 // Oldid given and isn't the latest; update the timestamp.
823 // This will result in no further notification emails being sent!
824 // Calls Revision::getTimestampFromId in normal operation
825 $notificationTimestamp = call_user_func(
826 $this->revisionGetTimestampFromIdCallback,
827 $title,
828 $oldid
829 );
830
831 // We need to go one second to the future because of various strict comparisons
832 // throughout the codebase
833 $ts = new MWTimestamp( $notificationTimestamp );
834 $ts->timestamp->add( new DateInterval( 'PT1S' ) );
835 $notificationTimestamp = $ts->getTimestamp( TS_MW );
836
837 if ( $notificationTimestamp < $item->getNotificationTimestamp() ) {
838 if ( $force != 'force' ) {
839 return false;
840 } else {
841 // This is a little silly…
842 return $item->getNotificationTimestamp();
843 }
844 }
845
846 return $notificationTimestamp;
847 }
848
856 public function countUnreadNotifications( User $user, $unreadLimit = null ) {
857 $queryOptions = [];
858 if ( $unreadLimit !== null ) {
859 $unreadLimit = (int)$unreadLimit;
860 $queryOptions['LIMIT'] = $unreadLimit;
861 }
862
863 $dbr = $this->getConnectionRef( DB_REPLICA );
864 $rowCount = $dbr->selectRowCount(
865 'watchlist',
866 '1',
867 [
868 'wl_user' => $user->getId(),
869 'wl_notificationtimestamp IS NOT NULL',
870 ],
871 __METHOD__,
872 $queryOptions
873 );
874
875 if ( !isset( $unreadLimit ) ) {
876 return $rowCount;
877 }
878
879 if ( $rowCount >= $unreadLimit ) {
880 return true;
881 }
882
883 return $rowCount;
884 }
885
895 public function duplicateAllAssociatedEntries( LinkTarget $oldTarget, LinkTarget $newTarget ) {
896 $oldTarget = Title::newFromLinkTarget( $oldTarget );
897 $newTarget = Title::newFromLinkTarget( $newTarget );
898
899 $this->duplicateEntry( $oldTarget->getSubjectPage(), $newTarget->getSubjectPage() );
900 $this->duplicateEntry( $oldTarget->getTalkPage(), $newTarget->getTalkPage() );
901 }
902
913 public function duplicateEntry( LinkTarget $oldTarget, LinkTarget $newTarget ) {
914 $dbw = $this->getConnectionRef( DB_MASTER );
915
916 $result = $dbw->select(
917 'watchlist',
918 [ 'wl_user', 'wl_notificationtimestamp' ],
919 [
920 'wl_namespace' => $oldTarget->getNamespace(),
921 'wl_title' => $oldTarget->getDBkey(),
922 ],
923 __METHOD__,
924 [ 'FOR UPDATE' ]
925 );
926
927 $newNamespace = $newTarget->getNamespace();
928 $newDBkey = $newTarget->getDBkey();
929
930 # Construct array to replace into the watchlist
931 $values = [];
932 foreach ( $result as $row ) {
933 $values[] = [
934 'wl_user' => $row->wl_user,
935 'wl_namespace' => $newNamespace,
936 'wl_title' => $newDBkey,
937 'wl_notificationtimestamp' => $row->wl_notificationtimestamp,
938 ];
939 }
940
941 if ( !empty( $values ) ) {
942 # Perform replace
943 # Note that multi-row replace is very efficient for MySQL but may be inefficient for
944 # some other DBMSes, mostly due to poor simulation by us
945 $dbw->replace(
946 'watchlist',
947 [ [ 'wl_user', 'wl_namespace', 'wl_title' ] ],
948 $values,
949 __METHOD__
950 );
951 }
952 }
953
954}
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
$wgUpdateRowsPerQuery
Number of rows to update per query.
wfGetLBFactory()
Get the load balancer factory object.
if(!defined( 'MEDIAWIKI')) $fname
This file is not a valid entry point, perform no further processing unless MEDIAWIKI is defined.
Definition Setup.php:36
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 ...
Definition LinkBatch.php:32
Database connection, tracking, load balancing, and transaction manager for a cluster.
MediaWiki exception.
Library for creating and parsing MW-style timestamps.
Represents a page (or page fragment) title within MediaWiki.
Represents a title within MediaWiki.
Definition Title.php:36
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition User.php:48
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)
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.
HashBagOStuff $cache
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.
cache(WatchedItem $item)
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 ...
__construct(LoadBalancer $loadBalancer, HashBagOStuff $cache)
Representation of a pair of user and title for watchlist entries.
$res
Definition database.txt:21
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
when a variable name is used in a it is silently declared as a new local masking the global
Definition design.txt:95
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
const LIST_OR
Definition Defines.php:38
const LIST_AND
Definition Defines.php:35
the array() calling protocol came about after MediaWiki 1.4rc1.
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
Definition hooks.txt:249
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:Associative array mapping language codes to prefixed links of the form "language:title". & $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
Definition hooks.txt:1937
namespace and then decline to actually register it file or subcat img or subcat $title
Definition hooks.txt:986
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context $options
Definition hooks.txt:1096
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
Definition hooks.txt:1377
processing should stop and the error should be shown to the user * false
Definition hooks.txt:189
if( $limit) $timestamp
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:37
Basic database interface for live and lazy-loaded relation database handles.
Definition IDatabase.php:34
timestamp( $ts=0)
Convert a timestamp in one of the formats accepted by wfTimestamp() to the format used for inserting ...
addQuotes( $s)
Adds quotes and backslashes.
makeList( $a, $mode=self::LIST_COMMA)
Makes an encoded list of strings from an array.
getNamespace()
Get the namespace index.
getDBkey()
Get the main part with underscores.
Describes a Statsd aware interface.
$batch
Definition linkcache.txt:23
you have access to all of the normal MediaWiki so you can get a DB use the cache
$cache
Definition mcc.php:33
const DB_REPLICA
Definition defines.php:22
const DB_MASTER
Definition defines.php:23
if(count( $args)< 1) $job
const TS_MW
MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
Definition defines.php:11