includes/cache/UserCache.php

   1 <?php
   2 /**
   3  * Caches current user names and other info based on user IDs.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup Cache
  22  */
  23
  24 /**
  25  * @since 1.20
  26  */
  27 class UserCache {
  28         protected $cache = []; // (uid => property => value)
  29         protected $typesCached = []; // (uid => cache type => 1)
  30
  31         /**
  32          * @return UserCache
  33          */
  34         public static function singleton() {
  35                 static $instance = null;
  36                 if ( $instance === null ) {
  37                         $instance = new self();
  38                 }
  39
  40                 return $instance;
  41         }
  42
  43         protected function __construct() {
  44         }
  45
  46         /**
  47          * Get a property of a user based on their user ID
  48          *
  49          * @param int $userId User ID
  50          * @param string $prop User property
  51          * @return mixed|bool The property or false if the user does not exist
  52          */
  53         public function getProp( $userId, $prop ) {
  54                 if ( !isset( $this->cache[$userId][$prop] ) ) {
  55                         wfDebug( __METHOD__ . ": querying DB for prop '$prop' for user ID '$userId'.\n" );
  56                         $this->doQuery( [ $userId ] ); // cache miss
  57                 }
  58
  59                 return isset( $this->cache[$userId][$prop] )
  60                         ? $this->cache[$userId][$prop]
  61                         : false; // user does not exist?
  62         }
  63
  64         /**
  65          * Get the name of a user or return $ip if the user ID is 0
  66          *
  67          * @param int $userId
  68          * @param string $ip
  69          * @return string
  70          * @since 1.22
  71          */
  72         public function getUserName( $userId, $ip ) {
  73                 return $userId > 0 ? $this->getProp( $userId, 'name' ) : $ip;
  74         }
  75
  76         /**
  77          * Preloads user names for given list of users.
  78          * @param array $userIds List of user IDs
  79          * @param array $options Option flags; include 'userpage' and 'usertalk'
  80          * @param string $caller The calling method
  81          */
  82         public function doQuery( array $userIds, $options = [], $caller = '' ) {
  83                 $usersToCheck = [];
  84                 $usersToQuery = [];
  85
  86                 $userIds = array_unique( $userIds );
  87
  88                 foreach ( $userIds as $userId ) {
  89                         $userId = (int)$userId;
  90                         if ( $userId <= 0 ) {
  91                                 continue; // skip anons
  92                         }
  93                         if ( isset( $this->cache[$userId]['name'] ) ) {
  94                                 $usersToCheck[$userId] = $this->cache[$userId]['name']; // already have name
  95                         } else {
  96                                 $usersToQuery[] = $userId; // we need to get the name
  97                         }
  98                 }
  99
 100                 // Lookup basic info for users not yet loaded...
 101                 if ( count( $usersToQuery ) ) {
 102                         $dbr = wfGetDB( DB_REPLICA );
 103                         $table = [ 'user' ];
 104                         $conds = [ 'user_id' => $usersToQuery ];
 105                         $fields = [ 'user_name', 'user_real_name', 'user_registration', 'user_id' ];
 106
 107                         $comment = __METHOD__;
 108                         if ( strval( $caller ) !== '' ) {
 109                                 $comment .= "/$caller";
 110                         }
 111
 112                         $res = $dbr->select( $table, $fields, $conds, $comment );
 113                         foreach ( $res as $row ) { // load each user into cache
 114                                 $userId = (int)$row->user_id;
 115                                 $this->cache[$userId]['name'] = $row->user_name;
 116                                 $this->cache[$userId]['real_name'] = $row->user_real_name;
 117                                 $this->cache[$userId]['registration'] = $row->user_registration;
 118                                 $usersToCheck[$userId] = $row->user_name;
 119                         }
 120                 }
 121
 122                 $lb = new LinkBatch();
 123                 foreach ( $usersToCheck as $userId => $name ) {
 124                         if ( $this->queryNeeded( $userId, 'userpage', $options ) ) {
 125                                 $lb->add( NS_USER, $name );
 126                                 $this->typesCached[$userId]['userpage'] = 1;
 127                         }
 128                         if ( $this->queryNeeded( $userId, 'usertalk', $options ) ) {
 129                                 $lb->add( NS_USER_TALK, $name );
 130                                 $this->typesCached[$userId]['usertalk'] = 1;
 131                         }
 132                 }
 133                 $lb->execute();
 134         }
 135
 136         /**
 137          * Check if a cache type is in $options and was not loaded for this user
 138          *
 139          * @param int $uid User ID
 140          * @param string $type Cache type
 141          * @param array $options Requested cache types
 142          * @return bool
 143          */
 144         protected function queryNeeded( $uid, $type, array $options ) {
 145                 return ( in_array( $type, $options ) && !isset( $this->typesCached[$uid][$type] ) );
 146         }
 147 }