includes/GenderCache.php

   1 <?php
   2
   3 /**
   4  * Caches user genders when needed to use correct namespace aliases.
   5  * @author Niklas Laxström
   6  * @since 1.18
   7  */
   8 class GenderCache {
   9         protected $cache = array();
  10         protected $default;
  11         protected $misses = 0;
  12         protected $missLimit = 1000;
  13
  14         /**
  15          * @return GenderCache
  16          */
  17         public static function singleton() {
  18                 static $that = null;
  19                 if ( $that === null ) {
  20                         $that = new self();
  21                 }
  22                 return $that;
  23         }
  24
  25         protected function __construct() {}
  26
  27         /**
  28          * Returns the default gender option in this wiki.
  29          * @return String
  30          */
  31         protected function getDefault() {
  32                 if ( $this->default === null ) {
  33                         $this->default = User::getDefaultOption( 'gender' );
  34                 }
  35                 return $this->default;
  36         }
  37
  38         /**
  39          * Returns the gender for given username.
  40          * @param $username String: username
  41          * @param $caller String: the calling method
  42          * @return String
  43          */
  44         public function getGenderOf( $username, $caller = '' ) {
  45                 global $wgUser;
  46
  47                 $username = strtr( $username, '_', ' ' );
  48                 if ( !isset( $this->cache[$username] ) ) {
  49
  50                         if ( $this->misses >= $this->missLimit && $wgUser->getName() !== $username ) {
  51                                 if( $this->misses === $this->missLimit ) {
  52                                         $this->misses++;
  53                                         wfDebug( __METHOD__ . ": too many misses, returning default onwards\n" );
  54                                 }
  55                                 return $this->getDefault();
  56
  57                         } else {
  58                                 $this->misses++;
  59                                 if ( !User::isValidUserName( $username ) ) {
  60                                         $this->cache[$username] = $this->getDefault();
  61                                 } else {
  62                                         $this->doQuery( $username, $caller );
  63                                 }
  64                         }
  65
  66                 }
  67
  68                 /* Undefined if there is a valid username which for some reason doesn't
  69                  * exist in the database.
  70                  */
  71                 return isset( $this->cache[$username] ) ? $this->cache[$username] : $this->getDefault();
  72         }
  73
  74         /**
  75          * Wrapper for doQuery that processes raw LinkBatch data.
  76          *
  77          * @param $data
  78          * @param $caller
  79          */
  80         public function doLinkBatch( $data, $caller = '' ) {
  81                 $users = array();
  82                 foreach ( $data as $ns => $pagenames ) {
  83                         if ( !MWNamespace::hasGenderDistinction( $ns ) ) continue;
  84                         foreach ( array_keys( $pagenames ) as $username ) {
  85                                 if ( isset( $this->cache[$username] ) ) continue;
  86                                 $users[$username] = true;
  87                         }
  88                 }
  89
  90                 $this->doQuery( array_keys( $users ), $caller );
  91         }
  92
  93         /**
  94          * Preloads genders for given list of users.
  95          * @param $users List|String: usernames
  96          * @param $caller String: the calling method
  97          */
  98         public function doQuery( $users, $caller = '' ) {
  99                 $default = $this->getDefault();
 100
 101                 foreach ( (array) $users as $index => $value ) {
 102                         $name = strtr( $value, '_', ' ' );
 103                         if ( isset( $this->cache[$name] ) ) {
 104                                 // Skip users whose gender setting we already know
 105                                 unset( $users[$index] );
 106                         } else {
 107                                 $users[$index] = $name;
 108                                 // For existing users, this value will be overwritten by the correct value
 109                                 $this->cache[$name] = $default;
 110                         }
 111                 }
 112
 113                 if ( count( $users ) === 0 ) {
 114                         return false;
 115                 }
 116
 117                 $dbr = wfGetDB( DB_SLAVE );
 118                 $table = array( 'user', 'user_properties' );
 119                 $fields = array( 'user_name', 'up_value' );
 120                 $conds = array( 'user_name' => $users );
 121                 $joins = array( 'user_properties' =>
 122                         array( 'LEFT JOIN', array( 'user_id = up_user', 'up_property' => 'gender' ) ) );
 123
 124                 $comment = __METHOD__;
 125                 if ( strval( $caller ) !== '' ) {
 126                         $comment .= "/$caller";
 127                 }
 128                 $res = $dbr->select( $table, $fields, $conds, $comment, $joins, $joins );
 129
 130                 foreach ( $res as $row ) {
 131                         $this->cache[$row->user_name] = $row->up_value ? $row->up_value : $default;
 132                 }
 133         }
 134
 135 }