MediaWiki  REL1_31
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 
41  public static function singleton() {
42  return MediaWikiServices::getInstance()->getGenderCache();
43  }
44 
49  protected function getDefault() {
50  if ( $this->default === null ) {
51  $this->default = User::getDefaultOption( 'gender' );
52  }
53 
54  return $this->default;
55  }
56 
63  public function getGenderOf( $username, $caller = '' ) {
65 
66  if ( $username instanceof User ) {
67  $username = $username->getName();
68  }
69 
71  if ( !isset( $this->cache[$username] ) ) {
72  if ( $this->misses >= $this->missLimit && $wgUser->getName() !== $username ) {
73  if ( $this->misses === $this->missLimit ) {
74  $this->misses++;
75  wfDebug( __METHOD__ . ": too many misses, returning default onwards\n" );
76  }
77 
78  return $this->getDefault();
79  } else {
80  $this->misses++;
81  $this->doQuery( $username, $caller );
82  }
83  }
84 
85  /* Undefined if there is a valid username which for some reason doesn't
86  * exist in the database.
87  */
88  return isset( $this->cache[$username] ) ? $this->cache[$username] : $this->getDefault();
89  }
90 
97  public function doLinkBatch( $data, $caller = '' ) {
98  $users = [];
99  foreach ( $data as $ns => $pagenames ) {
100  if ( !MWNamespace::hasGenderDistinction( $ns ) ) {
101  continue;
102  }
103  foreach ( array_keys( $pagenames ) as $username ) {
104  $users[$username] = true;
105  }
106  }
107 
108  $this->doQuery( array_keys( $users ), $caller );
109  }
110 
118  public function doTitlesArray( $titles, $caller = '' ) {
119  $users = [];
120  foreach ( $titles as $title ) {
121  $titleObj = is_string( $title ) ? Title::newFromText( $title ) : $title;
122  if ( !$titleObj ) {
123  continue;
124  }
125  if ( !MWNamespace::hasGenderDistinction( $titleObj->getNamespace() ) ) {
126  continue;
127  }
128  $users[] = $titleObj->getText();
129  }
130 
131  $this->doQuery( $users, $caller );
132  }
133 
139  public function doQuery( $users, $caller = '' ) {
140  $default = $this->getDefault();
141 
142  $usersToCheck = [];
143  foreach ( (array)$users as $value ) {
145  // Skip users whose gender setting we already know
146  if ( !isset( $this->cache[$name] ) ) {
147  // For existing users, this value will be overwritten by the correct value
148  $this->cache[$name] = $default;
149  // query only for valid names, which can be in the database
150  if ( User::isValidUserName( $name ) ) {
151  $usersToCheck[] = $name;
152  }
153  }
154  }
155 
156  if ( count( $usersToCheck ) === 0 ) {
157  return;
158  }
159 
160  $dbr = wfGetDB( DB_REPLICA );
161  $table = [ 'user', 'user_properties' ];
162  $fields = [ 'user_name', 'up_value' ];
163  $conds = [ 'user_name' => $usersToCheck ];
164  $joins = [ 'user_properties' =>
165  [ 'LEFT JOIN', [ 'user_id = up_user', 'up_property' => 'gender' ] ] ];
166 
167  $comment = __METHOD__;
168  if ( strval( $caller ) !== '' ) {
169  $comment .= "/$caller";
170  }
171  $res = $dbr->select( $table, $fields, $conds, $comment, [], $joins );
172 
173  foreach ( $res as $row ) {
174  $this->cache[$row->user_name] = $row->up_value ? $row->up_value : $default;
175  }
176  }
177 
178  private static function normalizeUsername( $username ) {
179  // Strip off subpages
180  $indexSlash = strpos( $username, '/' );
181  if ( $indexSlash !== false ) {
182  $username = substr( $username, 0, $indexSlash );
183  }
184 
185  // normalize underscore/spaces
186  return strtr( $username, '_', ' ' );
187  }
188 }
User\getDefaultOption
static getDefaultOption( $opt)
Get a given default option value.
Definition: User.php:1762
GenderCache\singleton
static singleton()
Definition: GenderCache.php:41
GenderCache\doLinkBatch
doLinkBatch( $data, $caller='')
Wrapper for doQuery that processes raw LinkBatch data.
Definition: GenderCache.php:97
$wgUser
$wgUser
Definition: Setup.php:902
Title\newFromText
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:273
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
MWNamespace\hasGenderDistinction
static hasGenderDistinction( $index)
Does the namespace (potentially) have different aliases for different genders.
Definition: MWNamespace.php:449
array
the array() calling protocol came about after MediaWiki 1.4rc1.
GenderCache
Caches user genders when needed to use correct namespace aliases.
Definition: GenderCache.php:31
$res
$res
Definition: database.txt:21
User\isValidUserName
static isValidUserName( $name)
Is the input a valid username?
Definition: User.php:969
cache
you have access to all of the normal MediaWiki so you can get a DB use the cache
Definition: maintenance.txt:55
GenderCache\getGenderOf
getGenderOf( $username, $caller='')
Returns the gender for given username.
Definition: GenderCache.php:63
php
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
GenderCache\doTitlesArray
doTitlesArray( $titles, $caller='')
Wrapper for doQuery that processes a title or string array.
Definition: GenderCache.php:118
$dbr
$dbr
Definition: testCompression.php:50
GenderCache\getDefault
getDefault()
Returns the default gender option in this wiki.
Definition: GenderCache.php:49
GenderCache\$missLimit
$missLimit
Definition: GenderCache.php:35
$titles
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
wfGetDB
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:2812
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:964
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
DB_REPLICA
const DB_REPLICA
Definition: defines.php:25
wfDebug
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:994
GenderCache\normalizeUsername
static normalizeUsername( $username)
Definition: GenderCache.php:178
$value
$value
Definition: styleTest.css.php:45
GenderCache\$cache
$cache
Definition: GenderCache.php:32
GenderCache\doQuery
doQuery( $users, $caller='')
Preloads genders for given list of users.
Definition: GenderCache.php:139
GenderCache\$default
$default
Definition: GenderCache.php:33
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
as
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:22
$username
this hook is for auditing only or null if authentication failed before getting that far $username
Definition: hooks.txt:785
GenderCache\$misses
$misses
Definition: GenderCache.php:34
MediaWikiServices
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:25
User
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition: User.php:53