wiki.techinc.nl/includes/GenderCache.php
2011-02-12 21:05:27 +00:00

119 lines
3 KiB
PHP

<?php
/**
* Caches user genders when needed to use correct namespace aliases.
* @author Niklas Laxström
* @since 1.18
*/
class GenderCache {
protected $cache = array();
protected $default;
protected $misses = 0;
protected $missLimit = 1000;
public static function singleton() {
static $that = null;
if ( $that === null ) {
$that = new self();
}
return $that;
}
protected function __construct() {}
/**
* Returns the default gender option in this wiki.
* @return String
*/
protected function getDefault() {
if ( $this->default === null ) {
$this->default = User::getDefaultOption( 'gender' );
}
return $this->default;
}
/**
* Returns the gender for given username.
* @param $users String: username
* @param $caller String: the calling method
* @return String
*/
public function getGenderOf( $username, $caller = '' ) {
global $wgUser;
$username = strtr( $username, '_', ' ' );
if ( !isset( $this->cache[$username] ) ) {
if ( $this->misses >= $this->missLimit && $wgUser->getName() !== $username ) {
if( $this->misses === $this->missLimit ) {
$this->misses++;
wfDebug( __METHOD__ . ": too many misses, returning default onwards\n" );
}
return $this->getDefault();
} else {
$this->misses++;
if ( !User::isValidUserName( $username ) ) {
$this->cache[$username] = $this->getDefault();
} else {
$this->doQuery( $username, $caller );
}
}
}
/* Undefined if there is a valid username which for some reason doesn't
* exist in the database.
*/
return isset( $this->cache[$username] ) ? $this->cache[$username] : $this->getDefault();
}
/**
* Wrapper for doQuery that processes raw LinkBatch data.
*/
public function doLinkBatch( $data, $caller = '' ) {
$users = array();
foreach ( $data as $ns => $pagenames ) {
if ( !MWNamespace::hasGenderDistinction( $ns ) ) continue;
foreach ( array_keys( $pagenames ) as $username ) {
if ( isset( $this->cache[$username] ) ) continue;
$users[$username] = true;
}
}
$this->doQuery( array_keys( $users ), $caller );
}
/**
* Preloads genders for given list of users.
* @param $users List|String: usernames
* @param $caller String: the calling method
*/
public function doQuery( $users, $caller = '' ) {
if ( count( $users ) === 0 ) return false;
foreach ( (array) $users as $index => $value ) {
$users[$index] = strtr( $value, '_', ' ' );
}
$dbr = wfGetDB( DB_SLAVE );
$table = array( 'user', 'user_properties' );
$fields = array( 'user_name', 'up_value' );
$conds = array( 'user_name' => $users );
$joins = array( 'user_properties' =>
array( 'LEFT JOIN', array( 'user_id = up_user', 'up_property' => 'gender' ) ) );
$comment = __METHOD__;
if ( strval( $caller ) !== '' ) {
$comment .= "/$caller";
}
$res = $dbr->select( $table, $fields, $conds, $comment, $joins, $joins );
$default = $this->getDefault();
foreach ( $res as $row ) {
$this->cache[$row->user_name] = $row->up_value ? $row->up_value : $default;
}
}
}