UserCache.php

Go to the documentation of this file.

<?php
class UserCache {
    protected $cache = []; // (uid => property => value)
    protected $typesCached = []; // (uid => cache type => 1)
 
    public static function singleton() {
        static $instance = null;
        if ( $instance === null ) {
            $instance = new self();
        }
 
        return $instance;
    }
 
    protected function __construct() {
    }
 
    public function getProp( $userId, $prop ) {
        if ( !isset( $this->cache[$userId][$prop] ) ) {
            wfDebug( __METHOD__ . ": querying DB for prop '$prop' for user ID '$userId'.\n" );
            $this->doQuery( [ $userId ] ); // cache miss
        }
 
        return $this->cache[$userId][$prop] ?? false; // user does not exist?
    }
 
    public function getUserName( $userId, $ip ) {
        return $userId > 0 ? $this->getProp( $userId, 'name' ) : $ip;
    }
 
    public function doQuery( array $userIds, $options = [], $caller = '' ) {
        global $wgActorTableSchemaMigrationStage;
 
        $usersToCheck = [];
        $usersToQuery = [];
 
        $userIds = array_unique( $userIds );
 
        foreach ( $userIds as $userId ) {
            $userId = (int)$userId;
            if ( $userId <= 0 ) {
                continue; // skip anons
            }
            if ( isset( $this->cache[$userId]['name'] ) ) {
                $usersToCheck[$userId] = $this->cache[$userId]['name']; // already have name
            } else {
                $usersToQuery[] = $userId; // we need to get the name
            }
        }
 
        // Lookup basic info for users not yet loaded...
        if ( count( $usersToQuery ) ) {
            $dbr = wfGetDB( DB_REPLICA );
            $tables = [ 'user' ];
            $conds = [ 'user_id' => $usersToQuery ];
            $fields = [ 'user_name', 'user_real_name', 'user_registration', 'user_id' ];
            $joinConds = [];
 
            // Technically we shouldn't allow this without SCHEMA_COMPAT_READ_NEW,
            // but it does little harm and might be needed for write callers loading a User.
            if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW ) {
                $tables[] = 'actor';
                $fields[] = 'actor_id';
                $joinConds['actor'] = [
                    ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_READ_NEW ) ? 'JOIN' : 'LEFT JOIN',
                    [ 'actor_user = user_id' ]
                ];
            }
 
            $comment = __METHOD__;
            if ( strval( $caller ) !== '' ) {
                $comment .= "/$caller";
            }
 
            $res = $dbr->select( $tables, $fields, $conds, $comment, [], $joinConds );
            foreach ( $res as $row ) { // load each user into cache
                $userId = (int)$row->user_id;
                $this->cache[$userId]['name'] = $row->user_name;
                $this->cache[$userId]['real_name'] = $row->user_real_name;
                $this->cache[$userId]['registration'] = $row->user_registration;
                if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW ) {
                    $this->cache[$userId]['actor'] = $row->actor_id;
                }
                $usersToCheck[$userId] = $row->user_name;
            }
        }
 
        $lb = new LinkBatch();
        foreach ( $usersToCheck as $userId => $name ) {
            if ( $this->queryNeeded( $userId, 'userpage', $options ) ) {
                $lb->add( NS_USER, $name );
                $this->typesCached[$userId]['userpage'] = 1;
            }
            if ( $this->queryNeeded( $userId, 'usertalk', $options ) ) {
                $lb->add( NS_USER_TALK, $name );
                $this->typesCached[$userId]['usertalk'] = 1;
            }
        }
        $lb->execute();
    }
 
    protected function queryNeeded( $uid, $type, array $options ) {
        return ( in_array( $type, $options ) && !isset( $this->typesCached[$uid][$type] ) );
    }
}