[Summary view] [Print] [Text view]

   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 = array(); // (uid => property => value)
  29      protected $typesCached = array(); // (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( array( $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 = array(), $caller = '' ) {
  83          wfProfileIn( __METHOD__ );
  84  
  85          $usersToCheck = array();
  86          $usersToQuery = array();
  87  
  88          $userIds = array_unique( $userIds );
  89  
  90          foreach ( $userIds as $userId ) {
  91              $userId = (int)$userId;
  92              if ( $userId <= 0 ) {
  93                  continue; // skip anons
  94              }
  95              if ( isset( $this->cache[$userId]['name'] ) ) {
  96                  $usersToCheck[$userId] = $this->cache[$userId]['name']; // already have name
  97              } else {
  98                  $usersToQuery[] = $userId; // we need to get the name
  99              }
 100          }
 101  
 102          // Lookup basic info for users not yet loaded...
 103          if ( count( $usersToQuery ) ) {
 104              $dbr = wfGetDB( DB_SLAVE );
 105              $table = array( 'user' );
 106              $conds = array( 'user_id' => $usersToQuery );
 107              $fields = array( 'user_name', 'user_real_name', 'user_registration', 'user_id' );
 108  
 109              $comment = __METHOD__;
 110              if ( strval( $caller ) !== '' ) {
 111                  $comment .= "/$caller";
 112              }
 113  
 114              $res = $dbr->select( $table, $fields, $conds, $comment );
 115              foreach ( $res as $row ) { // load each user into cache
 116                  $userId = (int)$row->user_id;
 117                  $this->cache[$userId]['name'] = $row->user_name;
 118                  $this->cache[$userId]['real_name'] = $row->user_real_name;
 119                  $this->cache[$userId]['registration'] = $row->user_registration;
 120                  $usersToCheck[$userId] = $row->user_name;
 121              }
 122          }
 123  
 124          $lb = new LinkBatch();
 125          foreach ( $usersToCheck as $userId => $name ) {
 126              if ( $this->queryNeeded( $userId, 'userpage', $options ) ) {
 127                  $lb->add( NS_USER, str_replace( ' ', '_', $row->user_name ) );
 128                  $this->typesCached[$userId]['userpage'] = 1;
 129              }
 130              if ( $this->queryNeeded( $userId, 'usertalk', $options ) ) {
 131                  $lb->add( NS_USER_TALK, str_replace( ' ', '_', $row->user_name ) );
 132                  $this->typesCached[$userId]['usertalk'] = 1;
 133              }
 134          }
 135          $lb->execute();
 136  
 137          wfProfileOut( __METHOD__ );
 138      }
 139  
 140      /**
 141       * Check if a cache type is in $options and was not loaded for this user
 142       *
 143       * @param int $uid User ID
 144       * @param string $type Cache type
 145       * @param array $options Requested cache types
 146       * @return bool
 147       */
 148  	protected function queryNeeded( $uid, $type, array $options ) {
 149          return ( in_array( $type, $options ) && !isset( $this->typesCached[$uid][$type] ) );
 150      }
 151  }