MediaWiki  1.29.1
Go to the documentation of this file.
1 <?php
27 class UserCache {
28  protected $cache = []; // (uid => property => value)
29  protected $typesCached = []; // (uid => cache type => 1)
34  public static function singleton() {
35  static $instance = null;
36  if ( $instance === null ) {
37  $instance = new self();
38  }
40  return $instance;
41  }
43  protected function __construct() {
44  }
53  public function getProp( $userId, $prop ) {
54  if ( !isset( $this->cache[$userId][$prop] ) ) {
55  wfDebug( __METHOD__ . ": querying DB for prop '$prop' for user ID '$userId'.\n" );
56  $this->doQuery( [ $userId ] ); // cache miss
57  }
59  return isset( $this->cache[$userId][$prop] )
60  ? $this->cache[$userId][$prop]
61  : false; // user does not exist?
62  }
72  public function getUserName( $userId, $ip ) {
73  return $userId > 0 ? $this->getProp( $userId, 'name' ) : $ip;
74  }
82  public function doQuery( array $userIds, $options = [], $caller = '' ) {
83  $usersToCheck = [];
84  $usersToQuery = [];
86  $userIds = array_unique( $userIds );
88  foreach ( $userIds as $userId ) {
89  $userId = (int)$userId;
90  if ( $userId <= 0 ) {
91  continue; // skip anons
92  }
93  if ( isset( $this->cache[$userId]['name'] ) ) {
94  $usersToCheck[$userId] = $this->cache[$userId]['name']; // already have name
95  } else {
96  $usersToQuery[] = $userId; // we need to get the name
97  }
98  }
100  // Lookup basic info for users not yet loaded...
101  if ( count( $usersToQuery ) ) {
102  $dbr = wfGetDB( DB_REPLICA );
103  $table = [ 'user' ];
104  $conds = [ 'user_id' => $usersToQuery ];
105  $fields = [ 'user_name', 'user_real_name', 'user_registration', 'user_id' ];
107  $comment = __METHOD__;
108  if ( strval( $caller ) !== '' ) {
109  $comment .= "/$caller";
110  }
112  $res = $dbr->select( $table, $fields, $conds, $comment );
113  foreach ( $res as $row ) { // load each user into cache
114  $userId = (int)$row->user_id;
115  $this->cache[$userId]['name'] = $row->user_name;
116  $this->cache[$userId]['real_name'] = $row->user_real_name;
117  $this->cache[$userId]['registration'] = $row->user_registration;
118  $usersToCheck[$userId] = $row->user_name;
119  }
120  }
122  $lb = new LinkBatch();
123  foreach ( $usersToCheck as $userId => $name ) {
124  if ( $this->queryNeeded( $userId, 'userpage', $options ) ) {
125  $lb->add( NS_USER, $name );
126  $this->typesCached[$userId]['userpage'] = 1;
127  }
128  if ( $this->queryNeeded( $userId, 'usertalk', $options ) ) {
129  $lb->add( NS_USER_TALK, $name );
130  $this->typesCached[$userId]['usertalk'] = 1;
131  }
132  }
133  $lb->execute();
134  }
144  protected function queryNeeded( $uid, $type, array $options ) {
145  return ( in_array( $type, $options ) && !isset( $this->typesCached[$uid][$type] ) );
146  }
147 }
Class representing a list of titles The execute() method checks them all for existence and adds them ...
Definition: LinkBatch.php:34
Definition: UserCache.php:27
queryNeeded( $uid, $type, array $options)
Check if a cache type is in $options and was not loaded for this user.
Definition: UserCache.php:144
Definition: database.txt:21
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:304
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
Definition: hooks.txt:2536
you have access to all of the normal MediaWiki so you can get a DB use the cache
Definition: maintenance.txt:52
Definition: UserCache.php:43
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
getProp( $userId, $prop)
Get a property of a user based on their user ID.
Definition: UserCache.php:53
Definition: UserCache.php:29
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:3060
Definition: defines.php:25
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
Definition: GlobalFunctions.php:999
Definition: Defines.php:65
doQuery(array $userIds, $options=[], $caller='')
Preloads user names for given list of users.
Definition: UserCache.php:82
getUserName( $userId, $ip)
Get the name of a user or return $ip if the user ID is 0.
Definition: UserCache.php:72
Definition: UserCache.php:28
if(! $regexes) $dbr
Definition: cleanup.php:94
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
static singleton()
Definition: UserCache.php:34
const NS_USER
Definition: Defines.php:64
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup 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:1049
the array() calling protocol came about after MediaWiki 1.4rc1.