diff options
Diffstat (limited to 'includes/cache/GenderCache.php')
-rw-r--r-- | includes/cache/GenderCache.php | 135 |
1 files changed, 135 insertions, 0 deletions
diff --git a/includes/cache/GenderCache.php b/includes/cache/GenderCache.php new file mode 100644 index 00000000..342f8dba --- /dev/null +++ b/includes/cache/GenderCache.php @@ -0,0 +1,135 @@ +<?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; + + /** + * @return GenderCache + */ + 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 $username 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. + * + * @param $data + * @param $caller + */ + 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 = '' ) { + $default = $this->getDefault(); + + foreach ( (array) $users as $index => $value ) { + $name = strtr( $value, '_', ' ' ); + if ( isset( $this->cache[$name] ) ) { + // Skip users whose gender setting we already know + unset( $users[$index] ); + } else { + $users[$index] = $name; + // For existing users, this value will be overwritten by the correct value + $this->cache[$name] = $default; + } + } + + if ( count( $users ) === 0 ) { + return; + } + + $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 ); + + foreach ( $res as $row ) { + $this->cache[$row->user_name] = $row->up_value ? $row->up_value : $default; + } + } + +} |