MediaWiki  master
GenderCache.php
Go to the documentation of this file.
1 <?php
25 
31 class GenderCache {
32  protected $cache = [];
33  protected $default;
34  protected $misses = 0;
35  protected $missLimit = 1000;
36 
38  private $nsInfo;
39 
40  public function __construct( NamespaceInfo $nsInfo = null ) {
41  $this->nsInfo = $nsInfo ?? MediaWikiServices::getInstance()->getNamespaceInfo();
42  }
43 
48  public static function singleton() {
49  return MediaWikiServices::getInstance()->getGenderCache();
50  }
51 
56  protected function getDefault() {
57  if ( $this->default === null ) {
58  $this->default = User::getDefaultOption( 'gender' );
59  }
60 
61  return $this->default;
62  }
63 
70  public function getGenderOf( $username, $caller = '' ) {
71  global $wgUser;
72 
73  if ( $username instanceof User ) {
74  $username = $username->getName();
75  }
76 
77  $username = self::normalizeUsername( $username );
78  if ( !isset( $this->cache[$username] ) ) {
79  if ( $this->misses >= $this->missLimit && $wgUser->getName() !== $username ) {
80  if ( $this->misses === $this->missLimit ) {
81  $this->misses++;
82  wfDebug( __METHOD__ . ": too many misses, returning default onwards\n" );
83  }
84 
85  return $this->getDefault();
86  } else {
87  $this->misses++;
88  $this->doQuery( $username, $caller );
89  }
90  }
91 
92  /* Undefined if there is a valid username which for some reason doesn't
93  * exist in the database.
94  */
95  return $this->cache[$username] ?? $this->getDefault();
96  }
97 
104  public function doLinkBatch( $data, $caller = '' ) {
105  $users = [];
106  foreach ( $data as $ns => $pagenames ) {
107  if ( !$this->nsInfo->hasGenderDistinction( $ns ) ) {
108  continue;
109  }
110  foreach ( array_keys( $pagenames ) as $username ) {
111  $users[$username] = true;
112  }
113  }
114 
115  $this->doQuery( array_keys( $users ), $caller );
116  }
117 
125  public function doTitlesArray( $titles, $caller = '' ) {
126  $users = [];
127  foreach ( $titles as $title ) {
128  $titleObj = is_string( $title ) ? Title::newFromText( $title ) : $title;
129  if ( !$titleObj ) {
130  continue;
131  }
132  if ( !$this->nsInfo->hasGenderDistinction( $titleObj->getNamespace() ) ) {
133  continue;
134  }
135  $users[] = $titleObj->getText();
136  }
137 
138  $this->doQuery( $users, $caller );
139  }
140 
146  public function doQuery( $users, $caller = '' ) {
147  $default = $this->getDefault();
148 
149  $usersToCheck = [];
150  foreach ( (array)$users as $value ) {
151  $name = self::normalizeUsername( $value );
152  // Skip users whose gender setting we already know
153  if ( !isset( $this->cache[$name] ) ) {
154  // For existing users, this value will be overwritten by the correct value
155  $this->cache[$name] = $default;
156  // query only for valid names, which can be in the database
157  if ( User::isValidUserName( $name ) ) {
158  $usersToCheck[] = $name;
159  }
160  }
161  }
162 
163  if ( count( $usersToCheck ) === 0 ) {
164  return;
165  }
166 
167  $dbr = wfGetDB( DB_REPLICA );
168  $table = [ 'user', 'user_properties' ];
169  $fields = [ 'user_name', 'up_value' ];
170  $conds = [ 'user_name' => $usersToCheck ];
171  $joins = [ 'user_properties' =>
172  [ 'LEFT JOIN', [ 'user_id = up_user', 'up_property' => 'gender' ] ] ];
173 
174  $comment = __METHOD__;
175  if ( strval( $caller ) !== '' ) {
176  $comment .= "/$caller";
177  }
178  $res = $dbr->select( $table, $fields, $conds, $comment, [], $joins );
179 
180  foreach ( $res as $row ) {
181  $this->cache[$row->user_name] = $row->up_value ?: $default;
182  }
183  }
184 
185  private static function normalizeUsername( $username ) {
186  // Strip off subpages
187  $indexSlash = strpos( $username, '/' );
188  if ( $indexSlash !== false ) {
189  $username = substr( $username, 0, $indexSlash );
190  }
191 
192  // normalize underscore/spaces
193  return strtr( $username, '_', ' ' );
194  }
195 }
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))
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
static singleton()
Definition: GenderCache.php:48
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
doLinkBatch( $data, $caller='')
Wrapper for doQuery that processes raw LinkBatch data.
$value
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 MediaWikiServices
Definition: injection.txt:23
doTitlesArray( $titles, $caller='')
Wrapper for doQuery that processes a title or string array.
getDefault()
Returns the default gender option in this wiki.
Definition: GenderCache.php:56
The User object encapsulates all of the user-specific settings (user_id, name, rights, email address, options, last login time).
Definition: User.php:51
getGenderOf( $username, $caller='')
Returns the gender for given username.
Definition: GenderCache.php:70
you have access to all of the normal MediaWiki so you can get a DB use the cache
Definition: maintenance.txt:52
static normalizeUsername( $username)
$res
Definition: database.txt:21
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
doQuery( $users, $caller='')
Preloads genders for given list of users.
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
Definition: hooks.txt:780
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:925
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
NamespaceInfo $nsInfo
Definition: GenderCache.php:38
static getDefaultOption( $opt)
Get a given default option value.
Definition: User.php:1792
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
this hook is for auditing only or null if authentication failed before getting that far $username
Definition: hooks.txt:780
static isValidUserName( $name)
Is the input a valid username?
Definition: User.php:1011
linkcache txt The LinkCache class maintains a list of article titles and the information about whether or not the article exists in the database This is used to mark up links when displaying a page If the same link appears more than once on any page then it only has to be looked up once In most cases link lookups are done in batches with the LinkBatch class or the equivalent in so the link cache is mostly useful for short snippets of parsed and for links in the navigation areas of the skin The link cache was formerly used to track links used in a document for the purposes of updating the link tables This application is now deprecated To create a you can use the following $titles
Definition: linkcache.txt:17
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
const DB_REPLICA
Definition: defines.php:25
__construct(NamespaceInfo $nsInfo=null)
Definition: GenderCache.php:40
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:319