MediaWiki REL1_32
GenderCache.php
Go to the documentation of this file.
1<?php
25
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 = '' ) {
64 global $wgUser;
65
66 if ( $username instanceof User ) {
67 $username = $username->getName();
68 }
69
70 $username = self::normalizeUsername( $username );
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 $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 ) {
144 $name = self::normalizeUsername( $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
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 ?: $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}
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
Caches user genders when needed to use correct namespace aliases.
static singleton()
getGenderOf( $username, $caller='')
Returns the gender for given username.
static normalizeUsername( $username)
doLinkBatch( $data, $caller='')
Wrapper for doQuery that processes raw LinkBatch data.
getDefault()
Returns the default gender option in this wiki.
doTitlesArray( $titles, $caller='')
Wrapper for doQuery that processes a title or string array.
doQuery( $users, $caller='')
Preloads genders for given list of users.
MediaWikiServices is the service locator for the application scope of MediaWiki.
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition User.php:47
static getDefaultOption( $opt)
Get a given default option value.
Definition User.php:1818
static isValidUserName( $name)
Is the input a valid username?
Definition User.php:997
$res
Definition database.txt:21
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
namespace and then decline to actually register it file or subcat img or subcat $title
Definition hooks.txt:994
Allows to change the fields on the form that will be generated $name
Definition hooks.txt:302
this hook is for auditing only or null if authentication failed before getting that far $username
Definition hooks.txt:815
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
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
you have access to all of the normal MediaWiki so you can get a DB use the cache
$cache
Definition mcc.php:33
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))
const DB_REPLICA
Definition defines.php:25